API-Übersicht
Drei Prozess-Endpunkte und zwei Health-Probes.
Human Plugin wird über reines HTTP auf dem von Ihnen konfigurierten Port bereitgestellt (Standard 8080). Die Basis-URL ist die Adresse, unter der Sie den Container in Ihrem Netzwerk bereitstellen, zum Beispiel http://human-plugin.internal:8080.
| Methode | Pfad | Zweck |
|---|---|---|
POST | /v1/processes | Einen Prozess erstellen, mit einem der Flows |
GET | /v1/processes/{id} | Einen Prozess abrufen |
GET | /v1/processes/{id}/selfie | Das Selfie abrufen |
GET | /health/live | Lebendigkeitsprüfung des Dienstes. Siehe Health und Monitoring |
GET | /health/ready | Bereitschaft (Datenbank-Ping) |
Es gibt keinen Endpunkt zum Auflisten, Löschen oder Durchsuchen von Prozessen und keinen Webhook-Empfänger.
Regeln, die für jeden Aufruf gelten
- Kein Authentifizierungs-Header. Human Plugin validiert Aufrufer nicht. Beschränken Sie stattdessen den Netzwerkzugriff: siehe Netzwerk und Sicherheit.
- Nur JSON, mit Feldnamen in camelCase.
- Antworten sind
Cache-Control: no-store. - Fehler verwenden einen einheitlichen Umschlag,
{"message": "INVALID_REQUEST", "details": []}. Siehe Fehler und Wiederholungen. idist die Prozess-id von Human Plugin. Bewahren Sie sie vom Erstellen auf: Damit lesen Sie den Prozess später.
Typischer Ablauf
Weiter: Einen Prozess erstellen.