API Guide

Authentication API

In order to make authenticated requests to the sRTMS API service, it is necessary to get an API Token session key. An API Token session key is generated by sRTMS using the customer login/password. This key uniquely identifies request to a specific customer. The Key is only valid for a short period of time. Once expired, the customer needs to request a new one.

HTTP POST

URL

https://<hostname>:<port>/customer-rest-service/customers/login

<hostname>: Azure hostname

<port>: Azure port

Header (JSON format)

Content-Type: application/json

Accept: application/json

X-MS-VERSION: v0.1.1

Header (XML format)

Content-Type: application/xml

Accept: application/xml

X-MS-VERSION: v0.1.1

Body (JSON format)

{ "userName": "<userName>", "password":"<password>"}

<userName>: Customer's username

<password>: Customer's password

Body (XML format)

<user>

<userName>[userName]</userName>

<password>[password]</password>

</user>

[userName]: Customer's username

[password]: Customer's password

Response

This request will return the API Token session key "azureToken". Please save this token and use it in every API call as defined bellow:

Header (JSON format)

Content-Type: application/json

Accept: application/json

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Header (XML format)

Content-Type: application/xml

Accept: application/xml

X-MS-VERSION: v0.1.1

X-AD-Authorization: <azureToken>

Support

if you have questions or issues using the API, please contact us as support@fatstacks.tech