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 HMkDAvUeOx0RHxctosrcWzNLsXMuUZWS0kA1158G3vV1ubMY59B5owTqfLVAyoHR.

Step 2 - Create API token

Creates new API token.

Endpoint

CODE

POST /api/key

Request

JSON

POST /api/key?token=HMkDAvUeOx0RHxctosrcWzNLsXMuUZWS0kA1158G3vV1ubMY59B5owTqfLVAyoHR

Response

Note following properties in response object:

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

Sign user out.

Endpoint

CODE

GET /logout

Request

JSON

GET /logout?token=HMkDAvUeOx0RHxctosrcWzNLsXMuUZWS0kA1158G3vV1ubMY59B5owTqfLVAyoHR

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.