The API URL is displayed at the top of the API endpoint dialogs (except in the "General" dialog step).
Below are some guidelines on how to construct the API URL.
Components of the API URL
|
Method |
Base Path |
Parameters | |||
| variable | fix | fix | variable | variable | variable |
| GET | /api |
/app/ |
/Application GUID | /Path Parameter | ?/Query Parameter |
Application GUID - Routing Alias
When you make an API request, you can replace the application's GUID with a descriptive name, the routing alias.
For detailed information on routing aliases, see the section " Assign a routing alias to an API URL."
For detailed information on how to make API requests, see the " Execute Requests" section.
At least one path parameter
An API URL must contain at least one path parameter.
Static, meaningful path parameters are useful as the (first) path parameters.
Examples
GET/api/app/1A2B3C4D5E/storedata/{store-id}
POST/api/app/1A2B3C4D5E/addstore/{store-id}/{store-manager}
Case-sensitive
The URL is interpreted as case-sensitive.
Uniqueness of the API URL
API paths must be unique for each endpoint.
This means that the entries within "Path Parameter" may appear only once.
The following is possible:
/api/app/1A2B3C4D5E/parameter-1?{parameter-a}
/api/app/1A2B3C4D5E/parameter-2?{parameter-b}
/api/app/1A2B3C4D5E/parameter-1/parameter-2?{parameter-a}
/api/app/1A2B3C4D5E/parameter-1?{parameter-b}
The following is not possible:
/api/app/1A2B3C4D5E/parameter-1?{parameter-a}
/api/app/1A2B3C4D5E/parameter-1?{parameter-b}