Sign In App Documentation

Im Folgenden finden Sie eine Liste von Antwortcodes, die von Sign In App API- Endpoints ausgegeben werden können. Soweit möglich, dokumentiert jeder der Endpoints die spezifischen Parameteranforderungen und möglichen Fehler, die für diesen Endpoint spezifisch sind.

200 OK

Wird für die meisten anderen API-Aufrufe zurückgegeben, einschließlich GET, PUT, PATCH und DELETE. Die zurückgegebenen Daten stellen die angeforderte Ressource dar.

201 Created

Wird zurückgegeben, wenn eine neue API-Ressource erstellt wird. 201 wird als Bestätigung zurückgegeben, dass der Ressourcenaufruf erfolgreich war. Normalerweise enthält die Antwort die neu erstellte Entität.

401 Unauthorized

Die verwendeten API-Anmeldeinformationen existieren nicht oder konnten nicht authentifiziert werden. Prüfen Sie, ob der authentication Header korrekt und mit den richtigen Angaben gesetzt ist.

403 Forbidden

Eine Berechtigungsprüfung für den Endpunkt, der für den verwendeten API-Client angegeben wurde, ist fehlgeschlagen. Überprüfen Sie das portal auf die zugehörigen Berechtigungen für den verwendeten Client.

405 Method Not Allowed

Dies liegt normalerweise daran, dass der angegebene Endpoint das angegebene HTTP-Verb nicht akzeptiert. Überprüfen Sie die Dokumentation für diesen „ Endpoint und seine unterstützten HTTP-Methoden.

422 Unprocessable Entity

Wenn die Validierung der in einer Anfrage angegebenen Felder fehlschlägt, wird ein JSON-Objekt mit jedem fehlgeschlagenen Feld und einer Beschreibung der Gründe zurückgegeben.

Object {
String <key>: Array[String]
}

Beispiel

{
  "name": [
    "Name is a required field."
  ],
  "mobile": [
    "The specified mobile number is not valid."
  ]
}

429 Too Many Requests

Die Sign In App API implementiert eine Drosselung auf allen Endpoints. Achten Sie darauf, die Anzahl der Anfragen auf maximal 20 pro Minute zu begrenzen. Wenn dieses Limit überschritten wird, wird diese Antwort zurückgegeben, bis die Minute abgelaufen ist.

500 Internal Server Error

Wenn während der Ausführung ein Problem auftritt, das nicht als sinnvolle Fehlermeldung zurückgegeben werden kann, gibt die Sign In App API diesen Status zurück. Interne Systeme sind so konfiguriert, dass sie auf diese Fehler achten und entsprechend reagieren.

503 Service Unavailable

Gelegentlich führen wir Wartungsarbeiten durch, die eine minimale Ausfallzeit erfordern können. Dieser Status wird während dieser Zeit ausgegeben. Anfragen müssen in eine Warteschlange gestellt werden und zu einem späteren Zeitpunkt erneut versucht werden.