Introduction

Endpoint

Action name	get token
HTTP path	/api/token
HTTP method	POST

Attributes of the HTTP request

hash	string	required	A security-sensitive value provided by Thinksurance Support Team.
secret	string	required	A security-sensitive value provided by Thinksurance Support Team.

Attributes of the HTTP response

Success response
token	string	required	A security token required for future API usage.
expired	string	required	Date and time when the security token expires. MySQL format for datetime: {{ YYYY-MM-DD hh:mm:ss }}
Failed response
error	string	required	It contains a reason for the failed request.

Examples

HTTP Request

# HTTP POST
# /api/token
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "hash": "some long string value",
  "secret": "some string value"
}

Successful HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "token": "some long string value",
  "expired": "2024-01-26 14:54:46"
}

Failed HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

Notification

Introduction

Endpoint

Attributes of the HTTP request

Attributes of the HTTP response

Examples

Sequence diagram