Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

Contact doo, and we will provide you an API Key to access our API.

...

Contact doo, and we will provide you an OAuth Client Credentials to access our API.

OAuth Client Credentials include:

  • client_id

  • client_secret

OAuth Client Credentials are attached to a doo user, so you should have an account in doo and specify your user_id to get the OAuth Client Credentials from us.

OAuth Client Credentials across the organizations

You can use the same OAuth Client Credentials for many organizations.

To use it for a new organization, you should be invited to this organization with the team administrator's role by some other existing member.

...

Use OAuth Client Credentials to obtain the Access Token from the OAuth endpoint.

Request

Curl

Secrets

Please do not share your secrets with anyone else.

You have to be authorized to make any calls to our API. To authorize your API requests, will need:

  • OAuth Client Credentials

  • API Key

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 Secret

The Client Credentials can 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.

To receive your API key, please contact the doo Support Team.

Get an Access Token

Once you have the secrets, you can 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 Get an Get an

See the documentation about the API Key above.

<client_id>

Yes

see Get an

See the documentation about the OAuth Client Credentials above.

<client_secret>

Yes

see 

See the documentation about the OAuth Client Credentials

 

above.

Response example

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

...