Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You have to be authorized to make any calls to our API. To authorize in doo using your API requests, you will need to receive your secrets first:

  • OAuth Client Credentials

  • API Key

Please contact us, and we will provide you your personal secrets to access our API.

OAuth Client Credentials

We use OAuth Client Credentials to authorize clients. The Client Credentials are required to get an Access Token.

Client Credentials include:

  • client_id

  • client_secretClient ID

  • Client Secret

The Client Credentials are attached to a doo user, so you should have an account in doo and specify your user_id or email to get theĀ OAuth Client Credentials from uscan be created by a doo Administrator in the doo Manager App > Organization Settings (gear icon in the top bar) > Users > Client credentials.

API Key

We use API Key to identify clients and manage API limits for each client. The API Key is required for every request to our API endpoints.

Our default API limits are the following:

  • 1000 requests per day;

  • 1 request per second.

The limits are soft and can be changed by request if requiredTo receive your API key, please contact the doo Support Team.

Get an Access Token

When Once you have the secrets, you can receive get Access Token using the API request described below. The Access Token is required to request most of our public API endpoints listed in this documentation as well as for requests to our GraphQL API .

Request

Code Block
languagebash
curl -X POST https://rest.doo.net/v1/oauth \
-H 'Content-Type: application/json' \
-H 'x-api-key: <api_key>' \
-d '{"client_id": "<client_id>", "client_secret": "<client_secret>", "grant_type": "client_credentials"}'

Parameters

Parameter

Required

Description

<api_key>

Yes

see

See the documentation about the API Key above.

<client_id>

Yes

see

See the documentation about the OAuth Client Credentials above.

<client_secret>

Yes

see

See the documentation about the OAuth Client Credentials above.

Response example

Code Block
languagejson
{
    "response_status": 200,
    "developer_message": "Success",
    "user_message": "Success",
    "data": {
        "access_token": "<access_token>",
        "refresh_token": null
    },
    "_links": {
        "self": {
            "href": "https://rest.doo.net/v1/oauth"
        }
    }
}

...