Эксплуатация
Раздел описывает порядок работы с программным обеспечением: вход, выполнение основных операций, сообщения об ошибках и действия по ним.
1. Роли
| Роль | Чем пользуется |
|---|---|
| Заказчик | прикладной программный интерфейс — из своей информационной системы; личный кабинет — в браузере |
| Конечный пользователь | с платформой не взаимодействует: совершает вызов либо вводит код в интерфейсе заказчика |
2. Вход в личный кабинет
Открыть https://app.verificahub.ru, ввести адрес электронной почты и пароль.
Ответ программы — главный экран со сводкой: остаток средств и подтверждения за период. При неверном пароле выводится сообщение об ошибке; учётная запись не блокируется.
Завершение работы — пункт «Выйти» в разделе «Ещё».
3. Основные операции
3.1. Запросить подтверждение
curl -s -X POST https://api.verificahub.ru/v1/verify \
-u '<ключ>:<секрет>' -H 'Content-Type: application/json' \
-d '{"phone_number":"+79991234567","method":"reverse_flash_call"}'
Ответ программы:
{"method":"reverse_flash_call","number_to_call":"+7...","request_id":"...",
"status":"sent","cost":{"amount":0.25,"currency":"RUB"},"expires_at":"..."}
number_to_call показывается пользователю: он звонит на этот номер со своего телефона.
3.2. Узнать результат
curl -s -u '<ключ>:<секрет>' https://api.verificahub.ru/v1/verify/<request_id>
status | Значение |
|---|---|
sent | ожидается действие пользователя |
delivered | сообщение отправлено, ожидается ввод кода |
verified | номер подтверждён |
expired | пользователь не совершил действие до истечения срока |
failed | подтверждение не состоялось; причина в failure_reason |
Вместо опроса результат можно получать веб-перехватчиком — адрес задаётся в разделе «Интеграция».
3.3. Передать введённый код
Для способов с кодом:
curl -s -X POST https://api.verificahub.ru/v1/verify/check \
-u '<ключ>:<секрет>' -H 'Content-Type: application/json' \
-d '{"request_id":"<request_id>","code":"1234"}'
Ответ программы — "status":"verified" при верном коде; при неверном — ошибка invalid_code с
числом оставшихся попыток.
3.4. Журнал подтверждений
Раздел «Подтверждения» личного кабинета: дата, маскированный номер, способ, состояние, стоимость. Доступны фильтрация и выгрузка в табличный формат.
3.5. Баланс и операции
Раздел «Баланс» — остаток и пополнение. Раздел «Операции» — история списаний и пополнений с основанием каждой записи.
В разделе «Настройки» задаётся порог, при достижении которого на адрес владельца учётной записи направляется предупреждение об исчерпании средств.
3.6. Управление ключами доступа
Раздел «Ключи» → «Перевыпустить секрет». Новый секрет показывается один раз; прежний перестаёт действовать немедленно.
4. Сообщения об ошибках и действия по ним
| Код | Значение | Действие |
|---|---|---|
validation_error | неверный формат запроса | исправить запрос; подробность в detail |
region_not_supported | номер не является российским мобильным | номер не обслуживается |
invalid_code | неверный код | повторить ввод; число попыток в ответе |
method_not_available | способ не разрешён учётной записи | использовать способ из перечня в detail |
no_gateway_available | нет пригодной SIM-карты | повторить позже либо обратиться в поддержку |
insufficient_balance | недостаточно средств | пополнить баланс |
not_found | подтверждение не найдено | проверить идентификатор |
rate_limit_exceeded | превышена частота запросов | снизить частоту обращений |
Каждый ответ об ошибке содержит trace_id — при обращении в поддержку его следует указать: он
позволяет найти обработку запроса без дополнительных сведений.
5. Поддержка
support@verificahub.ru, +7 927 938-35-62. Порядок работы с обращениями и сроки реакции — Процессы жизненного цикла.