مفاتيح API
يسمح مفتاح API لخادمك باستدعاء واجهة SMSFabric البرمجية. ينتمي كل مفتاح إلى مؤسسة واحدة، ويكون إما مفتاحًا تجريبيًا أو مفتاح إنتاج، ولا يحمل إلا الصلاحيات التي تمنحه إياها. طريقة إرسال المفاتيح والتحقق منها في المصادقة.
إنشاء مفتاح
Section titled “إنشاء مفتاح”-
افتح مفاتيح API في الشريط الجانبي تحت المطوّرون.
افتح مفاتيح API. -
انقر إنشاء مفتاح API. إن بلغت باقتك حدها من مفاتيح API، يظهر الزر باهتًا ويذكر السبب؛ راجع الباقة والاستخدام.
انقر إنشاء مفتاح API. -
اكتب في حقل الاسم اسمًا يدل على ما سيستخدم المفتاح، مثل “Order notifications”. وتحت الوضع اختر تجريبي · بيئة اختبار أو إنتاج · رسائل حقيقية.
اكتب الاسم واختر الوضع. -
حدد من الصلاحيات ما يحتاجه المستدعي فقط. الخادم الذي يرسل فقط يحتاج
messages:send؛ وأضفmessages:readإن كان يتحقق من الحالات أيضًا.اختر الصلاحيات. -
اختر موعد الانتهاء: بعد 30 يومًا، أو 90 يومًا، أو سنة، أو أبدًا (غير مستحسن). وفي قائمة عناوين IP المسموحة يمكنك إدخال العناوين التي تتصل منها خوادمك، مفصولة بفواصل، كعناوين مفردة أو نطاقات CIDR مثل
198.51.100.0/24. اتركها فارغة للسماح بأي عنوان. ثم انقر إنشاء المفتاح.حدد موعد الانتهاء، وقائمة عناوين IP إن أردت. -
انسخ السر الآن واحفظه في مدير الأسرار أو متغيرات البيئة، ثم انقر حفظته. لن تعرضه البوابة مرة أخرى؛ وإن فقدته فدوّر المفتاح.
انسخ السر واحفظه.
يبدو المفتاح هكذا: sf_test_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx، أي الوضع ثم بادئة من 12 حرفًا تعرّفه ثم السر. أرسله في الترويسة X-Api-Key.
قراءة قائمة المفاتيح
Section titled “قراءة قائمة المفاتيح”| العمود | يعرض |
|---|---|
| الاسم | الاسم، وبادئة المفتاح (sf_live_k2v8x0_••••) لتطابقه مع إعداداتك |
| الوضع | إنتاج أو تجريبي |
| الصلاحيات | ما يستطيع المفتاح فعله: أول ثلاث صلاحيات ثم +N للباقي |
| آخر استخدام | آخر مرة أرسل فيها المفتاح طلبًا، أو لم يُستخدم |
| الانتهاء | متى يتوقف عن العمل، أو بلا انتهاء |
المفتاح الذي لم يستخدمه أحد منذ أشهر مرشح للإلغاء.
تدوير مفتاح
Section titled “تدوير مفتاح”دوّر المفتاح إن احتمل أن سره تسرّب، أو حين يغادر شخص يعرفه، أو وفق جدول منتظم.
-
انقر ⋮ في طرف صف المفتاح.
افتح إجراءات المفتاح. -
انقر تدوير السر…، ثم تدوير السر للتأكيد.
أكّد التدوير. -
انسخ السر الجديد وانشره على خوادمك. يبقى السر القديم صالحًا 24 ساعة كي تنتقل خوادمك دون انقطاع، ثم يتوقف.
انسخ السر الجديد وانشره خلال 24 ساعة.
إلغاء مفتاح
Section titled “إلغاء مفتاح”ألغِ المفتاح الذي لم تعد تستخدمه، أو المفتاح المسرّب الذي لا يحتمل انتظار 24 ساعة.
-
افتح قائمة ⋮ للمفتاح وانقر إلغاء…. اكتب كلمة التأكيد
إلغاء، ثم انقر إلغاء المفتاح. تفشل الطلبات التي تستخدمه فورًا برمز401، ولا يمكن التراجع عن ذلك.اكتب كلمة التأكيد وانقر إلغاء المفتاح.
يُسجل إنشاء المفاتيح وتدويرها وإلغاؤها في سجل التدقيق.
من يمكنه إدارة المفاتيح
Section titled “من يمكنه إدارة المفاتيح”تحتاج إدارة المفاتيح إلى apikeys:manage، وهي متاحة لأدوار المالك ومسؤول ومطوّر. ولا يمكنك منح مفتاح صلاحيات لا يملكها دورك. ولا يدير المفاتيح إلا أشخاص مسجّلو الدخول: لا يستطيع مفتاح API إنشاء مفاتيح أو تدويرها أو إلغاءها. راجع الفريق للأدوار والمصادقة لما تسمح به كل صلاحية.