| Documentation Last Update |
|
| End Point - Live |
https://developer.globalrms.com/api/accessToken
|
| End Point - Sandbox |
https://sandbox-api.globalrms.com/api/accessToken
|
| HTTP Method |
POST
|
| Description |
Get API access token using your API key and secret
|
| Request Object Type |
JSON
|
| Request Object |
{
"ApiKey": "Your API Key",
"ApiSecret": "Your API Secret"
}
|
| Response Type |
JSON
|
|
Invalid Response
|
{
"Success": false,
"ResponseCode": 204,
"ResponseMessages": [
"Invalid API key and secret"
],
"TransactionIDType": "ACCESS-TOKEN",
"TransactionID": null
}
|
| Valid Reponse |
{
"Success": true,
"ResponseCode": 100,
"ResponseMessages": [
"Success"
],
"TransactionIDType": "ACCESS-TOKEN",
"TransactionID": "63c8d254-3cef-4fbf-b019-06aa1203bcc7"
}
|
| Request Object Definition |
| Field |
Required |
Data Type |
Definition |
| ApiKey |
Yes
|
string |
GRMS' assigned API key to a partner account. API key is given out by GRMS customer support team.
|
| ApiSecret |
Yes |
string |
GRMS' assigned API secret to a partner account. API secret is given out by GRMS customer support team. |
|
| Response Object Definition |
| Field |
Required |
Data Type |
Definition |
| Success |
NA |
boolean |
Return "true" if access token request is sucessfully granted.
Return "false" if GRMS is unable to grant an access token.
|
| ResponseCode |
NA |
string |
GRMS response code for the API call
|
| ResponseMessages |
NA |
string array |
List of messages related to API call
|
| TransactionIDType |
NA |
string |
A code to identify the type of transaction ID return by GRMS. Returns "ACCESS-TOKEN".
|
| TransactionID |
NA |
string |
Access token key
|
|