Mosaqo API
Öffentliche API und Webhooks für die QR-Automatisierung
Mosaqo Die öffentliche API verwendet arbeitsbereichsbezogene Schlüssel. Beginnen Sie mit dem Mindestumfang, verwenden Sie Idempotency-Key für Schreibvorgänge und berücksichtigen Sie Retry-After, wenn die Rate begrenzt ist.
KURZÜBERBLICK
Was das in der Praxis verändert
01
Authentifizierung und Bereiche
Senden Sie das Geheimnis in X-Mosaqo-API-Key. Zu den verfügbaren Bereichen gehören qr:read, qr:write, exports:read und Analytics:read. Schlüssel können ablaufen, widerrufen werden oder eine IP-Zulassungsliste verwenden.
- Platzieren Sie niemals ein Geheimnis im Client-JavaScript
- Verwenden Sie einen Schlüssel pro Integration
- Bei Verdacht auf Exposition rotieren
02
Sichere Schreibwiederholungen
Erstellungs- und Veröffentlichungsanfragen erfordern einen Idempotency-Key zwischen 1 und 128 Zeichen. Verwenden Sie den Schlüssel nur erneut, um die identische Nutzlast innerhalb von 24 Stunden erneut zu versuchen.
03
Ratengrenzen und Fehler
Lesen Sie bei HTTP 429 „Retry-After“ und versuchen Sie es erneut mit Backoff. Ein 401 weist normalerweise auf einen fehlenden, widerrufenen, abgelaufenen, eingeschränkten oder nicht ausreichend gültigen Schlüssel hin.
04
Webhooks
Abonnieren Sie nur benötigte Ereignisse, akzeptieren Sie diese über HTTPS und reagieren Sie schnell. Mosaqo zeichnet den Lieferstatus auf und unterstützt die Wiedergabe aus dem Arbeitsbereich.
FAQ
Häufige Fragen
Wo ist der vollständige API-Vertrag?
Der OpenAPI 3.1-Vertrag ist mit der Mosaqo-API versioniert. Erstellen Sie im Web-Arbeitsbereich einen Schlüssel und verwenden Sie den veröffentlichten Vertrag für Endpunktdetails.
NÄCHSTER SCHRITT