Login

Version: 3.0.0

Method

POST

Url

https://platform.globaltravelrule.com/api/login

The user logs in to obtain the JWT Token and uses it to make api calls. (The login session is Single-sign on: SSO, if you login from other session, current session will be forced logout)

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

accessKey

RequiredString

accessKey (Getting form API Key Info)

Min Length0

Max Length256

Pattern

^[a-zA-Z0-9_+-]+(?:\.[a-zA-Z0-9_+-]+)*

Example

[accessKey]

expireInMinutes

OptionalInteger (int32)

expiredInMinutes (expire minutes will add to your token's timestamp)

Example

10000000

signedSecretKey

RequiredString

sha512(secretKey) = signedSecretKey (Getting secretKey form API Key Info, and hash it!)

Example

2301fd8f4e3ac6dec9b0a78d56f06ef964011d2361c519d39114cb3667e7a7e6c5f0b354f70cc454413c7b6f883c7a614c896b23745889ee8cde535764500fd2

vaspCode

RequiredString

vaspCode (Getting from API Key Info)

Min Length0

Max Length32

Example

[vaspCode]

Example

{
  "accessKey": "[accessKey]",
  "expireInMinutes": 10000000,
  "vaspCode": "[vaspCode]",
  "signedSecretKey": "2301fd8f4e3ac6dec9b0a78d56f06ef964011d2361c519d39114cb3667e7a7e6c5f0b354f70cc454413c7b6f883c7a614c896b23745889ee8cde535764500fd2"
}

Responses

Status 200

OK

JSON Content

Schema

[+]data

OptionalObject

verifyMessage

OptionalString

verifyStatus

RequiredInteger (int32)

VerifyStatus

Example

100000

Example

{
  "data": {
    "jwt": "string",
    "vaspCode": "string"
  },
  "verifyStatus": 100000,
  "verifyMessage": "string"
}