DocumentationRecipesAPI ReferenceChangelog
Documentation

OAuth

POST/snap/v1.0/access-token/b2b

Use this API in one of the following ways to complete different tasks:

  • Use this API to obtain an access token by calling the OAuth API successfully. The access token will be used when initiating subsequent requests.
  • Use this API to get a new access token via the refresh token when an existing access token is about to expire.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:



Request Parameters

grantType String Required

Valid values are:

  • client_credentials : When you want to get the access token, use this value. You can get an access token after calling this API successfully.



Response Parameters

responseCode String Required

Response code.

Possible values are listed in the response codes table on this page.


responseMessage String Required

Response message that explains the response code.


tokenType String

This field is returned when accessToken is returned

Valid values are:

  • Bearer

expiresIn Integer

The time after which the access token expires. After the access token expires, the access token cannot be used.

This field is returned when accessToken is returned


accessToken String

The access token that is used to access the other APIs.

Note: This field is returned when the API is called successfully.


additionalInfo Object

Show Child Parameters

explanation String

Note: This field is returned when additionalInfo is returned.