Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To obtain a security token, it is requisite to send a POST HTTP request to the API at the designated path /api/tokenipn/tokens. For the successful execution of operations, two security-sensitive values, namely hash and secret, must be provided by Thinksurance Support Team. Following the provision of these values as a JSON payload in the HTTP request, the API will respond by returning a security token within a JSON payload in the HTTP response.

Action name

get token

HTTP path

/api/ipn/tokentokens

HTTP method

POST

Attributes of the HTTP request

...

As previously stated, to procure a security token, it is imperative to dispatch a POST HTTP request to the /api/ipn/tokentokens endpoint of the API. Below, instances of potential communication between the API and consumers are provided.

HTTP Request

Code Block
languagejson
# HTTP POST
# https://ipn.dev.thinksurance.de/api/tokenipn/tokens
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
{
  "hash": "some long string value",
  "secret": "some string value"
}

Successful HTTP Response

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

Failed HTTP Response

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

...

Throughout the lifespan of a security token, consumers are entitled to submit requests to various endpoints within the API. Upon receiving the first response indicating an invalid request, consumers of the API should initiate the retrieval of a new security token.

Drawio
mVer2
simple0
zoom1simple0
inComment0
custContentId3174596654
pageId3173417034
lboxcustContentId13174596654
diagramDisplayNameUntitled Diagram-1706625269110.drawio
lbox1
contentVer3
revision3
baseUrlhttps://thinksurance.atlassian.net/wiki
diagramNameUntitled Diagram-1706625269110.drawio
pCenter0
width271
links
tbstyle
height481

...