أهداف الأعمال
المنتجات والأسواق وأدوار المستخدمين والقواعد المالية والقيود والنتيجة المتوقعة.
الوثائق / متطلبات API
ما الذي يجب إعداده قبل ربط API
اجمع معلومات المشروع والوصول والبيانات والأمان وسيناريوهات الاختبار قبل بدء التكامل. سيساعد ذلك على تحديد نطاق العمل مسبقًا وتجنب إعادة العمل.
النطاق
المنتجات والأسواق
الوصول
المفاتيح والبيئات
البيانات
الصيغ والحالات
القبول
اختبار السيناريوهات
حزمة المتطلبات
ما يجب الاتفاق عليه قبل بدء العمل
01
مهام المشروع
المنتجات والأسواق والعملات والمزودون والمستخدمون وسير العمل.
02
قواعد تبادل البيانات
الطلبات والحقول والمعرفات والحالات والأخطاء والأحداث.
03
الوصول والأمان
مفاتيح الوصول وتوقيعات الطلبات وعناوين IP المسموحة والأدوار وسجل الإجراءات.
04
الاختبار والقبول
بيانات الاختبار والسيناريوهات الناجحة والخاطئة ومراقبة النتائج وشروط الإطلاق.
نظرة عامة
المتطلبات المتفق عليها تقلل الوقت وإعادة العمل
قبل بدء العمل، يجب أن يفهم الطرفان بالطريقة نفسها مهام المشروع ومصادر البيانات وحالات العمليات ومسؤولية الأنظمة وقواعد الأمان وشروط القبول. عندها يُبنى الربط على مخطط متفق عليه بدلًا من الافتراضات.
قواعد الربط
طرق تبادل البيانات ومكونات الطلبات والاستجابات والمعرفات والحالات والإشعارات والأخطاء والقيود.
شروط القبول
سيناريوهات الاختبار والبيانات المتوقعة والتقارير ومراقبة التشغيل وشروط الانتقال إلى الإطلاق.
بيانات المشروع
بيانات المشروع والأنظمة المتصلة
يُثبت أولًا السياق العام: ما المنتجات التي يتم ربطها، وما الأنظمة المشاركة، وأين تُخزن البيانات الأساسية، ومن المسؤول عن كل عملية.
نطاق المشروع ومهامه
المنتجات: الكازينو والمراهنات الرياضية والمدفوعات وKYC وCRM والمكافآت والتقارير أو المكتب الخلفي.
البلدان والتراخيص والعملات واللغات والعلامات التجارية وقنوات الاستخدام.
أنواع المستخدمين والأدوار والحدود والحالات وسيناريوهات العمل الأساسية.
الأولويات ومراحل الإطلاق والوظائف الحرجة والقيود التجارية.
الأنظمة ومالكو البيانات
قائمة الأنظمة الداخلية والخارجية المشاركة في العملية.
المصدر الأساسي لبيانات اللاعب أو الرصيد أو المعاملة أو الرهان أو المكافأة أو تحقق KYC.
واجهات API وقواعد البيانات وطوابير الرسائل والإشعارات والملفات والواجهات القديمة المتاحة.
الفرق المسؤولة وجهات اتصال العمل وإجراءات تصعيد المسائل المعقدة.
متطلبات الربط
متطلبات تبادل البيانات عبر API
يجب أن تسمح الوثائق بتنفيذ الربط دون تخمين. لكل عملية، يتم وصف الغرض وبيانات الإدخال والنتيجة والأخطاء المحتملة وقواعد إعادة الإرسال مسبقًا.
عناوين الطلبات وطرقها
عنوان API الرئيسي ومسارات الطلبات وطرق HTTP والمعلمات والترويسات والغرض من كل عملية.
صيغ الطلبات والاستجابات
أنواع البيانات والحقول الإلزامية وصيغ التواريخ ودقة المبالغ والقيم الفارغة المسموحة والأمثلة.
حالات العمليات
المسار الكامل للعملية من الإنشاء إلى الإكمال والتغييرات المسموحة والحالات النهائية.
الأخطاء والإجراءات
رموز الأخطاء والأسباب الواضحة وإمكانية إعادة الإرسال والإجراءات المطلوبة من النظام المستلم.
إشعارات الأحداث
بنية الحدث والتوقيع والتسليم وتأكيد الاستلام وإعادة الإرسال وترتيب المعالجة.
الحماية من التكرار
رقم عملية فريد والتعرف على الطلب المكرر والاستعادة الآمنة بعد العطل.
الحدود والحمل
معدل الطلبات والمهلة والعمليات المتزامنة وحجم الاستجابة والحمل الأقصى المتوقع.
تغيير الإصدارات
إصدار API والتوافق مع الاتصالات القديمة ومدة الإشعار وإجراءات إدخال التغييرات.
الأمان والوصول
متطلبات الأمان وإدارة الوصول
قبل نقل بيانات العمل، يتم الاتفاق على طرق الدخول وتوقيع الطلبات وقيود الشبكة وصلاحيات المستخدمين وتخزين المفاتيح وتسجيل الإجراءات.
الوصول إلى API
مفاتيح API وOAuth وJWT وحسابات الخدمة ومدة صلاحية الرموز وتدويرها المجدول.
توقيع الطلبات
التحقق من HMAC ووقت الطلب والقيمة الفريدة للحماية من إعادة الإرسال.
الوصول الشبكي
عناوين IP والنطاقات المسموحة والاتصال الآمن وVPN وقواعد الشبكة وفصل بيئة الاختبار عن العمل.
الأدوار والصلاحيات
تُمنح صلاحيات الخدمات والموظفين وفق مبدأ أقل قدر لازم من الوصول.
حماية البيانات
التشفير وإخفاء القيم الحساسة وفترات الاحتفاظ والحذف وقواعد التعامل مع البيانات الشخصية.
سجل الإجراءات
رقم الطلب والمشارك والوقت والتغييرات والأخطاء وسجل العمليات الحرجة.
الاختبار والقبول
متطلبات الاختبار والقبول
يجب أن تحاكي بيئة الاختبار ليس فقط العمليات الناجحة، بل أيضًا الأخطاء والتأخيرات والتكرار والقيود والتقارير النهائية.
بيئة الاختبار
عناوين ومفاتيح وصول ونقاط استقبال إشعارات وقيود وقواعد تنظيف بيانات منفصلة.
بيانات الاختبار
لاعبون وعملات وطرق دفع ومزودون وحالات وقيم لسيناريوهات قابلة للتكرار.
سيناريوهات ناجحة
سير العمل الكامل من الطلب الأول إلى الحالة النهائية وانعكاسه في التقارير.
سيناريوهات الأخطاء
بيانات غير صحيحة أو تجاوز المهلة أو عملية مكررة أو رصيد غير كافٍ أو رفض أو خطأ مزود.
السجلات والتشخيص
رقم الطلب والوقت الدقيق والحالة الأصلية والبيانات اللازمة للتحليل المشترك.
القبول
قائمة متفق عليها من السيناريوهات والنتائج المتوقعة والمسؤولين عن التأكيد.
قائمة تحقق الجاهزية
قائمة التحقق الدنيا قبل بدء التطوير
يمكن التخطيط للتكامل بعد الاتفاق على النطاق وقواعد تبادل البيانات والوصول وبيئة الاختبار والأطراف المسؤولة.
تم اعتماد نطاق التكامل
تم تحديد المنتجات والأسواق والأنظمة والوظائف ومراحل الإطلاق.
وثائق API متاحة
تم وصف عناوين الطلبات وصيغ البيانات والحالات والأخطاء والإشعارات والأمثلة.
تم إصدار بيانات وصول الاختبار
المفاتيح نشطة وتم الاتفاق على عناوين IP المسموحة وعناوين استقبال الإشعارات.
تم الاتفاق على الأمان
تم تحديد طرق الوصول والتوقيع والأدوار وتخزين المفاتيح والتسجيل.
تم إعداد سيناريوهات الاختبار
توجد سيناريوهات ناجحة وخاطئة ومكررة وسيناريوهات أعطال.
تم تعيين المسؤولين
تم تحديد مالكي المنتج ومتخصصي التطوير والاختبار والأمان والدعم.
هل تحتاج إلى التحقق من جاهزية المتطلبات؟
أرسل الوثائق وقائمة الأنظمة ووصف العمليات والبيئات المتاحة. سيساعد APIACE في العثور على البيانات الناقصة قبل بدء التطوير.