استهلك أول واجهة برمجة تطبيقات
هذا الدليل التعليمي موجّه إلى مطوّري التطبيقات الذين يحتاجون إلى استدعاء واجهة نشرها فريق آخر. في النهاية سيكون لديك تطبيق ببيانات اعتماد، مشترك في واجهة، وستعرف أين تجد المواصفة واستخدامك.
قبل أن تبدأ، تحتاج إلى:
- حساب API-dex. يمكن لأي مستخدم مسجّل الدخول إنشاء تطبيقات.
- اسم الواجهة التي تريد استدعاءها، أو فكرة جيدة عمّا تفعله.
اشترك ونفّذ الاستدعاء
سجّل الدخول واختر البيئة
سجّل الدخول بحساب مؤسستك. افتح عنصر التحكم بالبيئة في الشريط العلوي واختر البيئة التي نُشرت الواجهة عليها، مثل بوابة عبور الاختبار لديك.
ابحث عن الواجهة
اختر APIs في الشريط الجانبي الأيسر. استعرض الكتالوج أو ابحث فيه وافتح الواجهة. تعرض صفحتها الوصف والإصدارات المتاحة وفريق الخلفية المالك والمواصفة التفاعلية.
اقرأ المواصفة
افتح المواصفة للتحقق من العمليات والمعاملات والمخططات التي تحتاج إليها. إن وُجدت عدة إصدارات، فاستخدم Compare versions لترى ما تغيّر بينها.
أنشئ تطبيقًا
اختر My Applications في الشريط الجانبي، ثم Create Application. أدخل اسمًا واحفظ. التطبيق هو تسجيل العميل الخاص بك: يحمل بيانات الاعتماد وقائمة الواجهات التي يجوز له استدعاؤها.
اشترك بالتطبيق في الواجهة
افتح التطبيق واختر Add/Remove APIs. اختر الواجهة التي وجدتها في الخطوة 2. حيث تشترط مؤسستك اعتمادًا للاشتراكات الجديدة، يظهر الطلب معلّقًا حتى يعتمده مسؤول.
انسخ بيانات الاعتماد
تعرض بطاقة بيانات الاعتماد في التطبيق المفتاح أو السرّ أو الرمز بالصيغة التي تتوقعها بوابة العبور، مع زر نسخ وتلميح يشرح كيفية التحقق من بيانات الاعتماد. انسخها إلى الإعدادات الآمنة لخدمتك وتعامل معها ككلمة مرور.
نفّذ الاستدعاء
استدعِ نقطة النهاية من المواصفة، مع إرسال بيانات الاعتماد كما تصفها المواصفة. يذهب الاستدعاء إلى بوابة العبور مباشرة. API-dex ليست في مسار الطلب.
INFO
في أول مرة تنشئ فيها تطبيقًا، تقدّم API-dex جولة موجّهة تمرّ بهذه الخطوات في الواجهة، بما في ذلك طلب مثال.
ما التالي
- إدارة تطبيقاتك: أعد التسمية، وشارك مع فريقك، وأضف مزيدًا من الواجهات أو احذف تطبيقًا.
- قراءة إحصائياتك: اطّلع على حركة المرور لكل تطبيق بعد تدفّق الاستدعاءات.
- إدارة فرقك: شارك التطبيق مع فريق مستهلكين ليستخدم الزملاء التسجيل نفسه.