Prior to attempting to query the API you must first complete authentication with the our Platform. The authentication process utilises the account credentials which are supplied following the configuration of your account.
These credentials include the below.
POST - Request
Authentication is completed via a
POST request to the URL shown above. The
POST must contain the below data:
|Field Name||State||Data Type||Description|
|grant_type||Mandatory||String||Authorisation type required to confirm the action required.|
|scope||Mandatory||String|| Confirm scope of the action to be performed with credentials.|
|client_id||Mandatory||String||Provided to the integrator following the successful creation of a test account.|
|client_secret||Mandatory||String||Provided to the integrator following the successful creation of a test account.|
POST - Response
Following the receipt of a correctly formatted authorisation
POST the DNA platform will respond with the below.
|Field Name||Data Type||Description|
|access_token||String||Access token provided by the DNA platform. The token should be securely stored ready to be used in the interactions with the API.|
|expires_in||Integer||Number of seconds from generation until the access_token expires. If the token is not used before this time has passed a new token will need to be requested.|
|refresh_token||String||Reserved for future use.|
|scope||String||List of scopes to which users have agreed to grant access within this access_token|
|token_type||String||Type of token issued|
Example Request and Response