مفاتيح API

تصادق مفاتيح API على الطلبات المرسلة إلى واجهة /v1 Public API. يتبع كل مفتاح حساب خدمة ويُنشأ من صفحة تفاصيل ذلك الحساب في Developer Hub. استخدم مفتاح API محدد النطاق للتكامل الخلفي الخاص عندما يلبي تخزين السر وتدويره بشكل آمن متطلباتك. ولا حاجة إلى عميل OAuth أو إلى تبادل الرموز. راجع المصادقة إذا كانت مؤسستك تتطلب رموز وصول OAuth قصيرة الأجل بدلًا من ذلك.

​

مكونات المفتاح

• المعرف — يبدأ بـ ak_. يمكن الإشارة إليه بأمان في التذاكر والسجلات وملفات التهيئة؛ فهو لا يمنح أي صلاحية بمفرده.
• السر — يبدأ بـ lsk_live_. وهو بيانات الاعتماد التي يقدمها التكامل الخاص بك. يُعرض مرة واحدة فقط، عند الإنشاء أو التدوير، ولا يمكن استرجاعه لاحقًا. تعرض قائمة المفاتيح آخر أربعة أحرف فقط (مثل lsk_live_…xQc4) لتتمكن من مطابقة الصف مع بيانات الاعتماد التي بحوزة الجهة المستدعية.
• الأذونات — مجموعة فرعية من أذونات حساب الخدمة المالك، تُحدد عند الإنشاء. ولا يمكن للمفتاح أن يفعل أكثر مما يسمح به حسابه.
• انتهاء الصلاحية — إلزامي. لكل مفتاح تاريخ انتهاء صلاحية.

​

إنشاء مفتاح

في صفحة تفاصيل حساب الخدمة، أنشئ مفتاحًا عبر أربع خطوات: سمِّه، وحدد الأذونات التي يحتاجها هذا المفتاح تحديدًا، واختر مدة انتهاء الصلاحية — 30 أو 90 أو 365 يومًا، أو مدة مخصصة تصل إلى سنة — ثم راجع البيانات. يُعرض السر عند الإكمال، مرة واحدة. حدِّد نطاق كل مفتاح بأضيق مجموعة أذونات تحتاجها الجهة المستدعية، حتى لو كان الحساب يسمح بأكثر من ذلك. فإذا تسرّب مفتاح، فإن أذوناته تحدد نطاق الضرر.

​

التدوير دون توقف

يُصدر التدوير سرًا جديدًا ويبدأ فترة تداخل — ساعة واحدة أو 24 ساعة أو 7 أيام — يظل خلالها السر القديم صالحًا للعمل. وهذا يتيح لك نشر السر الجديد عبر بيئات النشر بالوتيرة التي تناسبك: دوِّر المفتاح قبل انتهاء صلاحيته أيضًا: تُوسم المفاتيح التي يقترب تاريخ انتهاء صلاحيتها على أنها توشك على الانتهاء في قائمة المفاتيح. يتوقف المفتاح المنتهي الصلاحية عن المصادقة — وتُرجع الطلبات المرسلة به 401 مع الرمز credential_expired.

​

الإلغاء الفوري

يسري الإلغاء فورًا وهو دائم — لا توجد فترة تداخل ولا إمكانية للتراجع. ألغِ المفتاح فور الاشتباه في انكشاف سره؛ ودوِّره بدلًا من ذلك عندما تستبدل بيانات اعتماد سليمة. تُرجع الطلبات المرسلة بمفتاح ملغى 401 مع الرمز credential_revoked. وإذا كنت بحاجة إلى إيقاف جميع المفاتيح التي يحملها تكامل ما دفعة واحدة، فعطّل حساب الخدمة الخاص به بدلًا من ذلك.