API endpoints explained
Published on: 2024-08-10 18:48:28
The five basics when creating an API:
Design
Whether you want to try Decisimo or already know the problem you need to solve, once you create your decision flow, you need an endpoint to execute it. An API endpoint contains your decision flow and enables fast, repeatable decision execution.
Selecting instance region
When choosing a region for an API endpoint, base the decision on data privacy and data protection rules. An instance is the location where your API endpoint is set up.
You can create as many endpoints as you need across different regions.
Testing endpoint
Because you can create multiple endpoints, a practical approach is to keep separate endpoints for testing and production. Before you deploy a new decision flow to a production API endpoint, test it on a testing endpoint with your preferred testing platform, such as Postman or Soap UI.
To test an endpoint, deploy a simple, or even empty, decision flow.
Request and Response payload
Decisimo API endpoints accept JSON input requests sent with the POST method. The response from the endpoint is also JSON. That same JSON is enriched or modified inside the decision flow.
Deploy your decision flow
Build your first decision flow and deploy it to your endpoint to start running automated decisions.