Подключение Ansible Gateway

Подготовка интеграции Ansible Gateway. Публичное подключение и выдача токенов пока не открыты. Примеры описывают совместимый интерфейс, а не действующий доступ к сервису.

Оглавление

• Перед началом
• Отправка кодов авторизации
• Проверка статуса авторизации
• Получение отчётов

Перед началом

Сначала проверьте состояние Gateway. Для входа на сайт используйте отдельную документацию авторизации Ansible.

Пополнение счёта

Публичное пополнение Gateway не подключено. Не оплачивайте доступ через сторонних продавцов.

Получение API-токена

Открытая выдача токенов не объявлена. Токен интеграции хранится на вашем сервере и не должен попадать в браузерный код или публичные журналы.

Обращение к API

После предоставления доступа используйте согласованный HTTPS-адрес. GATEWAY_BASE_URL ниже — обозначение конфигурации, а не опубликованный адрес сервиса.

POST GATEWAY_BASE_URL/METHOD_NAME
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

Отправка кодов авторизации

Получайте номер с согласия пользователя и проверяйте его формат. Пример полей запроса:

sendVerificationMessage
{ "phone_number": "+15555550100", "code": "123456", "ttl": 60 }

Проверка возможности доставки кодов

Проверка доступности не означает успешную доставку кода.

checkSendAbility
{ "phone_number": "+15555550100" }

Отзыв кодов

Метод revokeVerificationMessage описан в справочнике. В своём сервисе также ограничивайте срок действия кода и число попыток.

Проверка статуса авторизации

Связывайте ответ с конкретным запросом и проверяйте результат на сервере.

checkVerificationStatus
{ "request_id": "REQUEST_ID", "code": "123456" }

Получение отчётов

Форматы отчётов описаны в справочнике API. Доступность обратных вызовов и параметры подключения проверяются для конкретной интеграции.