मुख्य सामग्री पर जाएं
क्विकस्टार्ट

खाली होस्ट से अपने पहले बनाए और पढ़े गए प्रोसेस तक, कुछ ही मिनटों में।

Markdown

यह पेज आपके एनवायरनमेंट पर त्वरित शुरुआत के लिए Human Plugin को एक अस्थायी PostgreSQL कंटेनर के साथ चलाता है। इसे डिप्लॉय करने के लिए देखें Docker Compose या Kubernetes।

पूर्वापेक्षाएँ​

1. इमेज प्राप्त करें​

अपने username और token से Unico की registry में लॉग इन करें, प्रति होस्ट एक बार:

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

2. PostgreSQL और 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

शेल में अपनी access key सेट करें, फिर 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 केवल इस लोकल डेटाबेस के लिए है। किसी भी अन्य डेटाबेस के लिए डिफ़ॉल्ट, require, रखें। देखें कॉन्फ़िगरेशन।

जाँचें कि Human Plugin तैयार है:

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

आपको {"status":"ok"} दिखना चाहिए। यदि कमांड विफल हो, तो docker logs human-plugin कारण बताता है।

3. एक प्रोसेस बनाएँ​

किसी एक flow को चुनें। clientId, correlationId और credential हर flow में एक जैसे हैं।

व्यक्ति कैप्चर journey में सेल्फ़ी लेता है। उत्तर में उसका link होता है।

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

link को फ़ोन पर खोलें और सेल्फ़ी लें। token और link केवल यहीं लौटाए जाते हैं: Human Plugin इन्हें स्टोर नहीं करता।

  • id प्रोसेस के लिए Human Plugin का अपना id है। इसे सँभालकर रखें: बाद में प्रोसेस पढ़ने का यही एकमात्र तरीका है।
  • correlationId आपका संदर्भ है और अद्वितीय होना चाहिए। इसे दोबारा उपयोग करने पर 409 CORRELATION_ID_ALREADY_USED लौटता है।
  • credential व्यक्ति का दस्तावेज़ है। जब कोई न हो तो null भेजें। उपयोग किए जा सकने वाले प्रकार एट्रिब्यूट कैटलॉग में हैं।
  • data.humanToken बताता है कि व्यक्ति कौन है, और data.ndocs व्यक्ति का इंटेलिजेंस है: उसने आपके साथ क्या किया है। देखें इंटेलिजेंस।
  • Journey के साथ, पूरा हुए प्रोसेस में data.liveness भी होता है: live जब कैप्चर किसी जीवित व्यक्ति से आया हो, not_live जब नहीं। देखें data में नतीजा।

4. इसे वापस पढ़ें​

id को अपने उत्तर वाले id से बदलें:

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

Journey तब तक PROCESS_STATE_CREATED रहती है जब तक व्यक्ति कैप्चर पूरा नहीं करता। उसके बाद फिर पढ़ें: उत्तर PROCESS_STATE_FINISHED हो जाता है, जिसमें data.humanToken, data.liveness और data.ndocs होते हैं। नतीजे पर भरोसा करने से पहले जाँचें कि data.liveness.value live है।

5. सफ़ाई​

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

आगे​

अंतिम अपडेट को