في هذه الصفحة
- ما ستفعله
- قبل أن تبدأ
- الخطوة الأولى: اعرف البيئتين
- الخطوة الثانية: خذ عنوان البوابة من صفحة المنتج
- الخطوة الثالثة: استخدم مفتاح البيئة نفسها
- تحقق من النتيجة
- أسئلة عن البيئتين
- ما بيئة الإنتاج؟
- ما بيئة Sandbox؟
- متى يلزم اعرف عميلك (KYC) أو اعرف منشأتك (KYB)؟
- هل بيئة Sandbox مجانية؟
- هل البيانات في بيئة Sandbox حقيقية؟
- الخطوات التالية
ما ستفعله#
تتعرّف على عنوان البوابة والمفتاح اللذين يعملان معاً، فيصل استدعاؤك إلى البيئة التي قصدتها ويسهل عليك فهم أي رفض. القراءة تستغرق دقائق ولا تحتاج إلى أي إعداد.
قبل أن تبدأ#
لديك حساب (أنشئ حساباً). أنشأ لك التسجيل تطبيقين هما Default App (Testing) وDefault App (Prod)، ويحمل كلٌّ منهما مفتاحاً واحداً (التطبيقات والمفاتيح).
الخطوة الأولى: اعرف البيئتين#
البيئة صفة من صفات التطبيق. تختارها مرة واحدة عند إنشاء التطبيق ولا تتغيّر بعدها، وتعرضها المنصة وسماً على التطبيق: اختبار أو إنتاجي.
| Sandbox | بيئة الإنتاج | |
|---|---|---|
| نوع التطبيق في المنصة | اختبار | إنتاجي |
| عنوان البوابة | gate-test.api360.sa | gate.api360.sa |
| المفتاح | مفتاح تطبيق من نوع «اختبار» | مفتاح تطبيق من نوع «إنتاجي» |
| البيانات | ما أعدّه المزوّد لـ Sandbox: خدمة اختبار خاصة به أو ردود محاكاة | بيانات حيّة من نظام المزوّد |
| يقدّمها | المنتجات التي فعّل مزوّدها Sandbox | كل منتج منشور |
| الموافقة واعرف عميلك (KYC) واعرف منشأتك (KYB) والترخيص | تُحدَّد لكل منتج وخطة، وهي نفسها في البيئتين | هي نفسها |
اسم بيئة Sandbox في صفحة المنتج وفي بيئة التجربة هو التجريبي، وفي التطبيق هو اختبار.
لا يظهر المنتج في بيئة إلا إذا نشره مزوّده فيها. المنتج الذي لا يوفّر Sandbox يعرض مبدّل البيئة في صفحته إنتاجي وحده، ولا يمكنك إضافته إلى تطبيق من نوع «اختبار».
الخطوة الثانية: خذ عنوان البوابة من صفحة المنتج#
لكل بيئة عنوانها لكل منتج، وتعرضه صفحة المنتج. افتح المنتج في السوق واختر البيئة، ثم اقرأ العنوان في رابط الطلب ضمن بيئة التجربة أو في تبويب أمثلة الاستدعاء. يذهب الطلب إلى العنوان الذي تعرضه الصفحة، ثم /v ورقم الإصدار الرئيسي لنقطة النهاية، ثم مسارها.

