Перейти к содержанию
Версия контракта: 0.3.3 — спека

Руководства для интегратора

Страницы, которые получает тот, кто подключается к хабу. Кода у него нет — здесь всё, что нужно знать о поведении хаба, кроме самого контракта (api/openapi.yaml).

Страница О чём
Быстрый старт от ключа до доставленного сообщения
Ключи и режимы формат ключа, права, изоляция боя и песочницы
Песочница магические номера и что ими проверять
Шаблоны почему свободного текста нет и что проверяется до отправки
Одноразовые коды чем класс otp отличается от остальных
Массовые рассылки пакеты, повторы, отслеживание и стоимость
Миграция со smsc.ru и SigmaSMS что меняется, соответствие статусов и кодов ошибок, порядок переключения
Статусы и их проверка что происходит с сообщением, как об этом узнать и что делать с каждым исходом
Ошибки форма отказа, реестр кодов, что повторять
Вебхуки подписка, подпись, требования к приёмнику, повторы и отключение
Идемпотентность как повторять запросы, не создавая вторых сообщений
Лимиты и квоты границы хаба и что происходит при их достижении
Ограничения MVP чего хаб пока не умеет и что уточняется у оператора
Данные и сроки хранения что хранится, как долго и что делать по обращению субъекта
Changelog и политика версий как меняется контракт и на что можно опираться

Рабочий код к этим страницам — в examples/ (на сайте — скачать): клиент на Guzzle, приёмник вебхуков, канал уведомлений Laravel с обработкой батчей в Horizon и коллекция Postman. Пути в примерах сверяются со спекой тестом, а синтаксис PHP — линтером в CI.

Таблицы кодов и причин на этих страницах генерируются из реестров в коде (make generate), а CI сверяет результат с репозиторием: расхождение руководства с поведением хаба поймается до того, как его найдёт интегратор.

Не написана страница контактов поддержки: ей нужно решение по каналу поддержки, часам работы и эскалации.