Объекты API-ключа

Перечислить API-ключи

GET /(company_code)/v2/aol/apikey

Получить список доступных API-ключей

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты данных API-ключа
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных API-ключа

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
name string Название API-ключа
comment string Комментарий API-ключа
enabled_flag boolean Флаг, указывающий, включен ли API-ключ или недействителен

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

Подробнее см. Коды ошибок.