Zum Hauptinhalt springen
Quickstart

Von einem leeren Host bis zum ersten erstellten und abgerufenen Prozess in wenigen Minuten.

Markdown

Diese Seite startet Human Plugin zusammen mit einem Wegwerf-PostgreSQL-Container für einen schnellen Einstieg in Ihrer Umgebung. Zur Bereitstellung siehe Docker Compose oder Kubernetes.

Voraussetzungen​

  • Docker 24 oder neuer, auf linux/amd64 oder linux/arm64 (Docker Desktop unter macOS funktioniert).
  • Die Registry-Zugangsdaten und der Access Key von Unico. Siehe Voraussetzungen und Zugang.

1. Das Image abrufen​

Melden Sie sich einmal pro Host mit Ihrem Benutzernamen und Token bei der Registry von Unico an:

echo "<token>" | docker login pkg.unico.run -u <username> --password-stdin
docker pull pkg.unico.run/human-plugin-api:latest

2. PostgreSQL und Human Plugin starten​

docker network create human-plugin
docker run -d --name human-plugin-db --network human-plugin \
  -e POSTGRES_USER=human_plugin -e POSTGRES_PASSWORD=human_plugin -e POSTGRES_DB=human_plugin \
  postgres:16

Setzen Sie Ihren Access Key in der Shell und starten Sie dann Human Plugin:

export HUMAN_API_ACCESS_KEY='<your access key>'
docker run -d --name human-plugin --network human-plugin --stop-timeout 60 -p 127.0.0.1:8080:8080 \
  -e HUMAN_API_ACCESS_KEY \
  -e POSTGRES_ADDRESS_HOST=human-plugin-db \
  -e POSTGRES_USER=human_plugin \
  -e POSTGRES_PASSWORD=human_plugin \
  -e POSTGRES_SSL_MODE=disable \
  pkg.unico.run/human-plugin-api:latest

POSTGRES_SSL_MODE=disable gilt nur für diese lokale Datenbank. Behalten Sie für jede andere den Standardwert require bei. Siehe Konfiguration.

Prüfen Sie, ob Human Plugin bereit ist:

curl --fail http://127.0.0.1:8080/health/ready

Sie sollten {"status":"ok"} sehen. Wenn der Befehl fehlschlägt, nennt docker logs human-plugin den Grund.

3. Einen Prozess erstellen​

Wählen Sie einen der Flows. clientId, correlationId und credential sind in jedem Flow gleich.

Die Person nimmt das Selfie in der Capture Journey auf. Die Antwort enthält den link dorthin.

curl -s -X POST http://127.0.0.1:8080/v1/processes \
  -H 'Content-Type: application/json' \
  -d '{
    "flow": "humantoken",
    "clientId": "client-a",
    "correlationId": "quickstart-001",
    "credential": { "type": "DUI_TYPE_NG_BVN", "value": "<document number>" },
    "callbackUri": "https://example.com/callback"
  }'
{
  "id": "b063041c-7529-4e70-a2b4-c71c00f19801",
  "state": "PROCESS_STATE_CREATED",
  "token": "<SDK token>",
  "link": "https://…"
}

Öffnen Sie den link auf einem Smartphone und nehmen Sie das Selfie auf. Der token und der link werden nur hier zurückgegeben: Human Plugin speichert sie nicht.

  • id ist die eigene ID von Human Plugin für den Prozess. Bewahren Sie sie auf: Nur damit können Sie den Prozess später lesen.
  • correlationId ist Ihre Referenz und muss eindeutig sein. Die Wiederverwendung liefert 409 CORRELATION_ID_ALREADY_USED.
  • credential ist das Dokument der Person. Senden Sie null, wenn es keines gibt. Die verwendbaren Typen finden Sie im Attributkatalog.
  • data.humanToken sagt, wer die Person ist, und data.ndocs ist die Intelligence zur Person: was sie bei Ihnen getan hat. Siehe Intelligence.
  • Bei einer Journey enthält der abgeschlossene Prozess außerdem data.liveness: live, wenn die Aufnahme von einer lebenden Person stammt, not_live, wenn nicht. Siehe Das Ergebnis in data.

4. Wieder auslesen​

Ersetzen Sie die ID durch die aus Ihrer Antwort:

curl -s http://127.0.0.1:8080/v1/processes/b063041c-7529-4e70-a2b4-c71c00f19801

Eine Journey bleibt PROCESS_STATE_CREATED, bis die Person die Aufnahme abschließt. Lesen Sie sie danach erneut: Die Antwort wechselt zu PROCESS_STATE_FINISHED, mit data.humanToken, data.liveness und data.ndocs. Prüfen Sie, dass data.liveness.value live ist, bevor Sie dem Ergebnis vertrauen.

5. Aufräumen​

docker rm -f human-plugin human-plugin-db && docker network rm human-plugin

Weiter​

Zuletzt aktualisiert am