| 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,
"TokenExpiration": null
}
|
| Valid Reponse |
{
"Success": true,
"ResponseCode": 100,
"ResponseMessages": [
"Success"
],
"TransactionIDType": "ACCESS-TOKEN",
"TransactionID": "63c8d254-3cef-4fbf-b019-06aa1203bcc7",
"TokenExpiration": "2023-02-01T17:23:17.773"
}
|
| 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
|
| TokenExpiration |
NA |
DateTime |
Access token expiration
|
|
| Response Codes |
IMPORTANT! The error response codes are NOT HTTP response codes.
The table below lists error response codes that being generated by GRMS Veritas API. All GRMS Veritas API methods/endpoints return a "200" HTTP response code with a JSON body that contains a boolean "Success" field,
which indicates whether the API transaction is success or fail. The JSON body also contains numeric "ResponseCode" field, which indicates different response statuses
correspond to different technical errors and business rules that being handled by GRMS Veritas API.
| Response Code |
Description |
| 100 |
Standard success transaction.
|
| 200 |
Standard failure transaction.
|
| 201 |
GRMS's client account number/ID is not found/exist on GRMS Veritas platform.
|
| 202 |
GRMS's client account number/ID is not active on GRMS Veritas platform.
|
| 203 |
API access is not allowed for the provided API credentials.
|
| 204 |
Invalid API credentials.
|
| 205 |
Missing input parameter(s) required by the respective GRMS Veritas API method/endpoint.
|
| 206 |
Invalid input parameter value(s) that being submitted to the respective GRMS Veritas API method/endpoint.
|
| 207 |
Duplicate supplier screening request. GRMS Veritas API finds an active supplier screening request.
|
| 208 |
Supplier screening request record is not found by GRMS Veritas API.
|
| 209 |
Missing GRMS Veritas API access token.
|
| 210 |
Invalid or expired GRMS Veritas API access token.
|
|