ATRIP Token

Use ATRIP Token as the primary name in guides and links.

This API maps to getAtripToken.do.

Legacy materials may call it getAtripToken.

getAtripToken

post

Dependency No preceding function needs to be carried out.

Header parameters

AcceptstringRequiredExample: application/json

Content-TypestringRequiredExample: application/json

Accept-EncodingstringRequiredDefault: gzipExample: gzip

x-atlas-client-idstringRequiredDefault: <YOUR_CLIENT_ID>Example: <YOUR_CLIENT_ID>

x-atlas-client-secretstringRequiredDefault: <YOUR_CLIENT_SECRET>Example: <YOUR_CLIENT_SECRET>

Body

application/json

orderNostringRequired

Order number. It can be an order for ticketing, or an order for add bags. The format of each kind of order is different.

userNamestringRequired

This is to identifier the operator's name in client's system, Atlas will grant access to this operator and track his/her actions in Atlas customer service portal.

rolestringRequired

This is to identify the operator's role. Atlas will grant access to this operator according to the role assigned. Here are the acceptable options:

Customer service : Access to manage orders and request post ticketing services

Finance : Access to manage the balance and check statements

Developer : Access to manage the system configurations

Admin : Full access

Responses

200Success

application/json

urlstringRequired

A url with token to access to Atlas customer service portal.

statusintegerRequired

0: success

2: System error

3: unauthorized access

msgstring · nullableOptional

Error message.

The 'msg' element is for description of the results. Please DO NOT use this field to check the success or failure of the request. Only use the 'status' code to check the result.

post

/getAtripToken.do

HTTPcURLJavaScriptPython

POST /getAtripToken.do HTTP/1.1
Accept: text
Accept-Encoding: gzip
x-atlas-client-id: <YOUR_CLIENT_ID>
x-atlas-client-secret: <YOUR_CLIENT_SECRET>
Content-Type: application/json
Content-Length: 89

{
  "cid": "xxxxxx",
  "orderNo": "XXXXXXXXXXXXXXXXXXX",
  "userName": "tony.kal",
  "role": "TICKETING"
}

200Success

{
  "url": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "msg": null,
  "status": 0
}