OAuth2

OAuth2 is used as the authentication protocol for this API.

Obtain access token

Obtain access token with App client_id and client_secret. For more information, see Authentication section.

Request
Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string

The client_id is the public identifier for OAuth apps. See this section how to obtain credentials.

client_secret
required
string

The client_secret is a secret known only to the application and the authorization server. It is essential the application’s own password. See this section how to obtain credentials.

grant_type
required
string

The OAuth framework specifies several grant types for different use cases. Use "client_credentials" here.

Value Description
client_credentials

The only supported OAuth grant type.

Responses
200

Access Token (JWT).

Response Schema: application/json
access_token
expires_in
integer

The validity of the token in seconds.

token_type
string

The type of the token.

Value Description
Bearer

Bearer format

400

An OAuth2 authentication error occurred.

post/oauth2/token
Request samples
application/x-www-form-urlencoded
client_id=string&client_secret=string&grant_type=client_credentials
Response samples
application/json
{
  • "access_token": "eyJraWQiOiI4TVZhNnhcL0t4TUZUSkp1ZG1uWUZaVDZVbmhFcEZid3AwOG5xemR3eWMyYz0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIzdnNs\nNWxwbXBrcHBqbDU4aHM5MHJoajNvNiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiaHR0cHM6XC9cL3BhcnRuZXItYXBpLTQwOS5zd\nGcuamlmZWxpbmUuY2xvdWRcL3Byb3ZpZGVycy1lbXBsb3llZXM6d3JpdGUgaHR0cHM6XC9cL3BhcnRuZXItYXBpLTQwOS5zdGcuamlmZWxpbm\nUuY2xvdWRcL3RpY2tldHMtdm91Y2hlcnM6d3JpdGUgaHR0cHM6XC9cL3BhcnRuZXItYXBpLTQwOS5zdGcuamlmZWxpbmUuY2xvdWRcL3Byb3Z\npZGVycy1icmFuZGluZy1wcm9maWxlcyBodHRwczpcL1wvcGFydG5lci1hcGktNDA5LnN0Zy5qaWZlbGluZS5jbG91ZFwvdGlja2V0cy1ub3Rl\nczp3cml0ZSBodHRwczpcL1wvcGFydG5lci1hcGktNDA5LnN0Zy5qaWZlbGluZS5jbG91ZFwvcHJvZHVjdC1jYXRhbG9nLW91dHNvdXJjZS1hc\nHBsaWNhdGlvbnMgaHR0cHM6XC9cL3BhcnRuZXItYXBpLTQwOS5zdGcuamlmZWxpbmUuY2xvdWRcL3BhcnRuZXItYXBpIGh0dHBzOlwvXC9wYX\nJ0bmVyLWFwaS00MDkuc3RnLmppZmVsaW5lLmNsb3VkXC9wcm9kdWN0LWNhdGFsb2ctYXBwbGljYXRpb25zIGh0dHBzOlwvXC9wYXJ0bmVyLWF\nwaS00MDkuc3RnLmppZmVsaW5lLmNsb3VkXC9jdXN0b21lcnMtY3VzdG9tLWZpZWxkczp3cml0ZSBodHRwczpcL1wvcGFydG5lci1hcGktNDA5\nLnN0Zy5qaWZlbGluZS5jbG91ZFwvcHJvdmlkZXJzIGh0dHBzOlwvXC9wYXJ0bmVyLWFwaS00MDkuc3RnLmppZmVsaW5lLmNsb3VkXC92ZWhpY\n2xlcy1vZG9tZXRlci1yZWdpc3RyYXRpb25zOndyaXRlIGh0dHBzOlwvXC9wYXJ0bmVyLWFwaS00MDkuc3RnLmppZmVsaW5lLmNsb3VkXC9wcm\n9kdWN0LWNhdGFsb2ctcHJpY2UtbGlzdC1jb2RlcyIsImF1dGhfdGltZSI6MTczNDQzNjU1MiwiaXNzIjoiaHR0cHM6XC9cL2NvZ25pdG8taWR\nwLmV1LWNlbnRyYWwtMS5hbWF6b25hd3MuY29tXC9ldS1jZW50cmFsLTFfUDdKWTJMbU1aIiwiZXhwIjoxNzM0NDQwMTUyLCJpYXQiOjE3MzQ0\nMzY1NTIsInZlcnNpb24iOjIsImp0aSI6IjNlMGNkZjViLTIyODctNDgxZC1iNmVhLWMzY2UwZWU4NjllZSIsImNsaWVudF9pZCI6IjN2c2w1b\nHBtcGtwcGpsNThoczkwcmhqM282In0.JqlDTTJ04CPCGk8IZUsLTAhAQNTj2FI_jIjVyusYCoA_8vqisQNi8xqzFYYgTJxIwAnqR3NMJOWYEn\niRIc5Esa3IVb5L8y7Mc6xggTXk9TwQtKz81U_vB1Vbg4mcsz3P6XXp3_tsn4_eIYirdmSjJbNjAoW_bndaKydCelTt216MjORXfZ6_VRYM3O6\nNngg_USCB2kAopHsiH4AdQfsS89Nu1Q3Z1EUyujmPrq6OOIBsX8W31YxZ8GlHSCAuV0OwLtEfVkUgfrykq6_q99mv9l9UBq9wPu0GbhnHnist\negtJgHDZsYaAMvmNEth7k6fG6vJP2Ge5G4pjPurdZwWBGA\n",
  • "expires_in": 3600,
  • "token_type": "Bearer"
}