Ergebnisse, Ratenlimits und Fehler
Jeder Status und jeder Fehler der Mitglieder-API, und die Limits dahinter.
Ergebnisse
Eine Mitgliedschaftsprüfung antwortet mit einem von drei Status. Die Mitglieder-API gibt den Status weiter, nie den Grund.
status | Berechtigung | Angemeldetes Mitglied |
|---|---|---|
valid | Der Antragsteller besteht und landet in der Community Ihres Frontends | Eine gültige Mitgliedschaft, auch unter der Kulanzregel |
not_valid | Nicht, aus welchem Grund auch immer | Ein Register hat sie bei der letzten Prüfung abgelehnt |
unavailable | Ein Register konnte nicht antworten; fragen Sie später erneut | Das Register hat seit der letzten gültigen Prüfung 7 Tage lang nicht geantwortet |
null | – | Keine Organisationsmitgliedschaft |
Die Kulanzregel: Solange ein Register nicht erreichbar ist, behält ein Mitglied, dessen letzte gültige Prüfung weniger als 7 Tage alt ist, sein letztes Ergebnis. Deshalb bleibt das angemeldete Mitglied valid, während ein externes Register ausgefallen ist, und wird erst nach 7 Tagen unavailable.
Fehler
Jeder Fehler hat denselben Inhalt, {"error": "<Code>"}:
| Status | error | Wann | Was tun |
|---|---|---|---|
| 400 | invalid_request | Berechtigung: ein Inhalt, der kein JSON ist oder bei dem ein Feld fehlt oder ungültig ist, oder ein fehlendes oder ungültiges X-Applicant-IP | Die Anfrage korrigieren |
| 401 | unauthenticated | Der Schlüssel oder, beim angemeldeten Mitglied, das Token wird abgewiesen; mit WWW-Authenticate: Bearer | Den Schlüssel prüfen; einen Benutzer als abgemeldet behandeln |
| 413 | too_large | Berechtigung: ein Inhalt über 4 KB | Nur die vier Felder senden |
| 429 | rate_limited | Ein Ratenlimit ist erreicht; es gibt kein Retry-After | Den Antragsteller bitten, es später zu versuchen |
| 503 | unavailable | Das Studio selbst ist ausgefallen | Später erneut versuchen; Schlüssel und Token sind in Ordnung |
Ratenlimits für die Berechtigung
Das Studio zählt fehlgeschlagene Prüfungen aus seinem Prüfprotokoll: eine Antwort not_valid, auch für einen Antragsteller außerhalb der Community Ihres Frontends.
| Gezählt pro | Limit |
|---|---|
| Mitgliedsnummer | 5 in 15 Minuten |
| Netz des Antragstellers: die IPv4-Adresse oder das /64, in dem eine IPv6-Adresse liegt | 20 in 15 Minuten |
| Frontend | 500 in einer Stunde |
- Die Schreibweisen einer Mitgliedsnummer zählen als eine Nummer: Varianten, die sich nur durch ein führendes Pluszeichen oder führende Nullen, Groß- und Kleinschreibung, Leerzeichen, unsichtbare Zeichen oder Kompatibilitätsformen (etwa Ziffern in voller Breite) unterscheiden, teilen sich ein Kontingent. Ein Trennzeichen wie
-ergibt dagegen eine andere Nummer. - Eine Antwort
unavailableund eine bereits wegen des Ratenlimits abgewiesene Anfrage sind keine fehlgeschlagenen Prüfungen. - Eine noch laufende Prüfung zählt als fehlgeschlagen, bis sie protokolliert ist, sodass gleichzeitige Anfragen nicht alle durchkommen, bevor eine davon gezählt ist.
- Eine abgewiesene Anfrage fragt kein Register.
Ratenlimit für das angemeldete Mitglied
600 Anfragen pro Frontend-Benutzer in einer Stunde, die mit seiner ersten gezählten Anfrage beginnt. Abgewiesene Anfragen werden nicht gezählt.