إدارة مفاتيح API
تتيح لك صفحة مفاتيح API إنشاء وعرض وإدارة المفاتيح التي تستخدمها تطبيقاتك لاستدعاء FourA API.
عرض مفاتيحك
تعرض الصفحة كل مفتاح يمكنك الوصول إليه: مفاتيحك الشخصية، وكل مفتاح تملكه مؤسسة تنتمي إليها. العضوية هي ما يمنح حق الوصول، لذا يرى العضو العادي مفاتيح المؤسسة أيضًا.
| Column | What it shows |
|---|---|
| الاسم | اسم العرض والوصف إذا قمت بتعيينه |
| المالك | Personal، أو اسم المؤسسة |
| بادئة المفتاح | بادئة مقنعة (pk_live_••••••••) مع زر كشف، أو أيقونة قفل للمفتاح القديم |
| الحالة | نشط أو غير نشط |
| تاريخ الإنشاء | وقت إنشاء المفتاح |
| آخر استخدام | وقت آخر طلب تم إجراؤه بواسطة المفتاح |
ابحث بالاسم أو الوصف، وصَفِّ النتائج إلى نشط أو غير نشط، ورتّب حسب أي ترويسة. تتنقل اتجاهات الترتيب بين تنازلي، ثم تصاعدي، ثم إيقاف الترتيب.
عامل تصفية المالك
إذا كنت تنتمي إلى مؤسسة واحدة على الأقل، فستظهر قائمة المالك المنسدلة بجوار مربع البحث: الكل، أو شخصي، أو إدخال لكل مؤسسة. تعمل القائمة على تضييق النطاق إلى المفاتيح التابعة لهذا المالك، ويتبع عنصر التحكم نفسه في صفحات Overview وMetrics وActivity وProxy اختيارك، بحيث تتطابق الصفحات الخمس دائمًا حول حركة المرور التي تستعرضها.
إنشاء مفتاح
انقر فوق إنشاء مفتاح أعلى القائمة (إنشاء مفتاح API في الصفحة الفارغة قبل مفتاحك الأول) واملأ ما يلي:
| Field | Required | Description |
|---|---|---|
| الاسم | نعم | تسمية وصفية، على سبيل المثال "production-scraper" أو "staging-test" |
| الوصف | لا | ملاحظات حول استخدامات هذا المفتاح |
| المالك | نعم إذا كنت ضمن مؤسسة | شخصي، أو أي مؤسسة تنتمي إليها. لا تظهر أداة الاختيار إلا عندما تنتمي إلى واحدة على الأقل. |
يمكن لأي عضو في مؤسسة إنشاء مفتاح تملكه، بغض النظر عن دوره. هذا هو الهدف من الإعداد: الاستخدام عبر مفتاح المؤسسة يُفوتر على مالك المؤسسة، بحيث لا يحتاج المطور إلى مفتاح شخصي يفوتر عليه تلقائيًا بدلًا من الشركة.
يظهر المفتاح الكامل مرة واحدة فور الإنشاء مباشرة في نافذة جاهزة للنسخ. يمكنك إظهاره لاحقًا باستخدام كشف. تستخدم المفاتيح البادئة pk_live_ وتبدو مثل pk_live_a1b2c3d4e5f6.... ستتلقى بريدًا إلكترونيًا يؤكد إنشاء المفتاح.
كشف المفتاح
انقر فوق أيقونة العين بجوار البادئة المقنعة للمفتاح لرؤية رمزه السري الكامل مرة أخرى. ستطلب منك لوحة التحكم التأكيد، ثم تفتح نافذة تعرض المفتاح الصريح وزر نسخ وعدًا تنازليًا قصيرًا. بعد انتهاء العد التنازلي، تمسح النافذة الرمز السري من الصفحة.
يتم تسجيل كل عملية كشف في سجل التدقيق لأنها تعرض بيانات اعتماد نشطة.
يمكن لأي شخص تمت مشاركة المفتاح معه كشفه: مالكه الشخصي، أو أي عضو في المؤسسة التي تملكه.
المفاتيح القديمة
المفاتيح التي تم إنشاؤها قبل إطلاق ميزة الكشف تعرض أيقونة قفل بدلا من العين ولا يمكن كشفها. تم تخزين الـ hash الخاص بها فقط، لذا لا يمكن استرداد السر الأصلي. للتحويل من مفتاح قديم، افتح قائمة الإجراءات واختر Regenerate. سيكون السر الجديد قابلا للكشف من تلك اللحظة فصاعدا.
ما يمكن لكل دور فعله
في المفتاح الشخصي يمكنك فعل كل شيء. في مفتاح المؤسسة، تنطبق ثلاثة مستويات:
| الإجراء | Member | Admin | Owner |
|---|---|---|---|
| استخدام المفتاح وكشفه | نعم | نعم | نعم |
| إعادة تسميته، تعديل الوصف | نعم | نعم | نعم |
| تمكينه أو تعطيله | لا | نعم | نعم |
| إعادة إنشاء السر | لا | نعم | نعم |
| حذفه | لا | نعم | نعم |
| نقله خارج المؤسسة | لا | لا | نعم |
يظل خيارا Disable و Edit في الصف ولكنهما يظهران بلون رمادي مع ملاحظة توضح السبب. لا يظهر Regenerate و Transfer و Delete في القائمة عندما لا يسمح دورك باستخدامها. ترفض الـ API نفس الإجراءات، لذا لا يمكن لأي تكامل تجاوز الواجهة.
يتبع هذا التقسيم تأثير كل إجراء على الأشخاص الذين يتشاركون المفتاح. إعادة التسمية غير ضارة. إعادة الإنشاء أو التعطيل توقف تكامل كل زميل فور حدوثها. نقل المفتاح إلى الخارج يسحبه من الشركة ويضع استخدامه على خطة الآخذ الخاصة، لذا فإن هذا الإجراء مخصص لـ Owner فقط.
تعديل مفتاح
انقر على Edit لتحديث الاسم والوصف. لا يتم تغيير الملكية في مربع الحوار هذا: استخدم Transfer.
خيار View Metrics في قائمة الإجراءات يفتح Overview مصفاة حسب ذلك المفتاح.
التفعيل وإلغاء التفعيل
استخدم Disable أو Enable في الصف. يؤدي إلغاء تفعيل المفتاح إلى حظر كل طلب API يستخدمه، ويمكنك إعادة تفعيله في أي وقت. يسري التغيير خلال ثوان معدودة.
إعادة إنشاء مفتاح
إذا كنت تشك في تسريب مفتاح، افتح قائمة الإجراءات واختر Regenerate. يؤدي هذا إلى إنشاء سر جديد لنفس معرف المفتاح key ID. يتوقف السر القديم عن العمل فورا. يظل الاسم والمالك وكل الإعدادات الأخرى كما هي دون تغيير.
يظل السر الجديد قابلا للكشف بعد إغلاق مربع الحوار، لذلك ليس عليك نسخه بدقة من المحاولة الأولى.
نقل مفتاح
خيار Transfer في قائمة الإجراءات ينقل المفتاح بين الملكية الشخصية وملكية المؤسسة دون إعادة إنشاء السر. يتم الاحتفاظ بمعرف المفتاح key ID ومقاييسه وسجل نشاطه. يتغير المالك فقط، ومعه الجهة التي تتم محاسبة الاستخدام عليها.
| النقل | من يمكنه القيام به |
|---|---|
| مفتاح شخصي إلى مؤسسة | أي شخص ينتمي إلى تلك المؤسسة |
| مفتاح مؤسسة إلى الخارج، لنفسك | الـ Owner الخاص بالمؤسسة |
| بين مؤسستين | الـ Owner الخاص بالمؤسسة التي يغادرها المفتاح |
المفتاح الذي ينتقل إلى مؤسسة ينضم إلى فريق "Everyone" الافتراضي الخاص بها، وهو ما يجعله مرئيا للأعضاء. المفتاح الذي ينتقل إلى الخارج يغادر كل فريق كان عضوا فيه.
حذف مفتاح
افتح قائمة الإجراءات واختر Delete. يؤدي حذف مفتاح استخدمته من قبل إلى تعطيله: يتوقف المفتاح عن المصادقة ويبقى في القائمة بحالة Inactive، وبذلك يحتفظ سجل Activity و Metrics باسمه. أما المفاتيح التي لم تُستخدم مطلقًا فتُحذف نهائيًا.
ستتلقى بريدًا إلكترونيًا عند حذف مفتاح.
مفاتيح المؤسسة والفوترة
يُحسب الاستخدام على مفتاح مملوك لمؤسسة ضمن خطة مالك المؤسسة، أياً كان من أرسل الـ request. وتحسب صفحة Usage & Limits الخاصة بالمالك تلك المفاتيح إلى جانب مفاتيحه الشخصية وتفصل بينهما.
ذو صلة
- Authentication: كيفية عمل مفاتيح الـ API مع الـ API
- Organizations: الأدوار والأعضاء والوصول المشترك
- Usage & Limits: المفاتيح التي تُحتسب ضمن خطتك
- Dashboard Overview: جميع أقسام لوحة التحكم