Mosaqo API
Публичный API и вебхуки для автоматизации QR
Mosaqo Public API использует ключи области рабочей области. Начните с минимальной области действия, используйте Idempotency-Key для записи и соблюдайте Retry-After при ограничении скорости.
КРАТКИЙ ОБЗОР
Что это меняет на практике
01
Аутентификация и области действия
Отправьте секрет в X-Mosaqo-API-Key. Доступные области включают qr:read, qr:write, экспорт:чтение и аналитика:чтение. Ключи могут иметь срок действия, быть отозваны или использовать список разрешенных IP-адресов.
- Никогда не размещайте секрет в клиентском JavaScript.
- Используйте один ключ для каждой интеграции
- Поворот после подозрения на заражение
02
Попытки безопасной записи
Для запросов на создание и публикацию требуется ключ идемпотентности длиной от 1 до 128 символов. Используйте ключ повторно только для повторной попытки использования той же полезной нагрузки в течение 24 часов.
03
Ограничения скорости и ошибки
На HTTP 429 прочитайте Retry-After и повторите попытку с отсрочкой. Ошибка 401 обычно указывает на отсутствующий, отозванный, просроченный, ограниченный или недостаточно ограниченный ключ.
04
Вебхуки
Подписывайтесь только на нужные события, принимайте их по HTTPS и оперативно реагируйте. Mosaqo записывает статус доставки и поддерживает воспроизведение из рабочей области.
FAQ
Частые вопросы
Где находится полный контракт API?
Контракт OpenAPI 3.1 имеет версию Mosaqo API. Создайте ключ в рабочей веб-области и используйте опубликованный контракт для получения сведений о конечной точке.
СЛЕДУЮЩИЙ ШАГ