Deepomatic Platform
  • Overview
  • Release notes
    • January 2025
    • November 21, 2024
    • October 17, 2024
    • September 19, 2024
    • July 18, 2024
    • June 27, 2024
    • May 23, 2024
    • April 18, 2024
    • March 21, 2024
    • February 22, 2024
    • January 18, 2024
    • December 13, 2023
    • October 26, 2023
    • July 20, 2023
    • June 29, 2023
    • May 29, 2023
    • April 27, 2023
    • March 30, 2023
    • February 17, 2023
    • January 19, 2023
    • December 22, 2022
    • November 18, 2022
    • October 19, 2022
    • September 19, 2022
    • July 27, 2022
    • June 26, 2022
    • May 17, 2022
    • April 13, 2022
    • March 17, 2022
    • February 10, 2022
    • December 21, 2021
    • October 26, 2021
  • Getting started
  • ADMIN & USER MANAGEMENT
    • Invite and manage users
      • Invite group of users at once
      • SSO
        • Azure Active Directory
  • Deepomatic Engage
    • Integrate applications
      • Deepomatic vocabulary
      • Deepomatic connectors
        • Set-up
        • Camera Connector
        • Work Order Connector
      • API integration
        • Authentication
        • Errors
        • API reference
          • Work order management
          • Analysis
            • Guide field workers
            • Perform an analysis
            • Correct an analysis
          • Data retrieval
          • Endpoints' list
      • Batch processing
        • Format
        • Naming conventions
        • Processing
        • Batch status & errors
      • Data export
    • Use the mobile application
      • Configure a mobile application
      • Create & visualize work orders
      • Complete work orders
      • Offline experience
    • Manage your business operations with customisable solutions
      • Roles
      • Alerting
      • Field services
        • Reviewing work orders
        • Exploring work orders
        • Grouping work orders
        • Monitoring assets performance
      • Insights
  • Security
    • Security
    • Data Protection
Powered by GitBook
On this page
  • Get your API key
  • Get your site-id

Was this helpful?

  1. Deepomatic Engage
  2. Integrate applications
  3. API integration

Authentication

Last updated 9 months ago

Was this helpful?

API requests are authenticated using a . 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 , 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

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.

In order to put the visual application into production and start extracting value from it, it first needs to be . The site-id therefore corresponds to the identifier of the site on which you want to make API calls.

deployed as a site
token-based HTTP Authentication scheme
Deepomatic platform
My account page
Credentials modal