Interaction format

The API is accessed over HTTPS. The API supports the following HTTP methods:

  • GET: Request the specified resource.
  • POST: Create a new resource.
  • PATCH: Edit the specified resource.

The operations are listed in Operations with the API resources.

Data exchange

The API supports JSON format. The following headers are used in requests:

Title

Description

Method

Authorization

Authorization data.

GET

POST

PATCH

Accept

The format of the requested resource. Acceptable values:

  • application/vnd.api+json.

GET

POST

PATCH

Content-Type

The format of the input data for the resource. Acceptable values:

  • application/vnd.api+json.

POST

PATCH