API Reference

This describes the way clients request API tokens to use in API calls

Returns a token for use in other API calls

The Security API is used to request a temporary ACCESS_TOKEN and API_KEY that must be supplied in the header of all API calls from the client to Clickatell.

Returns a token for use in other API calls

post

The Security API is used to request a temporary ACCESS_TOKEN and API_KEY that must be supplied in the header of all API calls from the client to Clickatell

Body

application/x-www-form-urlencoded

client_secretstring · max: 255Required

A code provided by Clickatell known only to the bank application and the authorization server

Example: 1234d567-89d0-12d2-ac45-0bce6e7f879c

grant_typestring · max: 100Required

Indicates the type of grant being presented in exchange for an access token. Always use “client_credentials”

Example: client_credentials

client_idinteger · max: 255Required

Public identifier for the bank

Example: 200

Responses

200

successful response

application/json

400

failure response

application/json

post

/token

HTTPcURLJavaScriptPython

POST /auth/realms/UAT-API/protocol/openid-connect/token HTTP/1.1
Host:  accounts.payd.co
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 106

"client_secret='1234d567-89d0-12d2-ac45-0bce6e7f879c'&grant_type='client_credentials'&client_id=200"

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJDS040M",
  "token_type": "bearer",
  "refresh_expires_in": "1800",
  "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJDS040M",
  "session_state": "644923c7-acf6-4c88-9ae4-52759261e8c4",
  "expires_in": 300,
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJDS040M",
  "not-before-policy": 0
}