الإعداد

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

ملاحظة

يجب أن تتم الاختبارات دائمًا في بيئة الاختبار. هناك بيانات أقل بكثير ولكن يمكنك الاختبار بحرية دون التأثير على بيئة الإنتاج.

بمجرد أن تكون جاهزًا للانطلاق، سنقوم بتوثيق حسابك وتطبيقك ويمكنك الإطلاق في بيئة الإنتاج.

اتبع هذه الخطوات:

1. سجل حساب المستخدم الخاص بك على Wink.
2. أنشئ حساب تابع. ستحتاج هذا لربط تطبيقك به. راجع ما هو Studio لمزيد من السياق.
3. أنشئ تطبيقًا واربطه بحساب التابع الذي أنشأته في الخطوة 2. لاختبارات واجهات برمجة التطبيقات بين الخوادم، اختر MACHINE_2_MACHINE كنوع العميل.
4. بمجرد إنشاء Application الخاص بك، انسخ واحتفظ بمعرف العميل والمفتاح السري فورًا — المفتاح السري يظهر مرة واحدة فقط ولا يمكن استرجاعه لاحقًا.

CDN

في Wink، نستخدم Cloudinary لجميع أصول الصور والفيديو الخاصة بنا. عند وصولك إلى مخزون السفر لدينا، سيكون لديك وصول كامل إلى جميع ميزات Cloudinary المتقدمة.

اسم cloud_name الخاص بنا هو traveliko.

Cloudinary

• البدء
• مجموعات تطوير البرمجيات (SDKs)
• Cloudinary على GitHub
• دروس الفيديو

مثال

لكل نوع من أنواع مخزون السفر التي ندعمها، سيكون هناك مصفوفة JSON متداخلة تسمى multimedias. شكل JSON لمدخل وسائط متعددة يبدو هكذا:

{
  "multimediaIdentifier": "multimedia-1",
  "identifier": "partners/radisson_blu_logo",
  "type": "IMAGE",
  "width": "1024",
  "height": "768",
  "category": "1",
  "descriptions": [
    {
      "name": "Lobby",
      "description": "Picture of the lobby",
      "language": "en"
    }
  ],
  "lifestyleType": "LIFESTYLE_BUSINESS",
  "attribution": [
    {
      "url": "https://www.hilton.com",
      "name": "Hilton"
    }
  ]
}

السطر المميز أعلاه يعرض معرف Cloudinary الفريد partners/radisson_blu_logo. هذا كل ما تحتاجه لاسترجاع الصورة بأي صيغة أو جودة أو حجم تريده.

الاختبار

توجه إلى قسم APIs واختر واجهة برمجة التطبيقات التي تريد العمل معها.

توثيق API

موقع التوثيق لدينا مُعد بطريقة تتيح لك تشغيل أوامر API من داخل الموقع.

في هذا المثال، تريد استخدام نداء API الخاص بـ Search Lookups (OAuth2).

نصيحة احترافية

لسهولة الاستخدام، نوصي بأن يستخدم المدمجون نقاط النهاية التي نحددها كـ OAuth2. تلك النقاط تعرف أنها تستقبل نداءات API وتعرف بالفعل الحساب الذي تستخدمه فلا تحتاج إلى تحديد companyIdentifier في عناوين URL الخاصة بك.

1. استخدم Lookup API لاسترجاع الوجهات أو الفنادق.
2. في شريط التنقل الأيسر، انقر على Authentication.
3. أدخل معرف العميل والمفتاح السري وانقر على زر Get TOKEN.
4. إذا كانت بيانات اعتمادك صحيحة، سترى أن مفتاح API الخاص بك قد تم تطبيقه.
5. يمكنك الآن اختبار نقطة النهاية الخاصة بالبحث.

مثال على Search Lookups (OAuth2)

Postman

يمكنك القيام بنفس الشيء باستخدام Postman.

1. حمّل Postman.
2. انقر على Download OpenAPI spec من أعلى صفحة Lookup API.
3. استوردها إلى Postman.
4. إذا استوردتها كمجموعة جديدة باسم Wink API، انقر على النقاط الأفقية الثلاث بجانب اسم المجموعة واختر Edit.
5. في تبويب Authorization، اضبط Auth type على OAuth2.
6. اضبط الحقل Add auth data to على Request headers.
7. اضبط الحقل Header prefix على Bearer.
8. اضبط الحقل Token Name على الاسم الذي تريد حفظ التوكن به في Postman، مثل Wink Staging.
9. اضبط الحقل Grant type على Client Credentials.
10. اضبط الحقل Access token URL على https://staging-iam.wink.travel/oauth2/token.
11. اضبط الحقل Client ID على معرف العميل الذي ساعد تطبيقك في إنشائه.
12. اضبط الحقل Client Secret على المفتاح السري الذي ساعد تطبيقك في إنشائه.
13. اضبط الحقل Scope على الصلاحيات المطلوبة مفصولة بمسافات (مثلاً inventory.read inventory.write inventory.remove). راجع مرجع الصلاحيات للقائمة الكاملة.
14. اضبط الحقل Client Authentication على Send as Basic Auth header.
15. انقر على زر Get New Access Token لاسترجاع التوكن وحفظه.
16. لجميع نداءات API ضمن مجموعة Wink API، تأكد من أن تبويب المصادقة يقول Inherit auth from parent ليشمل التوكن مع كل نداء.

نصيحة احترافية

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