توثيق واجهة برمجة التطبيقات (API)

1. مقدمة

مرحبًا بك في توثيق واجهة برمجة التطبيقات (API)! سيساعدك هذا الدليل على فهم كيفية التفاعل بشكل آمن مع واجهة برمجة التطبيقات (API)، بما في ذلك الخطوات اللازمة للمصادقة وتشفير طلباتك، بالإضافة إلى معلومات مفصلة حول النقاط الطرفية المتاحة.

نظرة عامة على الأمان

يستخدم هذا واجهة برمجة التطبيقات (API) بروتوكول أمان قوي يتطلب من كل مستخدم امتلاك بيانات الاعتماد التالية:

• مفتاح التوقيع (Signature Key): مفتاح فريد يستخدم لإنشاء التوقيع.
• مفتاح التشفير (Crypt Key): مفتاح فريد يستخدم لتشفير الطلبات.
• الرمز المميز (Token): يستخدم لمصادقة المستخدم.

2. بروتوكول الأمان

دليل خطوة بخطوة

2.1 المفاتيح المطلوبة

• مفتاح التوقيع (Signature Key): يستخدم لإنشاء التوقيع.
• مفتاح التشفير (Crypt Key): يستخدم لتشفير كائن البيانات بالكامل في الطلب.
• الرمز المميز (Token): يتم تضمينه في الطلب للمصادقة.

2.2 التحقق من البيانات

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

2.3 إعادة ترتيب كائن البيانات

قم بإعداد كائن البيانات وقم بإعادة ترتيب حقوله أبجديًا.

Input: { "name": "  Test", "age": 25 }
Ordered: { "age": 25, "name": "  Test" }
        

2.4 إنشاء التوقيع

1. قم بدمج أزواج المفتاح-القيمة في سلسلة واحدة.
2. احذف جميع المسافات الإضافية، وقم بتحويل السلسلة بأكملها إلى أحرف صغيرة.
3. أضف مفتاح التوقيع (Signature Key) إلى نهاية السلسلة.
4. قم بإنشاء تجزئة MD5 للسلسلة الناتجة.
5. أضف التوقيع إلى كائن البيانات.

مثال باستخدام مفتاح التوقيع (Signature Key) : 5x12 .

Ordered: { "age": 25, "name": "  Test" }
Ordered Concatenate String: "age25nametest"
String with Signature Key: "age25nametestkey5x12"
Signature (MD5): "b50569c3cfce2bd77ea5b2ad03481f9c"

Result Object : { "age": 25, "name": "test", "signature": "b50569c3cfce2bd77ea5b2ad03481f9c" }
        

2.5 تشفير البيانات

قم بتشفير كائن البيانات النهائي باستخدام دالة CryptoJS.AES.encrypt، ولا تنسَ إضافة مفتاح التشفير (Crypt Key) كمفتاح للتشفير.

data = { "age": 25, "name": "test", "signature": "b50569c3cfce2bd77ea5b2ad03481f9c" }
encryptedData = CryptoJS.AES.encrypt(JSON.stringify(data), Crypt_Key).toString();
        

2.6 إرسال الطلب

{
  "data": "encryptedData",
  "token": "token"
}

3. توثيق النقاط الطرفية

استخدم الروابط التالية للعثور على توثيق النقاط الطرفية ولاختبار تكامل نظامك:

1. اختبار بروتوكول الأمان.
2. إنشاء تذكرة.
3. الحصول على تذكرة.
4. مسح التذكرة.
5. نقل التذكرة.