Create new API token

API tokens are tokens with long time validity.

You can create an API token and then use it instead of classic token to access endpoints without need to log in multiple times.

Sign user in.

Endpoint

CODE

POST /login

Request

JSON

POST /login

Content-Type: application/json

{
  "name": "mary.griffin@circularo.com",
  "password": "#32Password1!",
  "tenant": "default"
}

Response

Note following properties in response object:

token - In response object at position token.
- It may have value of srbjZ4VRPFnID5JDMa04gUxfZZWHHQMv2pWdSeaGZfAPUjtTvzINXg3c93sapQIR.

Step 2 - Create API token

Creates new API token.

Endpoint

CODE

POST /api/key

Request

JSON

POST /api/key?token=srbjZ4VRPFnID5JDMa04gUxfZZWHHQMv2pWdSeaGZfAPUjtTvzINXg3c93sapQIR

Response

Note following properties in response object:

apiKey - In response object at position id.
- It may have value of w9wLhrKzzCBgjpnqed7MSMcfwR5JhGGzjfkJ59xTz8IvgjhpHUFPX0WXyRJCOCrA.

Sign user out.

Endpoint

CODE

GET /logout

Request

JSON

GET /logout?token=srbjZ4VRPFnID5JDMa04gUxfZZWHHQMv2pWdSeaGZfAPUjtTvzINXg3c93sapQIR

The API token can be now used instead of a normal token.

This token has the same rights as the user who created it. Standard time validity is 10 years.