مفاتيح API

يتيح مفتاح API لأحد أنظمتك، كموقع أو سكربت أو أداة أتمتة، أن يستدعي واجهة REST باسم شركتك. تشرح هذه الصفحة من يستطيع إنشاء المفاتيح، وما يقدر عليه المفتاح، وكيف تستبدله أو تلغيه بأمان.

قبل أن تبدأ

• الباقة: المفاتيح متاحة عندما تشمل باقتك واجهة API. ومن دونها لا تظهر شاشة مفاتيح API، ويُرفض كل مفتاح موجود بالرمز 403.
• الدور: المالكون والمسؤولون وحدهم يفتحون مفاتيح API وينشئون المفاتيح ويلغونها. أما الأعضاء والمشاهدون فلا.
• المكان: افتح جهات الاتصال من الشريط الجانبي، ثم أدوات، ثم مفاتيح API.

كيف يعمل المفتاح

يعمل المفتاح دائمًا باسم من أنشأه وبدوره الحالي. لا يتغير المفتاح نفسه حين يتغير صاحبه، لكن ما يستطيعه يتبع صاحبه في كل طلب:

ولكل مفتاح أحد مستويين من الصلاحية:

أعطِ كل نظام أقل ما يحتاجه. سكربت التقارير يكفيه قراءة فقط، والموقع الذي ينشئ جهات اتصال يحتاج قراءة وكتابة.

إنشاء مفتاح

1. افتح جهات الاتصال، ثم أدوات، ثم مفاتيح API.
2. تحت إنشاء مفتاح اكتب في اسم المفتاح اسمًا يدل على مكان استخدامه، مثل «نموذج التواصل في الموقع». يصل الاسم إلى 80 حرفًا.
3. اختر الصلاحية: قراءة فقط أو قراءة وكتابة.
4. اختر إنشاء مفتاح.
5. انسخ المفتاح من المربع الذي يقول انسخ هذا المفتاح الآن، فلن يظهر مرة أخرى. واحفظه في إعدادات الأسرار لدى نظامك.

يظهر المفتاح مرة واحدة فقط. فهو يُحفظ بتجزئة باتجاه واحد (hash)، فلا يستطيع أحد، ولا فريق الدعم، أن يعرضه لك مجددًا. وإن أضعته فأنشئ مفتاحًا جديدًا وألغِ القديم.

يبدأ المفتاح بكلمة قصيرة وشرطة سفلية، تليها 48 خانة عشوائية. ويكتبه هذا الدليل YOUR_API_KEY. عامل السلسلة كاملة معاملة كلمة المرور.

عرض المفاتيح

تعرض شاشة مفاتيح API كل مفتاح نشط باسمه وآخر ثماني خانات منه وصلاحيته ووقت آخر استخدام له (آخر استخدام مع التاريخ، أو لم يُستخدم). يُحدَّث تاريخ آخر استخدام مرة في الدقيقة على الأكثر، فهو إرشاد لا سجل دقيق.

استبدال المفتاح

لا يوجد زر يغير مفتاحًا قائمًا، لذلك يكون الاستبدال بمفتاحين متداخلين:

1. أنشئ مفتاحًا جديدًا بالصلاحية نفسها وباسم يدل على أنه الجديد.
2. ضع المفتاح الجديد في نظامك وانشر التغيير.
3. انتظر حتى يظهر للمفتاح الجديد تاريخ في آخر استخدام، فهذا يؤكد أن نظامك يستخدمه.
4. اختر إلغاء بجانب المفتاح القديم.

استبدل المفتاح حين يغادر شخص كان يعرفه، وحين يُحتمل أنه انكشف، وعلى جدول منتظم يناسب سياستك الأمنية.

إلغاء المفتاح

اختر إلغاء بجانب المفتاح. يسري الإلغاء فورًا، فالطلب التالي بهذا المفتاح يرد 401 Invalid API key. ولا يمكن استعادة مفتاح ملغى. يختفي من القائمة ولا يُحسب ضمن الحد.

معلومات مفيدة

• للشركة حتى 10 مفاتيح نشطة. ومحاولة إنشاء الحادي عشر تُظهر بلغت هذه الشركة 10 مفاتيح نشطة. فألغِ أولًا مفتاحًا لم تعد تحتاجه.
• المفتاح يخص شركة واحدة، ولا يرى بيانات شركة أخرى أبدًا، ولو كان منشئه عضوًا في عدة شركات.
• تبقى المفاتيح عاملة إن تغير اسم المنتج، لأن المفتاح يُعرف بتجزئته لا بكلمته الأولى.
• لا تضع المفتاح في صفحة ويب أو تطبيق جوال أو أي كود يستطيع الزائر تنزيله. الواجهة لا ترسل ترويسات CORS، فلا تستطيع المتصفحات استدعاءها أصلًا. استدعها من خادمك.
• استخدم مفتاحًا مستقلًا لكل نظام، لتلغي أحدها دون أن توقف البقية.

حل المشكلات