Das Fehler-Envelope, die vollständige Liste der Antworten und was bei jeder zu tun ist.
Envelope
{ "message": "MISSING_CLIENT_ID", "details": [] }
message identifiziert den Fehler, und details ist meist leer. Wenn ein Flow eine Anfrage ablehnt, zum Beispiel wegen eines ungültigen Bildes, behält die Antwort dieses Envelope bei, mit dem Grund in message und details. Siehe Ablehnungen.
Referenz
| Status | message | Endpoint | Wiederholen? |
|---|---|---|---|
| 400 | INVALID_REQUEST | create | Nein. Korrigieren Sie die Anfrage |
| 400 | REQUEST_TOO_LARGE | create | Nein. Body über 2 MiB |
| 400 | MISSING_<FIELD> / INVALID_<FIELD> | create | Nein. <FIELD> ist das Feld in Upper Snake Case, zum Beispiel MISSING_CREDENTIAL_VALUE |
| 401 | Leer ("") | create, selfie | Nein. Unico hat den Access Key abgelehnt. Prüfen Sie HUMAN_API_ACCESS_KEY |
| 409 | CORRELATION_ID_ALREADY_USED | create | Nein. Ein anderer Prozess hat diese correlationId. Verwenden Sie eine neue |
| 422 | ATTRIBUTE_TYPE_NOT_SUPPORTED | create | Nein. Verwenden Sie einen Katalogcode |
| 4xx | Die message des Flows | create | Nein. Der Prozess wird als fehlgeschlagen gespeichert |
| 404 | PROCESS_NOT_FOUND | get, selfie | Nein |
| 404 | SELFIE_NOT_FOUND | selfie | Nein. Für den Prozess ist kein Selfie verfügbar |
| 4xx | Die message der Ablehnung | selfie | Nein |
| 503 | DATABASE_UNAVAILABLE | alle | Create: siehe unten. Get und selfie: ja |
| 502 | UPSTREAM_UNAVAILABLE | alle | Create: siehe unten. Get und selfie: ja |
| 500 | INTERNAL | alle | Create: siehe unten |
Ein Create wiederholen
Jedes akzeptierte Create startet einen neuen Prozess mit einer neuen id, und jede correlationId kann nur einmal verwendet werden: Eine bereits verwendete, von einem Prozess in beliebigem Zustand, wird mit 409 CORRELATION_ID_ALREADY_USED abgelehnt.
- 400, 409, 422 und andere Ablehnungen: Korrigieren Sie die Anfrage, bevor Sie sie erneut senden.
- 503
DATABASE_UNAVAILABLE: Es wurde nichts gespeichert oder verarbeitet. Wiederholen Sie mit derselbencorrelationId. - 502 und 500: Die Anfrage wurde nicht bestätigt. Wiederholen Sie nicht automatisch. Um es erneut zu versuchen, senden Sie ein neues Create mit einer neuen
correlationId.
Empfohlenes Vorgehen für Ihr Back-end:
- Erfassen Sie jeden Versuch, bevor Sie Human Plugin aufrufen, mit der
correlationIdals Schlüssel. - Entscheiden Sie bei
502oder500nach Ihrer Geschäftsregel, ob ein neuer Versuch gestartet wird. - Halten Sie zusammengehörige Versuche in Ihren Aufzeichnungen verknüpft.
Einen Lesevorgang wiederholen
GET, für einen Prozess oder sein Selfie, lässt sich gefahrlos wiederholen. Verwenden Sie Backoff und brechen Sie bei 404 ab.
Rate Limits
Human Plugin hat keinen eingebauten Rate Limiter. Wenden Sie bei Bedarf Limits an Ihrem Gateway an.