Docplanner API requires authorization via the OAuth2 protocol. For more information about OAuth2, see https://oauth.net/2/.

Obtaining Sandbox and Production Credentials

To receive client credentials for both the sandbox (testing) and production environments, follow the steps outlined in the Integration Process section.

Obtaining an Access Token

To request a bearer token, call the following endpoint (refer to the documentation here for a list of valid local domains):

https://www.{domain}/oauth/v2/token

When requesting a token, set the following parameters:

• grant_type: use client_credentials
• scope: use integration

Here is an example authorization request:

curl -u {client_id}:{client_secret} https://www.{domain}/oauth/v2/token -d 'grant_type=client_credentials&scope=integration'

Sample response:

{
    "access_token": "03807cb390319329bdf6c777d4dfae9c0d3b3c35",
    "expires_in": 3600,
    "token_type": "bearer",
    "scope": null
}

The bearer token remains valid for 24 hours and should be refreshed accordingly.

All API requests must include the authorization token in the headers. Requests without a valid token will be rejected. Moreover, all interactions must occur over HTTPS for security. Requests over plain HTTP will be redirected to HTTPS with a 3XX status code.

Example of including the token in the request header:

Authorization: Bearer {access_token}