Skip to main content

DaoDesk API Overview

HOST: https://system_domain/api/v2

Authorization​

Authorization is performed using Basic Authorization. You need to pass the user's email and API key as parameters.

The API key for the system administrator can be found at Management -> Global Settings -> System.

The keys of other users can be found in the user profile (keys are visible only to the main administrator).

Authorization Header Example:​

Authorization: Basic bmlraXRhLmFudG9ub3ZAaGVscGRlc2tlZGR5LmNvbTphMzI4NThiNC1hNjVlLTQ5ZWYtY=
info

The key in the "Authorization: Basic" header is a combination of email:api_key encoded using 'base64'.

Access Permissions​

Each user in the system has their own API key, which can be obtained from the user profile or when creating a user.

API responses are always filtered according to the permissions of the user whose credentials are used for authorization.

Some conditional permissions are allowed in access rights to enable full integration through a single user.

Rate Limits​

The API is limited by the number of requests per minute (RPM). The RPM limit for your system is specified in the API response header X-Rate-Limit. If the limit is exceeded, access will be automatically blocked for 20 minutes.

Be sure to use the following response headers to determine the current rate limit for the system and to track the number of requests that can be sent within the current minute:

X-Rate-Limit: 300 // current rate limit (RPM)
X-Rate-Limit-Remaining: 299 // remaining number of requests in the current minute

Knowledge Base​

The Knowledge Base API has separate rate limits. The default limit is 60 requests per minute (RPM). Requests to the Knowledge Base API do not count towards the limits of other APIs. If the limit is exceeded, access will be automatically blocked for 1 hour.

Be sure to use to use the following response headers to determine the current rate limit for the system and to track the number of requests that can be sent within the current minute:

X-Rate-Limit: 60 // current rate limit (RPM)
X-Rate-Limit-Remaining: 59 // remaining number of requests in the current minute