To begin using the Intrakr API, it must be enabled through your account settings. Check the box that reads Enable API Access.
You will be shown your Account ID and API Key. At any time, you may click Generate New Key to create a new API Key associated with your account. By doing this, any scripts or utilities using the old API Key will no longer function.
The request url for a request must match the following format:
Through the API, you can access the following objects. Within each object's article is a list of available actions.
Currently, the API accepts POST requests, where the body of the request is a valid JSON document.
See API Authentication.
Upon a successful request, the response will have a 200 status code with a JSON object as its response.
If an account limit has been reached, a 202 status code will be returned with a description.
If there is a namespace conflict (e.g., order number already exists), a 406 status code will be returned with a description.
If the requestor doesn't have access to the API path requested, a 401 status code will be returned.
If the data provided to the API is incorrect, a 400 error will be returned and the problem described in the error message.
A 403 response will be returned if the specified request is forbidden by the server.
If there is an unknown server error, a 500 status code will be returned.