Аутентификация JSON API

Передавайте выданный ключ строкой api_key в теле каждого запроса. Для этой версии нужен ключ типа json:2020-01-01 (JSON 2020-01-01). API не использует токен входа кабинета в заголовке Authorization.

Ключ создается для выбранного проекта в кабинете пользователя. Полное значение возвращается только при создании; в списках доступен префикс, восстановить исходное значение нельзя. Сохраните его при создании. При утрате создайте новый ключ и удалите старый.

Область доступа

Ключ определяет пользователя и проект. SMS, рассылки, их состояния и оплата относятся к этому проекту; ключ другого проекта не получает доступ даже к сообщениям той же учетной записи. Подписи отправителя, черный список и телефонные справочники общие для всех проектов пользователя. Проект не выбирается полем data или заголовком X-Project-ID.

Удаленный проект перестает быть активным, его ключ больше не проходит проверку. При блокировке пользователя запрос отклоняется с REQUEST-USER-BLOCKED. Несуществующий пользователь, ключ или активный проект дают REQUEST-API-KEY-NOT-FOUND.

Ограничение адресов

У ключа можно задать список разрешенных IP-адресов и подсетей. Пустой список не вводит ограничение адресов. При несовпадении возвращается REQUEST-API-KEY-REJECTED. Неверные или неразобранные правила доступа не разрешают запрос; указывайте только корректные адреса и CIDR-подсети.

{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-status",
  "data": {
    "id": "000000000000000000000001"
  }
}

Ключ в примере вымышленный. Общие ошибки доступа и формата, все действия.