OAuth 2.0
سيتطلب الوصول إلى واجهة برمجة التطبيقات مصادقة OAuth 2.0 والتي بدورها ستتطلب مستخدمًا تقنيًا لموزع معين في نظام مصادقة شنايدر.
لطلب بيانات الاعتماد ، يرجى إرسال بريد إلكتروني إلى: Distributorapiportal.global@se.com
كيف يعمل بروتوكول OAuth:
يحتاج مستخدم API إلى معرف عميل ثابت ومفتاح سري جنبًا إلى جنب مع نقطة نهاية إنشاء الرمز المميز من مزود واجهة برمجة التطبيقات.
باستخدام التفاصيل أعلاه ، يجب استدعاء Token API بطريقة POST.
ستعيد واجهة برمجة التطبيقات رمز Bearer المميز ، والذي يمكن استخدامه لمدة ساعة واحدة لاستدعاء API ، ويمكن التعامل مع هذا على أنه بيانات اعتماد ديناميكية تنتهي صلاحيتها لمدة ساعة واحدة.
| بيئة | نقطة نهاية توليد الرمز المميز |
| يكتشف | https://api.explore.se.com/token |
| Dev | https://api.dev.se.com/token |
| QA | https://api.qa.se.com/token |
| Pre-prod | https://api.preprod.se.com/token |
| Production | https://api.se.com/token |
كيفية إنشاء رمز مميز باستخدام Postman:
- إنشاء طلب API جديد بنقطة نهاية API الفعلية
- انتقل إلى قسم التفويض
- حدد النوع كـ OAuth 2.0
- على الجانب الأيمن ، انتقل إلى تكوين رمز جديد
- يمكن تحديد اسم الرمز المميز من قبل المستخدم (على سبيل المثال ، اسم الموزع)
- نوع المنحة = بيانات اعتماد العميل (اختر من القائمة المنسدلة)
- سيكون عنوان URL الخاص برمز الوصول وفقًا للجدول أعلاه
- سيتم منح معرف العميل وسر العميل من قبل فريق شنايدر
- نطاق كل شيء
- يمكن أن تكون مصادقة العميل إرسال بيانات اعتماد العميل في النص الأساسي
- انقر فوق الحصول على رمز وصول جديد
نموذج إنشاء الرمز المميز باستخدام طلب ساعي البريد الجديد:
- حدد POST وأدخل عنوان URL الخاص بالرمز المميز.
- من علامة التبويب Body ، انقر فوق زر الاختيار x-www-form-urlencoded.
- أدخل المفتاح والقيمة يدويًا ، و "نوع المنحة" و "بيانات اعتماد العميل".
- من علامة التبويب "التخويل" ، حدد نوع "المصادقة الأساسية".
- قم بتعيين اسم المستخدم على مفتاح العميل (المقدم لك في وضع عدم الاتصال).
- قم بتعيين كلمة المرور على سر العميل (المقدم لك في وضع عدم الاتصال).
- إرسال طلب واسترداد قيمة access_token من رسالة الرد.
إنشاء طلب إنشاء رمز مميز باستخدام CURL في ساعي البريد:
- في ساعي البريد ، حدد خيار الاستيراد (الموجود في أعلى اليسار).
- في مربع الحوار "استيراد" ، حدد النص الخام والصق عينة الضفيرة المتوفرة أدناه.
- انقر فوق "متابعة" ثم "استيراد".
- من علامة التبويب الرؤوس ، استبدل قيمة التخويل بالسلسلة المشفرة Base-64 من client_key و client_secret.
عينة حليقة لإنشاء الرمز المميز:
curl --location --request POST 'https://api.se.com/token' \
--header 'Authorization: Basic askjdfsaldalskjfdlsajflasdkjfb2h4NVJxMFlSZ2hUbA==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'
مفتاح API
بالنسبة إلى عدد قليل من واجهات برمجة التطبيقات ، يكون الوصول باستخدام مفتاح واجهة برمجة التطبيقات ممكنًا أيضًا حيث توفر apikey طويل العمر كمعامل استعلام.
بمجرد أن يكون لديك واجهة برمجة تطبيقات ، يمكنك ممارسة عمليات GET مباشرة في متصفح الويب.
تنسيق عنوان URL: https: // {hostname} / {BaseURL} / {ResourcePath}؟ {queryParams} & apikey = {your_api-key}