Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 29 Current »

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.

The limits can be changed by request if required. Increasing the limits may result in higher fees. For inquiries about the limits and 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

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 the documentation about the API Key above.

<client_id>

Yes

See the documentation about the OAuth Client Credentials above.

<client_secret>

Yes

See the documentation about the OAuth Client Credentials above.

Response example

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


  • No labels