Auth Token
Authentication: not required
The Token endpoint allows partner to request an authentication token, which provides unlimited (MVP) access to the rest of the API. (The token Time To Live TTL is set at 24 hours)
Partners should reach out to us for credentials.
Profile
Currently only Admin profiles are allowed to be created
Future development includes creating profile for Business, Compliance, Finance, and other type of users
Please contact us to provide you with a test user
Below is an example of the body message for this input
{
"Partner_id": "P-6bce3658644e48a091372275d45b22fb",
"Partner_secret": "af3db84735054012bbcbb3ea2dbf06a44bb5bc7a81bd4457b501545b29d8eba74507dd944c384ff89f541a6e2c1b8caf9fcd098139b0483c8cc6c91a9b37b848"
"Grant_type": "Admin",
}
Altermal Partner ID
All partner ID in Altermal starts with P-
AuthToken Generation
When the API is run successful an authToken is generated that should be attached with the Headers of all the APIs
{"authToken":"eyJhbGciOiJBMjU2S1ciLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwiemlwIjoiREVGIn0.f2SftqKn2_dKzbgXTjgK6WSmriG-iaRi2kCTHr48WSMOXQqNsoQPYSNaCLc3kFelYUdYynNwY0mt6jj4GvBRvURUIDq404zR.DQNdcreU0BM0fbvvFbQrnw.EywTLsmYrKlRJPhoYl1r5obls_b7PxlPmUcEp299HIKsbxIQmsKj5h2bNRW_ETI0-f7FS_btCkSoXm9HuYllp8FsBuiLnU_ba8luP-f-esx_iwXY3hvbLfjcdlNvYTcB2QumZnSsvvCbV3_9Tyszz3EGqynp0pG9j3RPb6Zh7hI.u41W8mqsUhSXi80IXR9FNlu7KMG8bYcaIXaNoqTb5-o"}
Error Example
Below is an error example
{"code":"ERROR_CODE_INPUT_ERROR","message":"Invalid format detected. Expected P- but received ","param":"Partner_id"}
Input Error. Check the request payload for issues.
Unauthorized
Access denied. Additional privileges are needed access the requested resource.
Not Found. The requested resource does not exist.
Rate Limited. Too many requests.
Unexpected error