الخطوة الثالثة: استخدم مفتاح البيئة نفسها#
المفتاح تابع للتطبيق الذي يملكه، فهو تابع لبيئة ذلك التطبيق. مفتاح التطبيق من نوع «اختبار» لا تعرفه إلا بوابة Sandbox، ومفتاح تطبيق «إنتاجي» لا تعرفه إلا بوابة الإنتاج. والمفتاح المرسَل إلى البوابة الأخرى لا تتعرّف عليه، فيُعامَل الاستدعاء كأنه بلا مفتاح.
# one variable per environment, so a key in the wrong place shows at once export SANDBOX_KEY="REPLACE_WITH_THE_KEY_OF_YOUR_TESTING_APP" export API360_KEY="REPLACE_WITH_THE_KEY_OF_YOUR_PRODUCTION_APP"
تشترك في المنتج مرة واحدة. وحين يكون المزوّد قد فعّل Sandbox للمنتج يمنحك هذا الاشتراك الوصول في البيئتين، فتضيف المنتج إلى تطبيق «اختبار» لـ Sandbox وإلى تطبيق «إنتاجي» لبيئة الإنتاج (اشترك بتطبيقك في منتج).
تحقق من النتيجة#
- استدعاء بمفتاح تطبيق «اختبار» إلى بوابة Sandbox يصل إلى بيئة Sandbox الخاصة بالمنتج.
- يأتي الجواب
403مع{"message": "No active subscription for this product"}عند إرسال مفتاح «اختبار» إلى بوابة الإنتاج، أو مفتاح «إنتاجي» إلى بوابة Sandbox. وتعطي البوابة الجواب نفسه لمفتاح مجهول ولاسم ترويسة خاطئ ولتطبيق غير مشترك. فإذا قابلته فتحقق بهذا الترتيب: المضيف، ثم اسم الترويسةapi360key، ثم المفتاح مقابل تطبيق تلك البيئة، ثم الاشتراك (الأخطاء وإعادة المحاولة).
# the key of the environment of API360_BASE_URL: the response is the product's own curl -sS -o /dev/null -w "%{http_code}\n" "$API360_BASE_URL$API360_PATH" -H "api360key: $API360_KEY"
# an unknown key is answered like a call with no key curl -sS -o /dev/null -w "%{http_code}\n" "$API360_BASE_URL$API360_PATH" -H "api360key: not-a-real-key"
أسئلة عن البيئتين#
ما بيئة الإنتاج؟#
البيئة الحيّة التي تُعالَج فيها البيانات الحقيقية والمدفوعات الفعلية. تذهب الاستدعاءات إلى gate.api360.sa بمفتاح تطبيق من نوع إنتاجي. وتحتاج بعض الخطط إلى موافقة المزوّد قبل أن يصبح اشتراكك نشطاً.
ما بيئة Sandbox؟#
بيئة Sandbox للمنتج، وهي للمنتجات التي فعّلها مزوّدها. تذهب الاستدعاءات إلى gate-test.api360.sa بمفتاح تطبيق من نوع اختبار، وتصل إلى ما أعدّه المزوّد لـ Sandbox: خدمة اختبار خاصة به أو ردود محاكاة.
متى يلزم اعرف عميلك (KYC) أو اعرف منشأتك (KYB)؟#
حين يطلبهما المنتج. يستطيع المزوّد أن يجعل منتجاً يتطلب KYC أو KYB، فيُرفض الاشتراك فيه أو تجديده حتى يكتمل ملفك الشخصي. وعضو المنشأة التي حسابها نشط لا يُسأل مجدداً. والمنتجات التي لا تطلبهما لا تحتاج إلى أيٍّ منهما (حسابك).
هل بيئة Sandbox مجانية؟#
لا تفرض المنصة سعراً مستقلاً لـ Sandbox: تنطبق خطة المنتج نفسها، ويغطي اشتراك واحد البيئتين. ويبقى للمزوّد أن يسعّر منتجه، فاقرأ تبويب التسعير في المنتج قبل أن تشترك.
هل البيانات في بيئة Sandbox حقيقية؟#
يتوقف الأمر على المزوّد. يعيد Sandbox ما أعدّه المزوّد، إما خدمة اختبار خاصة به أو ردود محاكاة، ولا شيء في المنصة يضمن أن البيانات وهمية أو ثابتة. اقرأ وصف المنتج قبل أن ترسل بيانات حقيقية.
مفتاح Sandbox لا يتطلب KYB ولا دفعاً، بحدود ثابتة وببيانات اختبار منشورة.