تخطَّ إلى المحتوى

Setup

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

:::ملاحظة يجب إجراء الاختبار دائمًا فيبيئة التجهيزيوجد قدر أقل بكثير من البيانات هناك، ولكنك حر في اختبار ما تريد دون فرض ذلك على بيئة الإنتاج.

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

اتبع الخطوات التالية:

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

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

ملكنا cloud_name يكون traveliko.

بالنسبة لكل نوع من أنواع مخزون السفر الذي ندعمه، سيكون هناك مجموعة 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هذا كل ما تحتاجه لاسترجاع الصورة بأي تنسيق وبأي جودة وبأي حجم تريده.

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

وثائق واجهة برمجة التطبيقات

Section titled “وثائق واجهة برمجة التطبيقات”

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

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

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

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

يمكنك القيام بنفس الشيء مع Postman.

  1. تحميل ساعي البريد.
  2. انقر على Download OpenAPI spec من أعلى واجهة برمجة التطبيقات للبحث صفحة.
  3. استيراده إلى Postman.
  4. إذا قمت باستيراده كمجموعة جديدة تسمى Wink APIانقر فوق النقاط الثلاث الأفقية الموجودة بجوار اسم المجموعة ثم انقر فوق Edit.
  5. في Authorization tab، اضبط 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هذه هي كل النطاقات التي ستحتاجها لـ Wink.
  14. تعيين المجال Client Authentication ل Send as Basic Auth header.
  15. انقر على Get New Access Token زر لاسترداد الرمز الخاص بك وحفظه.
  16. بالنسبة لجميع مكالمات واجهة برمجة التطبيقات ضمن مجموعة Wink API، تأكد من أن علامة التبويب المصادقة تقول Inherit auth from parent لذا فهو يتضمن الرمز الخاص بك مع كل مكالمة.

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