ما ستفعله#
ثلاث خطوات: أنشئ حساباً، واعثر على مفتاح تطبيقك، ثم أرسل أول طلب إلى منتج اشترك فيه تطبيقك.
قبل أن تبدأ#
تحتاج إلى حساب وإلى عميل قادر على إرسال طلبات HTTPS. لا ينجح الاستدعاء إلا على منتج اشترك فيه تطبيقك، وتتطلب بعض المنتجات موافقة المزوّد قبل أن يصبح الاشتراك فعّالاً.
احصل على مفتاح#
سجّل حساباً. يُنشأ لك تطبيقان، أحدهما لبيئة Sandbox والآخر لبيئة الإنتاج، ولكلٍّ منهما مفتاحه. تجدهما ضمن تطبيقاتك.
احفظ المفتاح في متغيّر بيئة على خادمك:
# keep the key in an environment variable export API360_KEY="REPLACE_WITH_YOUR_KEY"
أرسل أول طلب#
لكل منتج منشور عنوان بوابة ونقاط نهاية خاصة به، تجدها في صفحته في السوق. يذهب الطلب إلى عنوان البوابة، ثم /v ورقم الإصدار الرئيسي لنقطة النهاية، ثم مسارها. أرسل مفتاحك في ترويسة api360key:
curl "https://gate-stg.api360.sa/<product-slug>/v<n>/<endpoint>" \ -H "api360key: $API360_KEY" \ -H "Content-Type: application/json" \ -d '{"<field>": "<value>"}'
استخدم مفتاح تطبيق Sandbox مع عنوان بوابة Sandbox (gate-stg.api360.sa)، ومفتاح تطبيق الإنتاج مع gate.api360.sa.
تحقق من النتيجة#
- إن وصلك ردٌّ من المنتج فقد قبلت البوابة مفتاحك واشتراكك.
- الرد
403مع{"message": "No active subscription for this product"}يعني أن التطبيق غير مشترك في هذا المنتج أو أن الاشتراك لم يُفعَّل بعد. ويعود الرد نفسه حين يكون المفتاح خاطئاً. - يحمل كل رد ترويسة
X-Kong-Request-Id. احتفظ بها، فالدعم يحتاج إليها للعثور على استدعائك.
الخطوات التالية#
- Sandbox والإنتاج: أي مفتاح وأي عنوان تستخدم.
- الأخطاء ورموز الحالة وإعادة المحاولة
- تصفّح المنتجات واشترك فيها بتطبيقك.