الوصول إلى واجهة برمجة التطبيقات والمصادقة

يوفر SPREEAI مرجعًا عامًا لواجهة برمجة التطبيقات (API) لسير عمل الشركاء المعتمدين: https://docs.spreeai.com/swagger/public/.

نموذج الوصول

يتم الاتفاق على نطاق واجهة برمجة التطبيقات (API) وبيئتها وبيانات اعتمادها والعمليات المسموح بها أثناء عملية انضمام الشريك. لا تفترض أن نقطة النهاية الداخلية أو التطويرية أو التاريخية متاحة في بيئة الإنتاج.

قواعد الاعتماد

• قم بتخزين أسرار العميل ورموز الوصول فقط في مخزن أسرار آمن على جانب الخادم.
• لا تقم أبدًا بإيداع بيانات الاعتماد في Git أو الوثائق أو أنظمة تتبع المشكلات أو لقطات الشاشة أو التطبيقات النموذجية.
• لا ترسل بيانات الاعتماد إلى منصات التحليلات أو التسجيل.
• استخدم بيانات الاعتماد الخاصة بالبيئة فقط مع البيئة التي تم إصدارها من أجلها.
• قم بتدوير بيانات الاعتماد فوراً إذا تم كشفها.
• قم بحذف رؤوس التفويض والرموز المميزة من طلبات الدعم.

المتصفح مقابل الخادم

يستخدم برنامج تطوير البرمجيات للويب إعدادات المتصفح الصادرة من الشريك. يجب عدم تضمين سر العميل في المتصفح.

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

روابط الويب

لا تُعدّ روابط الويب التي تُرسل البيانات من الخادم جزءًا من وثائق Web SDK المنشورة حاليًا. تأكد من أي متطلبات لروابط الويب قبل تصميم أي تبعية عليها.

قائمة التحقق البيئية

• [ ] اسم البيئة موثق.
• [ ] تم الحصول على عنوان URL الأساسي من المرجع المعتمد أو من عملية تسليم الإعداد.
• [ ] تم إصدار بيانات الاعتماد لتلك البيئة.
• [ ] يتم تخزين الأسرار على جانب الخادم.
• [ ] سجلات إخفاء الرموز وصور العملاء.
• [ ] تم الاتفاق على مهلات إعادة المحاولة وسلوك التكرار لعمليات الكتابة.
• [ ] ينجح اختبار غير إنتاجي قبل استخدام الوصول إلى الإنتاج.