Retrieve a token

POST

/auth/connect/token

Request

Body Params application/x-www-form-urlencoded

grant_type

string

required

The grant type of the token request.

Example:

client_credentials

client_id

string

required

Your Banyan supplied client id.

Example:

myclientid

client_secret

string

required

Your Banyan supplied client secret.

Example:

myclientsecret

clientrefnum

string

optional

The client ref number this token should be associated with.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/auth/connect/token' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id=myclientid' \
--data-urlencode 'client_secret=myclientsecret' \
--data-urlencode 'clientrefnum='

Responses

🟢200Success

application/json

Body

access_token

string

required

The JWT you will use in your Authorization header

token_type

string

required

The type of Token.

expires_in

integer

required

When the token expires.

scope

string

required

Scopes (permissions) this token has.

Examples

SuccessSuccess

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "token_type": "Bearer",
  "expires_in": 3599,
  "scope": "shipments.view shipments.edit"
}

🟠400Bad Request

🟠401Unauthorized

Authentication

Shipments