Коды ошибок и ограничения

Ошибка API — это всегда JSON одного вида: машинный код, человеческий текст и, где есть что добавить, details. Разбирайте code: текст сообщения может измениться, код — нет.

{
  "error": {
    "code": "REDEEM_LIMIT_EXCEEDED",
    "message": "Превышен лимит списания баллов",
    "details": { "maxAllowed": 425, "requested": 500 }
  }
}

Общие

Лояльность

Инфраструктура

Остальные коды — CAPTCHA_REQUIRED, EMAIL_NOT_VERIFIED, TENANT_ACCESS_REVOKED, PROMO_INVALID, PASS_NOT_FOUND — отдают страница выдачи карты, кабинет и страница гостя; запросам по ключу API они не приходят. CAPTCHA_REQUIRED увидит и тот, кто берёт песочницу.

Ограничения

Пределы на номер и квоту подтверждений держат не ради нас, а ради заведения: платные каналы оплачиваются из его квоты и пакета, и перебор чужих номеров через вашу интеграцию тратил бы его деньги. Предела по адресу и проверки «я не робот» у запросов по ключу нет — адрес принадлежит вашему серверу, а не гостю.

• RATE_LIMITED — сбавьте темп и повторите не раньше details.retryAfterSec; у общего предела по адресу то же число приходит и в заголовке Retry-After. Разумная стратегия — удвоение задержки.
• Песочница ограничена отдельно: три выдачи в сутки с адреса, 30 в час и 500 живых на всю платформу — см. её страницу.

Что смотреть при разборе

• Журнал действий в кабинете — что менялось и кто это сделал.
• «Выпущенные ключи» на вкладке «Интеграции» — когда ключом пользовались последний раз и чей адрес пришёл в User-Agent.
• «Доставки» у адреса на вкладке «Вебхуки» — код ответа вашего сервера или ошибка, число попыток и время следующей.
• История карты — GET /cards/:id/history: движение баллов, включая сгорание и ручные правки.
• status.snovacard.ru — состояние сервисов, если ошибки пошли разом и у всех.

Частые вопросы