MostlyQR

Fehler

Die REST-API verwendet Standard-HTTP-Statuscodes und gibt einen JSON-Fehler zurück:

json
{ "error": "unauthorized", "message": "Missing or invalid API key" }

# Statuscodes

Status error Wann
400 invalid-argument Malformed body oder ein fehlendes erforderliches Feld.
401 unauthorized Fehlender, ungültiger oder gesperrter API-Schlüssel.
403 forbidden / failed-precondition Über die Berechtigung Ihres Plans hinaus (z. B. Minting von serialisierten Codes ohne Enterprise oder über ein Kontingent). Das Limit ist in der Nachricht angegeben.
404 not-found Kein Link/Kampagne/Job mit dieser ID oder nicht im Besitz Ihres Kontos.
429 rate-limited Pro-Schlüssel-Ratenlimit überschritten – zurücktreten und erneut versuchen.
5xx internal Etwas ist auf unserer Seite schief gelaufen; es ist sicher, idempotente Lesevorgänge erneut zu versuchen.

# Eigentümerschaft

Jeder Lese- und Schreibvorgang ist auf das Konto beschränkt, zu dem der API-Schlüssel aufgelöst wird. Das Anfordern eines Link oder einer Kampagne eines anderen Kontos gibt 404 zurück (nicht 403) – wir geben nicht preis, dass es vorhanden ist.

# Asynchrone Jobs

Batch- und serialisierte Mint-Jobs akzeptieren die Anfrage (200, queued), dann oberflächliche Ausfallzeiten im Job-Status (status: "failed" mit einem Grund), nicht in der ursprünglichen HTTP-Antwort. Immer den Job abfragen.

# Überprüfung

Die öffentlichen Überprüfungs-Endpoints geben niemals einen Fehler bei einem unbekannten seriellen Fehler aus – sie geben status: "unknown" zurück (ein gefälschter/nicht ausgestellter Code ist eine aussagekräftige Antwort, keine 404).

# Nächstes