الحصول على API Keys

استخدم هذه الصفحة عندما تحتاج إلى بيانات اعتماد لاستدعاء WLTE OpenAPI.

أين تُنشئ API Key

1. سجّل الدخول إلى Developer Console: https://developer.svnwi.com/wlte
2. افتح تطبيقك.
3. انتقل إلى إدارة API Client.
4. أنشئ API Client.
5. اختر أقل الصلاحيات اللازمة لتكاملك.
6. احفظ clientId وclientSecret المُولَّدين.

في Developer Console، تُنشأ API key كـ API Client. بعد الإنشاء، تحصل على قيمتين:

القيمة	الغرض
clientId	معرّف عام لـ API Client
clientSecret	سر يستخدمه خادمك لطلب access token

معًا، يشكّل clientId وclientSecret بيانات الاعتماد التي تستخدمها للحصول على access token.

ما تديره Developer Console

المجال	الغرض
API Keys	إنشاء API Client والحصول على clientId / clientSecret
الصلاحيات	التحكم في الأجهزة والعمليات التي يمكن لتكامل معيّن الوصول إليها
دورة حياة بيانات الاعتماد	تدوير بيانات الاعتماد أو تعطيلها أو إزالتها
حل المشكلات	استخدام معرّف العميل، ومعرّف الطلب، والطوابع الزمنية عند التواصل مع الدعم

كيف تُستخدم الـ Key

يستبدل خادمك بيانات الاعتماد بـ access token قصير المدة:

POST /wlte/v1/auth/token

بعد ذلك، يستدعي خادمك REST API بالرمز:

Authorization: Bearer {accessToken}

لا تستدعِ واجهات الأجهزة مباشرة باستخدام clientSecret. يُستخدم السر فقط لطلب access token.

قواعد الأمان الإلزامية

• خزّن clientSecret في تخزين أسرار جانب الخادم فقط.
• لا تضع clientSecret في كود المتصفح، أو تطبيقات الجوال، أو المستودعات العامة، أو لقطات الشاشة، أو السجلات.
• يُعرض clientSecret فقط عند الإنشاء أو التدوير. احفظه فورًا.
• إذا فُقد السر، دوّره. لا يمكن رؤية القيمة الأصلية مجددًا.
• استخدم API Client منفصلة للإنتاج، والتجهيز (staging)، والاختبار المحلي كلما أمكن.
• عطّل API Client غير المستخدمة.

الصلاحيات

تتحكم النطاقات (scopes) في ما يمكن لـ API Key فعله. على سبيل المثال، لا يمكن لمفتاح للقراءة فقط التحكم في المرحّلات أو تغيير إعداد الجهاز.

إذا أعاد استدعاء API قيمة AUTH_SCOPE_DENIED، حدّث نطاقات API Client في Developer Console، واحفظ التغيير، واحصل على access token جديد، ثم أعد المحاولة.

راجع الصلاحيات والأمان.

سلوك التدوير والتعطيل

يفرض خادم API تغييرات دورة حياة بيانات الاعتماد:

التغيير	السلوك المتوقّع
تدوير السر	لم يعد بإمكان السر القديم طلب رموز جديدة
تعطيل API Client	تفشل طلبات الرموز الجديدة، وتَرفض الواجهات المحمية الرموز الحالية
حذف API Client	تفشل طلبات الرموز الجديدة، وتَرفض الواجهات المحمية الرموز الحالية
تغيّر الصلاحيات	تُفحَص الرموز الحالية مقابل حالة الصلاحيات الراهنة

خطّط لعملية التدوير بحيث يكون خادمك محدّثًا قبل التوقف عن قبول السر القديم.