Interaction format

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

  • GET — Requesting a specified resource.
  • POST — Creating a new resource.
  • PATCH — Changing a specified resource.

Operations are listed in Operations with API resources.

Exchanging data

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

Header

Description

Method

Authorization

Data for authorization.

GET

POST

PATCH

Accept

Format of the requested resource. Acceptable values:

  • application/vnd.api+json.

GET

POST

PATCH

Content-Type

Input data format for the resource. Acceptable values:

  • application/vnd.api+json.

POST

PATCH