قبل البدء في استخدام API، يجب عليك المصادقة لإنشاء جلسة.
المصادقة:
هناك طريقتان لبدء الجلسة:
- استخدام مفتاح API الخاص بك، وبيانات تسجيل الدخول وكلمة المرور؛
- استخدام مفتاح API الخاص بك، وبيانات تسجيل الدخول وكلمة المرور المشفرة.
استخدام مفتاح API الخاص بك، وبيانات تسجيل الدخول وكلمة المرور
هنا يجب عليك ببساطة استخدام نقطة النهاية POST /session وذكر مفتاح API الذي تم استلامه في إعدادات المنصة في رأس X-CAP-API-KEY، وبيانات تسجيل الدخول وكلمة مرور API في معلمي identifier و password. يجب أن تكون قيمة المعامل encryptedPassword هي false.
استخدام مفتاح API الخاص بك، وبيانات تسجيل الدخول وكلمة المرور المشفرة
- أولاً يجب عليك استخدام GET /session/encryptionKey وذكر مفتاح API الذي تم إنشاؤه في إعدادات المنصة في رأس X-CAP-API-KEY. ستتلقى في الرد معلمات encryptionKey و timeStamp؛
- باستخدام معلمات encryptionKey و timeStamp المستلمة، يجب عليك تشفير كلمة مرور API الخاصة بك باستخدام طريقة التشفير AES.
- اذهب إلى نقطة النهاية POST /session، واضبط قيمة true لمعامل encryptedPassword واذكر مفتاح API الذي تم استلامه في إعدادات المنصة في رأس X-CAP-API-KEY، وبيانات تسجيل الدخول وكلمة مرور API المشفرة مسبقًا في معلمي identifier و password
عند بدء الجلسة، ستتلقى معلمات CST و X-SECURITY-TOKEN في رؤوس الاستجابة. يجب استخدام كلا الرمزين في رؤوس كل طلب ترسله.