استهلك أول واجهة برمجة تطبيقات

هذا الدليل التعليمي موجّه إلى مطوّري التطبيقات الذين يحتاجون إلى استدعاء واجهة نشرها فريق آخر. في النهاية سيكون لديك تطبيق ببيانات اعتماد، مشترك في واجهة، وستعرف أين تجد المواصفة واستخدامك.

قبل أن تبدأ، تحتاج إلى:

• حساب API-dex. يمكن لأي مستخدم مسجّل الدخول إنشاء تطبيقات.
• اسم الواجهة التي تريد استدعاءها، أو فكرة جيدة عمّا تفعله.

اشترك ونفّذ الاستدعاء

1

سجّل الدخول واختر البيئة

سجّل الدخول بحساب مؤسستك. افتح عنصر التحكم بالبيئة في الشريط العلوي واختر البيئة التي نُشرت الواجهة عليها، مثل بوابة عبور الاختبار لديك.

2

ابحث عن الواجهة

افتح APIs من التنقّل الرئيسي. استعرض الكتالوج أو ابحث فيه واختر Documentation على بطاقة الواجهة. تعرض صفحتها الإصدارات المتاحة والمواصفة التفاعلية.

3

اقرأ المواصفة

تحقق من العمليات والمعاملات والمخططات التي تحتاج إليها. إن وُجدت عدة إصدارات، فافتح قائمة الصفحة بجانب العنوان واستخدم Compare versions لترى ما تغيّر بينها.

4

أنشئ تطبيقًا

افتح My Applications من التنقّل الرئيسي، ثم اختر New application. أدخل Application name، واختر الواجهة التي وجدتها في الخطوة 2 تحت Select APIs، واترك Credentials generation على Automatic، ثم Submit. التطبيق هو تسجيل العميل الخاص بك: يحمل بيانات الاعتماد وقائمة الواجهات التي يجوز له استدعاؤها.

5

تحقق من الاشتراك

افتح التطبيق. يعرض جدول APIs الواجهة بحالتها. حيث تشترط مؤسستك اعتمادًا للاشتراكات الجديدة، تبقى الحالة معلّقة حتى يعتمدها مسؤول؛ ثم تقرأ Approved. لإضافة مزيد من الواجهات لاحقًا، اختر + فوق الجدول (Add/Remove APIs)، أو Request access على أي بطاقة واجهة.

6

انسخ بيانات الاعتماد

تعرض بطاقة Credentials المفتاح أو السرّ أو الرمز بالصيغة التي تتوقعها بوابة العبور، مخفيًا. اختر زر العين لكشف القيمة وزر النسخ الذي يظهر بجانبها. الصقها في الإعدادات الآمنة لخدمتك وتعامل معها ككلمة مرور.

7

نفّذ الاستدعاء

استدعِ نقطة النهاية من المواصفة، مع إرسال بيانات الاعتماد كما تصفها المواصفة. يذهب الاستدعاء إلى بوابة العبور مباشرة. API-dex ليست في مسار الطلب.

INFO

في أول مرة تنشئ فيها تطبيقًا، تقدّم API-dex جولة موجّهة تمرّ بهذه الخطوات في الواجهة، بما في ذلك طلب مثال.

ما التالي

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