Authentication
API requests are authenticated using a token-based HTTP Authentication scheme. The Deepomatic API uses API keys to authenticate requests. You need to provide the API key preceded by Token in the Authorization header of the request.
In addition to the API key, the site-id of your visual application will need to be provided in the URL of the request:
curl -H "Authorization: Token <your_api_key>" https://api.{site-id}.customers.deepomatic.com/v0.2/task-groups/Get your API key
You can view and get your API keys directly in the Deepomatic platform, in the My account page.
API keys are tied to the Deepomatic user account for which they were created. An API key provides the same level of access & privileges that its associated Deepomatic user account would have.
Since authentication parameters are transmitted through HTTP headers, and the transferred data may contain sensitive information, it is strongly recommended to use HTTPs with secure encryption.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in emails, chat messages, client-side code or publicly accessible sites.
Get your site-id
In order to put the visual application into production and start extracting value from it, it first needs to be deployed as a site. The site-id therefore corresponds to the identifier of the site on which you want to make API calls.
For API requests to work, the site must be deployed. Make sure that the site is up and running with the Deepomatic team before making the first API calls.
You can get the side-id corresponding to your visual application in the Deployments section in our platform. To retrieve the site-id, click on the options button for the corresponding site, and then on Credentials.
The 20 first digits (highlighted in red below) represents the site-id, and will therefore need to be passed in the URL for each request.
Last updated
Was this helpful?