Authentication¶

Both the Objecttypes API and the Objects API support token authentication (or bearer authentication), which means that everyone who has the security token can access the API. Tokens are configured in the admin.

Objecttypes API¶

In this section we will create a security token for the Objecttypes API and use it in the HTTP request.

In the admin of the Objecttypes API click on the “add” button for “Token authorizations” resource.

Fill in the form and click on "save" button

After the form is filled in and submitted the token would be created. The token itself is a sequence of 40 letters and digits. It’s value is generated automatically when the form is submitted. In this example we will use 1234 as a token value.

Now we can use the created token to request Objecttypes API. The token should be included into “Authorization” header: Authorization: Token 1234

GET /api/v1/objecttypes HTTP/1.1
Authorization: Token 1234

HTTP/1.1 200 OK

[]

If you want to know how to use the Objecttypes API you can follow API Usage

Objects API¶

The creation of an authentication token for the Objects API is similar as for the Objecttypes API.

In the admin of the Objects API click on the “add” button for “Token authorizations” resource.

The “Permissions” section is used for authorizations and can be left empty for now. It’s described in the Authorization section of this document.

After the form is filled in and submitted the token would be created. The token itself is a sequence of 40 letters and digits. It’s value is generated automatically when the form is submitted. In this example we will use 5678 as a token value.

Now we can use the created token to request the Objects API. The token should be included into “Authorization” header: Authorization: Token 5678

GET /api/v1/objects HTTP/1.1
Authorization: Token 5678

HTTP/1.1 200 OK

[]

If you want to know how to use Objects API you can follow API Usage

Now you can configure Authorization for the Objects API.