عملية التقديم
لاستخدام واجهة برمجة التطبيقات، يجب أولاً زيارة صفحة واجهة برمجة تطبيقات إنتاج صور الهوية وتقديم طلب للحصول على الخدمة المناسبة. بعد الدخول إلى الصفحة، انقر على زر “Acquire”، كما هو موضح في الصورة:
إذا لم تكن قد قمت بتسجيل الدخول أو التسجيل بعد، فسيتم تحويلك تلقائيًا إلى صفحة تسجيل الدخول لدعوتك للتسجيل وتسجيل الدخول، وبعد تسجيل الدخول، سيتم العودة تلقائيًا إلى الصفحة الحالية.
عند التقديم لأول مرة، سيكون هناك حد مجاني متاح، يمكنك استخدام واجهة برمجة التطبيقات مجانًا.
الاستخدام الأساسي
أولاً، يجب أن نفهم طريقة الاستخدام الأساسية، وهي إدخال صورة الشخصية التي تحتاج إلى معالجة وقالب صورة الهوية المفضل، للحصول على النتيجة المعالجة. أولاً، تحتاج إلى تمرير حقلimage_urls، وهو مصفوفة روابط الصور الشخصية التي تحتاج إلى معالجتها، كما هو موضح في الصورة:

mode، والتي تنقسم عادة إلى نوعين: بطيء relax وسريع fast، المحتوى المحدد كما يلي:

accept: نوع الاستجابة التي ترغب في تلقيها، هنا يتم ملؤها بـapplication/json، أي بتنسيق JSON.authorization: مفتاح واجهة برمجة التطبيقات، يمكن اختياره مباشرة بعد التقديم.
mode: قناة إنتاج صورة الهوية، والتي تتضمن بشكل رئيسي نوعين: سريعfastوبطيءrelax، عند استخدامrelaxيُوصى بشدة باستخدام المعاملcallback_urlأدناه.template: نمط قالب صورة الهوية.image_urls: روابط الصور الشخصية التي تحتاج إلى تحميلها.callback_url: URL الذي تحتاج إلى استدعاء النتائج إليه.

success: حالة مهمة إنتاج صورة الهوية في ذلك الوقت.task_id: معرف مهمة إنتاج صورة الهوية في ذلك الوقت.data: قائمة نتائج مهمة إنتاج صورة الهوية في ذلك الوقت.id: معرف صورة مهمة إنتاج صورة الهوية في ذلك الوقت.image_url: رابط الصورة لمهمة إنتاج صورة الهوية في ذلك الوقت.template: اسم قالب صورة الهوية لمهمة إنتاج صورة الهوية في ذلك الوقت.
data.
بالإضافة إلى ذلك، إذا كنت ترغب في توليد الكود المقابل، يمكنك نسخه مباشرة، على سبيل المثال، كود CURL كما يلي:
الاستدعاء غير المتزامن
نظرًا لأن وقت إنتاج صورة الهوية باستخدام الذكاء الاصطناعي يستغرق وقتًا طويلاً نسبيًا، حوالي 1-2 دقيقة، إذا لم يكن هناك استجابة من واجهة برمجة التطبيقات لفترة طويلة، ستظل طلبات HTTP متصلة، مما يؤدي إلى استهلاك موارد النظام الإضافية، لذا توفر هذه الواجهة أيضًا دعمًا للاستدعاء غير المتزامن. تتمثل العملية العامة في: عندما يقوم العميل بإرسال الطلب، يحدد حقلcallback_url إضافي، بعد إرسال طلب واجهة برمجة التطبيقات، ستقوم الواجهة بإرجاع نتيجة على الفور، تتضمن حقل task_id، الذي يمثل معرف المهمة الحالية. عند الانتهاء من المهمة، سيتم إرسال نتيجة إنتاج صورة الهوية إلى callback_url المحدد من قبل العميل بتنسيق POST JSON، والذي يتضمن أيضًا حقل task_id، بحيث يمكن ربط نتيجة المهمة بواسطة المعرف.
دعونا نفهم كيفية القيام بذلك من خلال مثال.
أولاً، يعد الاستدعاء عبر Webhook خدمة يمكنها استقبال طلبات HTTP، يجب على المطور استبدالها بعنوان URL الخاص بالخادم HTTP الذي قام بإنشائه. هنا، لتسهيل العرض، نستخدم موقع Webhook عام كمثال https://webhook.site/، افتح هذا الموقع للحصول على عنوان URL لـ Webhook، كما هو موضح في الصورة:
انسخ هذا العنوان URL، يمكنك استخدامه كـ Webhook، والعينة هنا هي https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a.
بعد ذلك، يمكننا تعيين حقل callback_url إلى عنوان URL الخاص بـ Webhook المذكور أعلاه، بالإضافة إلى إدخال رابط صورة الشخصية والقالب، توصي هذه الوثيقة باستخدام الاستدعاء غير المتزامن عندما يكون المعامل mode هو relax، المحتوى المحدد كما هو موضح في الصورة:

https://webhook.site/00f38b26-4289-4899-83d6-0cea7308850a، كما هو موضح في الصورة:
المحتوى كالتالي:
task_id، بينما الحقول الأخرى مشابهة لما سبق، من خلال هذا الحقل يمكنك تحقيق ارتباط المهام.
معالجة الأخطاء
عند استدعاء واجهة برمجة التطبيقات، إذا واجهت خطأ، ستقوم واجهة برمجة التطبيقات بإرجاع رمز الخطأ والمعلومات المناسبة. على سبيل المثال:400 token_mismatched: طلب غير صحيح، ربما بسبب معلمات مفقودة أو غير صالحة.400 api_not_implemented: طلب غير صحيح، ربما بسبب معلمات مفقودة أو غير صالحة.401 invalid_token: غير مصرح، رمز تفويض غير صالح أو مفقود.429 too_many_requests: عدد كبير جداً من الطلبات، لقد تجاوزت الحد الأقصى لمعدل الطلبات.500 api_error: خطأ داخلي في الخادم، حدث خطأ ما على الخادم.

