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.

...

Note

Please do not share your OAuth Client Credentials and API Key with anyone else.

You have to be authorized to make any calls to our API. To authorize in doo using API, you need two things:

  • OAuth Client Credentials

  • API Key

See below for more details and how to get them.

OAuth Client Credentials

We use OAuth Client Credentials to authorize clients.

Client Credentials include:

  • client_id

  • client_secret

OAuth Please contact us, and we will provide you a Client Credentials to access our API. 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 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.

API Key

We use API Key to identify clients and manage API limits for each client.

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 required.

Please contact us, and we will provide you an API Key to access our API.

Get an Access Token

...

...

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

Request

Curl
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"}'

...

Parameter

Required

Description

<api_key>

Yes

see Get an documentation about the API Key above

<client_id>

Yes

see Get an see documentation about the OAuth Client Credentials above

<client_secret>

Yes

see Get an see documentation about the OAuth Client Credentials  above

Response example

...

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"
        }
    }
}

...