Structure of the API URL

The API URL is displayed at the top of the API endpoint dialogs (except in the "General" dialog step).

Below are some notes on the structure of the API URL.

Components of the API URL

Method

Base path

Parameter
variable fix fix variable variable variable
GET /api

/app/

 /GUID of the application /path parameter ?/query parameter

 

GUID of the application - routing alias

When you make an API request, you can replace the GUID of the application with a speaking name, the routing alias.

For detailed information about the routing alias, see section Assign routing alias for API URL.

For detailed information about executing API requests, see section Executing requests.

 

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 case-sensitively.

Uniqueness of the API URL

API paths must be unique for each endpoint.

I.e. the content within the "Path parameter" must only occur once.

Here's what's 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 are not possible:

/api/app/1A2B3C4D5E/parameter-1?{parameter-a}

/api/app/1A2B3C4D5E/parameter-1?{parameter-b}