الحصول على العملية | Unico Developer Portal

الحصول على العمليةGET

استرجع عملية Human Token بواسطة معرّفها — بعد عودة المستخدم من Human Token Journey، أو لإعادة الاستعلام عن نتيجة API Only.

Markdown

نقطة النهاية

البيئة	الرابط
الإنتاج	`GET https://humantoken.unico.app/client/v1/process/{processId}`

الطلب

Headers

Header	القيمة
`x-unico-accesskey`	`<your_access_key>` (راجع المصادقة)

معاملات المسار (Path)

المعامل	النوع	مطلوب	الوصف
`processId`	string (UUID)	نعم	معرّف العملية الذي تُعيده إنشاء عملية.

مثال

cURL
Node.js

curl -X GET https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

import fetch from 'node-fetch';

const res = await fetch(
  `https://humantoken.unico.app/client/v1/process/${processId}`,
  { headers: { 'x-unico-accesskey': process.env.UNICO_ACCESS_KEY } }
);
const result = await res.json();
// result.data.humanToken.value

الاستجابات

200 OK

للاستجابة التنسيق نفسه الخاص بـ إنشاء عملية. يعتمد شكل data على التدفق المستخدم عند إنشاء العملية.

التدفقات القياسية (api+humantoken، api+liveness+humantoken، humantoken):

{
  "id": "6ed74799-4c2f-4023-b43f-a73cf7c847b2",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanToken": {
      "value": "3f9a1c7e5b2d4086a1e3c5f7092b4d6e8a0c2e4f6183a5c7e9b1d3f5072a4c6e",
      "status": "validated"
    }
  }
}

تدفقات إعادة التحقق (api+liveness+humantoken+revalidation، humantoken+revalidation):

{
  "id": "cb0472c0-6dbc-46c6-b830-2be7edc35424",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanTokenMatch": "true"
  }
}

الحقل	النوع	الوصف
`id`	string (UUID)	معرّف العملية.
`state`	string	حالة العملية — راجع قيم `state`.
`data.humanToken.value`	string	التدفقات القياسية فقط. معرّف مستقر وغير شفاف للوجه (حتى 100 حرف). يُحلَّل الشخص ذاته دائمًا إلى القيمة نفسها.
`data.humanTokenMatch`	string	تدفقات إعادة التحقق فقط. `"true"` إذا تطابقت الصورة الشخصية مع `humanToken` المرجعي، و`"false"` في حال عدم التطابق.

قيم state

القيمة	المعنى
`PROCESS_STATE_UNSPECIFIED`	الحالة غير محددة.
`PROCESS_STATE_CREATED`	تم إنشاء العملية ولا تزال تقبل جلسات جديدة. تكون `data` بالقيمة `{}`.
`PROCESS_STATE_FINISHED`	اكتملت العملية ولم تعد تقبل جلسات جديدة. في التدفقات القياسية، يكون `data.humanToken` موجودًا عند إنشاء Human Token؛ وفي تدفقات إعادة التحقق، يُشير `data.humanTokenMatch` إلى ما إذا كانت الصورة الشخصية تتطابق مع الرمز المرجعي. وإلا تكون `data` بالقيمة `{}`.
`PROCESS_STATE_FAILED`	فشلت العملية. تكون `data` بالقيمة `{}`.
`PROCESS_STATE_CANCELED`	أُلغيت العملية. تكون `data` بالقيمة `{}`.
`PROCESS_STATE_AWAITING_FOR_DOCUMENT`	العملية بانتظار وثيقة هوية. تكون `data` بالقيمة `{}`.

تحذير

تحقق دائمًا من أن data.humanToken.value ليست فارغة قبل استخدامها.

رموز الأخطاء

400 Bad Request
401 Unauthorized
404 Not Found
429 Too Many Requests
500 Internal Server Error

الرمز	الرسالة	الوصف
`3`	process id is invalid	عندما يكون معرّف العملية غير صالح.

مفتاح الوصول مفقود أو غير صالح في الترويسة x-unico-accesskey. راجع المصادقة.

الرمز	الرسالة	الوصف
`5`	error getting process: rpc error: code = NotFound desc = process not found	عندما لا يُعثر على معرّف العملية.

الرمز	الرسالة	الوصف
`99999`	Internal failure! Try again later	عند حدوث خطأ داخلي.

الخطوات التالية

عُد إلى إنشاء عملية لإرسال صورة شخصية جديدة.
لفهم ما يمثّله humanToken ومتى لا يُولَّد، راجع نظرة عامة على Human Token.

نقطة النهاية​

الطلب​

مثال​

الاستجابات​

رموز الأخطاء​

الخطوات التالية​