The format of the API URL is very simple:
||No||Identifier of an entity within the collection.|
||No||Name of an action to be applied to a collection or an item (if specified).|
Get the list of all jobs of a subscriber:
Change information about user with ID 1234:
Upload a binary file:
Since the request and response formats may change from one version of the API to another, you must specify the required version of the API in the
X-Version header. If the specified version is invalid or outdated, then an error response will be returned.
The API will report its version in the
X-Version response header.
||Retrieve a list of items in a collection or an item with the specified ID within that collection.||This method is not allowed for actions.|
||Create one or more items within the specified collection.
Apply an action to the specified collection or item within that collection.
|This method is allowed only for collections and actions.|
||Update one or more items within the specified collection.||This method is not allowed for actions.|
||Delete one or more items within the specified collection.||This method is not allowed for actions.|
The request method verb can be specified in a special
X-Method header. This is a way to make correct requests for solutions that support only limited number of verbs (and do not allow making requests such as
Note that the value specified in the header overwrites the actual type of the request. For example, a
PATCH request with the
X-Method header having the
GET value will be interpreted by the API as a
Also note that it is not always possible to set the request body for the
GET request. Therefore, when it is required to simulate
DELETE requests, it is recommended to use
POST request with a custom
X-Method header. Simply put, use
GET for reading and
POST for writing.