المصادقة بمفتاح API
تستخدم OneClickDz Flexy API المصادقة بمفتاح API. يجب أن تتضمن جميع الطلبات مفتاح API في رأس الطلب.تنسيق الرأس
اسم الرأس هو
X-Access-Token (وليس Authorization). تأكد من استخدام الاسم الصحيح للرأس.أنواع مفاتيح API
لديك وصول إلى نوعين من مفاتيح API:مفتاح Sandbox
الغرض: الاختبار والتطوير - لا خصم من الرصيد الحقيقي - استجابات محاكاة - أرقام اختبار خاصة متاحة - آمن للتطوير
مفتاح Production
الغرض: المعاملات الفعلية - خصم من الرصيد الحقيقي - تكامل مع المشغل الفعلي - جاهز للإنتاج - استخدم بحذر
إنشاء مفاتيح API
1
تسجيل الدخول إلى لوحة التحكم
قم بزيارة enterprise.oneclickdz.com وسجّل الدخول إلى حسابك
2
الانتقال إلى الإعدادات
انتقل إلى الإعدادات ← تكوين API
3
إنشاء المفاتيح
انقر على “إنشاء مفتاح API” لبيئتي Sandbox وProduction
4
الحفظ بأمان
انسخ مفاتيحك واحفظها في مكان آمن. لن تتمكن من رؤيتها مجدداً.
التحقق من مفتاح API
اختبر مفتاح API باستخدام endpoint التحقق:الاستجابة عند النجاح
خصائص مفتاح API
يتضمن مفتاح API الخاص بك الخصائص التالية:القائمة البيضاء لعناوين IP
لتعزيز الأمان، يمكنك تقييد مفاتيح API الخاصة بك على عناوين IP محددة. لكل بيئة (Production وSandbox) قائمتها البيضاء المستقلة.1
الانتقال إلى إعدادات API
انتقل إلى الإعدادات ← تكوين API في لوحة التحكم
2
إضافة عناوين IP
أدخل عناوين IP المحددة لكل بيئة: - القائمة البيضاء لـ Production: تتحكم في الوصول لمفتاح API الإنتاج - القائمة البيضاء لـ Sandbox: تتحكم في الوصول لمفتاح API sandbox - اتركها فارغة للسماح لجميع العناوين
3
حفظ التغييرات
انقر على “تحديث القائمة البيضاء” لتطبيق التغييرات
تنسيق القائمة البيضاء
أضف عناوين IP محددة إلى القائمة البيضاء، واحد في كل سطر:203.0.113.45- يسمح فقط لهذا العنوان198.51.100.23- عنوان IP آخر محدد
نطاقات المفاتيح
يمكن أن تمتلك مفاتيح API مستويات وصول مختلفة:READ-WRITE (الافتراضي)
وصول كامل لجميع العمليات:- عرض الرصيد والمعاملات
- إرسال الشحنات
- تقديم الطلبات
- التحقق من الحالات
READ-ONLY
مقتصر على عمليات القراءة:- عرض الرصيد والمعاملات
- التحقق من حالة الشحن
- سرد الطلبات
- لا يمكن إنشاء معاملات جديدة
استجابات الأخطاء
400 - مفتاح API مفقود
401 - مفتاح API غير صالح
403 - عنوان IP غير مسموح به
403 - IP محظور
أفضل ممارسات الأمان
تخزين المفاتيح بأمان
تخزين المفاتيح بأمان
- لا تلتزم أبداً بمفاتيح API في نظام إدارة الإصدارات
- استخدم متغيرات البيئة أو أنظمة إدارة الأسرار
- دوِّر المفاتيح بشكل دوري
- استخدم مفاتيح مختلفة لبيئات مختلفة
استخدام HTTPS فقط
استخدام HTTPS فقط
- استخدم دائماً endpoints بروتوكول HTTPS
- لا ترسل مفاتيح API عبر HTTP أبداً
- تحقق من شهادات SSL
تطبيق القائمة البيضاء لعناوين IP
تطبيق القائمة البيضاء لعناوين IP
- أضف فقط عناوين IP الضرورية
- استخدم عناوين IP محددة بدلاً من نطاقات واسعة
- حدّث القائمة البيضاء عند تغيير البنية التحتية
مراقبة استخدام API
مراقبة استخدام API
- تتبع استخدام مفاتيح API بانتظام
- أعدّ تنبيهات للأنشطة غير المعتادة
- راجع سجلات الوصول
- أبطِل المفاتيح المخترقة فوراً
تحديد نطاق المفاتيح
تحديد نطاق المفاتيح
- استخدم مفاتيح للقراءة فقط حيثما أمكن
- أنشئ مفاتيح منفصلة لخدمات مختلفة
- طبّق مبدأ الحد الأدنى من الامتيازات
تدوير المفاتيح
يُنصح بتدوير مفاتيح API بشكل دوري:1
إنشاء مفتاح جديد
أنشئ مفتاح API جديداً من لوحة التحكم
2
تحديث التطبيق
انشر تطبيقك بالمفتاح الجديد
3
التحقق
اختبر أن المفتاح الجديد يعمل بشكل صحيح
4
إبطال المفتاح القديم
بعد التحقق، أبطِل المفتاح القديم من لوحة التحكم
هل تحتاج مساعدة؟
إذا كنت تواجه مشاكل في المصادقة:- تحقق من صحة مفتاح API
- تأكد من استخدام اسم الرأس الصحيح (
X-Access-Token) - تأكد من أن عنوان IP الخاص بك في القائمة البيضاء (إذا كانت مفعّلة)
- تحقق من حالة API على status.oneclickdz.com
- تواصل مع الدعم على [email protected]

