WebCommander API Authentication

Introduction

To interact with the WebCommander API, all requests must be authenticated using OAuth 2.0. This process involves requesting an access token, which is used to authorize each API call.

Obtaining an Access Token

To authenticate, you'll need to obtain an access token by making a request to the OAuth 2.0 Token API. This access token will be included in the headers of all subsequent API requests.

Authentication Endpoint

URL: /api/v4/oauth2/token
Method: POST
Content-Type: application/json

Request Parameters

In your request, you must send the following parameters:

                JSON
              

                      {
    "grant_type": "client_credentials",
    "auth_string": "AUTH_STRING",
    "redirect_uri": "REDIRECT_URI",
    "client_id": "CLIENT_ID",
    "client_secret": "CLIENT_SECRET"
}
                    

Parameter Descriptions

Parameter	Description
`grant_type`	Set this to "client_credentials". This is the OAuth 2.0 flow used to obtain an access token for API access.
`auth_string`	A base64-encoded authentication string containing your credentials in the format `username:password`.
`redirect_uri`	The redirect URI specified during the application setup.
`client_id`	Your application's client ID, provided when you registered your application.
`client_secret`	Your application's client secret.

Example Request

                JSON
              

                      {
    "grant_type": "client_credentials",
    "auth_string": "bmV3d2M3QG15d2ViY29tbWFuZGVyLmNvbTpuZXd3YzdAbXl3ZWJjb21tYW5kZXIuY29t",
    "redirect_uri": "https://api.webcommander.com/oauth-callback",
    "client_id": "f6681a45ad483e3c0a37016561d5b8be",
    "client_secret": "14e72a77d9125429b0c514010ddb0e46"
}
                    

                JSON
              

                      {
    "access_token": "ACCESS_TOKEN",
    "refresh_token": "REFRESH_TOKEN",
    "expires_in": 3600
}
                    

                JSON
              
                      access_token: ACCESS_TOKEN

                JSON
              
                      access_token: ZTcwL2Q3N2IsODU4NjFgNDIsMjRkMiwzYzg0LGE4ZWIsNjMzYTZlMDNiZWVgLDgvMDMsYWMyMDc=

Field	Description
`access_token`	The token to include in the Authorization header of all API requests.
`refresh_token`	Token to use for obtaining a new access token without re-authenticating.
`expires_in`	Duration in seconds before the access token expires (typically 3600 seconds or 1 hour).

WebCommander API Authentication

Introduction

Obtaining an Access Token

Authentication Endpoint

Request Parameters

Parameter Descriptions

Example Request

API Response

Response Details

Using the Access Token

Example Header

Summary