Lewati ke konten utama
Panduan mulai cepat

Dari host kosong hingga proses pertama yang dibuat dan diambil, dalam beberapa menit.

Markdown

Halaman ini menjalankan Human Plugin bersama container PostgreSQL sementara agar Anda dapat mulai dengan cepat di lingkungan Anda. Untuk men-deploy-nya, lihat Docker Compose atau Kubernetes.

Prasyarat​

  • Docker 24 atau lebih baru, pada linux/amd64 atau linux/arm64 (Docker Desktop di macOS dapat digunakan).
  • Kredensial registry dan access key dari Unico. Lihat Prasyarat dan akses.

1. Ambil image​

Masuk ke registry Unico dengan username dan token Anda, sekali per host:

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

2. Jalankan PostgreSQL dan Human Plugin​

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

Atur access key Anda di shell, lalu jalankan 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 hanya untuk database lokal ini. Pertahankan nilai bawaan, require, untuk database lainnya. Lihat Konfigurasi.

Pastikan Human Plugin sudah siap:

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

Anda akan melihat {"status":"ok"}. Jika perintah gagal, docker logs human-plugin menjelaskan penyebabnya.

3. Buat proses​

Pilih salah satu flow. clientId, correlationId, dan credential sama di setiap flow.

Orang tersebut mengambil selfie di capture journey. Respons berisi link menuju journey itu.

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://…"
}

Buka link di ponsel dan ambil selfie. token dan link hanya dikembalikan di sini: Human Plugin tidak menyimpannya.

  • id adalah id proses milik Human Plugin sendiri. Simpan: itu satu-satunya cara untuk membaca proses tersebut nanti.
  • correlationId adalah referensi Anda dan harus unik. Menggunakan ulang nilai yang sama mengembalikan 409 CORRELATION_ID_ALREADY_USED.
  • credential adalah dokumen orang tersebut. Kirim null jika tidak ada. Tipe yang dapat digunakan ada di katalog atribut.
  • data.humanToken adalah siapa orang tersebut, dan data.ndocs adalah intelligence tentang orang itu: apa saja yang pernah dilakukannya bersama Anda. Lihat Intelligence.
  • Dengan Journey, proses yang selesai juga memiliki data.liveness: live jika pengambilan berasal dari orang yang hidup, not_live jika tidak. Lihat Hasil di data.

4. Baca kembali​

Ganti id dengan id dari respons Anda:

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

Journey tetap PROCESS_STATE_CREATED sampai orang tersebut menyelesaikan pengambilan. Baca lagi setelah itu: jawabannya berubah menjadi PROCESS_STATE_FINISHED, dengan data.humanToken, data.liveness, dan data.ndocs. Pastikan data.liveness.value adalah live sebelum Anda memercayai hasilnya.

5. Bersihkan​

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

Selanjutnya​

Terakhir diperbarui pada