Skip to end of metadata
Go to start of metadata

Для использования методов API, необходимо передавать ключ в заголовках каждого запроса.

API Key предоставляется администраторами портала.
Для получения ключа:

 

Выданный ключ можно посмотреть в разделе "Настройки интеграции"

/Settings/Integration

 

Для передачи ключа на сервер в каждом вызове метода, необходимо сформировать HTTP заголовок с именем X-ApiKey и значением полученного ключа.

Например:

X-ApiKey: "<значение ключа>"

В случае проблем с ключом доступа, любой метод вернет код 403 Forbidden с описанием проблемы в теле ответа.

Например:

 

При использовании интерактивной «песочницы» ключ нужно указать в соответствующем поле и нажать кнопку "Применить", после чего, все вызываемые методы будут содержать нужный заголовок.