الملخص
يتيح مفتاح API لنظام خارجي أن يُثبت هويته لتطبيق Safety وأن يتعامل مع بيانات حسابك برمجياً. تنشئ المفتاح، وتنسخه مرة واحدة في لحظة توليده، ثم تمنحه للنظام الذي يحتاجه. وبعد ذلك يمكن إعادة تسمية المفتاح أو إلغاء تنشيطه أو إبطاله من إعدادات مفاتيح API، حيث ترى أيضاً موعد آخر استخدام لكل مفتاح. تتناول هذه المقالة إنشاء المفاتيح، وقراءة القائمة، وسحب المفاتيح من الخدمة بأمان.
المقدمة
بعض التكاملات لا تغطيها الاتصالات المدمجة. فقد ترغب في سحب بيانات الحوادث إلى أداة لذكاء الأعمال، أو إدخال سجلات من نظام آخر، أو أتمتة مهمة لا يوجد لها خيار جاهز. ومفتاح API هو ما يجعل ذلك ممكناً: فهو يعرّف نظاماً خارجياً بعينه ويتيح له العمل على حسابك دون أن يسجّل شخص الدخول.
يدير مفاتيح API مسؤولو النظام من فئتي Admin و Super Admin. ولأن المفتاح يحمل مستوى الوصول نفسه الذي يحمله مستخدم Admin، فهذه مهمة أمنية بقدر ما هي مهمة تهيئة، ولذلك تُولي هذه المقالة سحب المفاتيح من الخدمة القدر نفسه من الاهتمام الذي تُوليه لإنشائها.
المفاهيم الأساسية
- مفتاح API: بيانات اعتماد تتيح لنظام خارجي إثبات هويته لتطبيق Safety نيابةً عن حسابك. وهو يمنح وصولاً برمجياً بالصلاحيات نفسها التي يملكها مستخدم Admin، ولهذا يجب حمايته كما تُحمى كلمة المرور.
- الاسم (Name): التسمية التي تمنحها للمفتاح لتعرف لاحقاً الغرض منه. ولأن قيمة المفتاح نفسها لا تُعرض مرة أخرى أبداً، يكون الاسم هو الدليل المقروء الوحيد على النظام الذي يعتمد عليه.
- البادئة (Prefix): الأحرف الأولى من المفتاح، وتظهر في القائمة. وهي تتيح لك مطابقة قيمة محفوظة في نظام آخر بالصفّ الصحيح هنا دون كشف السر الكامل.
- الحالة (Status): ما إذا كان المفتاح نشطاً (Active) أو غير نشط (Inactive). وتُرفض الطلبات التي تُجرى بمفتاح غير نشط.
- آخر استخدام (Last Used): آخر مرة أُثبتت فيها هوية طلب باستخدام المفتاح. وهذا هو الحقل الذي يخبرك ما إذا كان المفتاح لا يزال يؤدي عملاً أم أنه صار منسياً.
- تاريخ الانتهاء (Expires): تاريخ انتهاء الصلاحية، إن كان قد حُدِّد. ووجود تاريخ انتهاء يفرض التغيير الدوري بدلاً من ترك مفتاح صالحاً إلى ما لا نهاية.
الخطوات التي يجب اتباعها
فتح إعدادات مفاتيح API
سجّل الدخول بصفتك Admin أو Super Admin، ثم افتح الإعدادات (Settings)، ثم مجموعة التكاملات (Integrations)، ثم مفاتيح API (API Keys). تعرض الصفحة كل مفتاح في الحساب مع اسمه وبادئته وحالته وآخر استخدام له وتاريخ انتهائه وتاريخ إنشائه. ويظهر في أسفل اللوحة مرجع للاستخدام يفيد من يقوم بربط النظام المُستدعي.
تعليق: سجّل الدخول بصفتك Admin أو Super Admin، ثم افتح الإعدادات (Settings)، ثم مجموعة التكاملات (Integrations)، ثم مفاتيح API (API Keys).
إنشاء مفتاح
في الحقل الموجود أعلى لوحة مفاتيح API، أدخل اسماً (Name) يوضّح النظام الذي سيستخدم المفتاح والغرض منه، ثم اختر Create API Key. سيُفتح مربع حوار يعرض قيمة المفتاح الكاملة.
انسخ المفتاح الآن واحفظه في مكانه الصحيح: مدير كلمات مرور، أو خزينة أسرار، أو مخزن الأسرار في نظام البناء لديك. تُعرض القيمة الكاملة هذه المرة فقط. إذ يحتفظ تطبيق Safety ببصمة أحادية الاتجاه للمفتاح لا بالمفتاح نفسه، فلا يستطيع أحد استرجاعه لاحقاً، ولا فريق الدعم. وإذا فُقدت القيمة، فالحل الوحيد هو إبطال ذلك المفتاح وإنشاء بديل له.
التعامل مع المفتاح بأمان
تعامل مع المفتاح كما تتعامل مع كلمة المرور، لأنه يعمل عملها. لا تلصقه في رسالة بريد إلكتروني أو محادثة، ولا تُدرجه في نظام إدارة الإصدارات، ولا تضعه في أي موضع يُسلَّم منه إلى متصفح أو تطبيق جوّال حيث يمكن لمستخدم أن يقرأه. وامنح كل تكامل مفتاحه الخاص بدلاً من مشاركة مفتاح واحد بين عدة أنظمة: فعند مشاركة مفتاح واحد، يؤدي إبطاله لمعالجة مشكلة في نظام واحد إلى تعطيل بقية الأنظمة في الوقت نفسه.
قراءة القائمة لتحديد المفاتيح التي لم تعد لازمة
عمود آخر استخدام (Last Used) هو أنفع ما في هذه الصفحة للحفاظ على النظافة الأمنية المستمرة. فالمفتاح الذي لم يُستخدم منذ شهر يكون عادةً مفتاحاً لتكامل أُوقف، وكل مفتاح من هذا النوع هو صلاحية وصول قائمة بلا سبب. راجع القائمة شهرياً وأبطل كل ما لم يبقَ له غرض. ويساعدك عمود البادئة (Prefix) هنا، إذ يتيح لك التأكد من القيمة المحفوظة التي يقابلها كل صفّ قبل أن تتخذ إجراءً بشأنه.
إعادة تسمية مفتاح وإلغاء تنشيطه
اختر أيقونة التحرير المجاورة للمفتاح لإعادة تسميته. لا تُغيّر إعادة التسمية شيئاً في قيمة المفتاح ولا في صلاحياته، لذا فهي آمنة في أي وقت وتستحق أن تُجرى بمجرد أن يتوقف الاسم عن وصف الواقع.
واختر مفتاح التبديل لإلغاء تنشيط مفتاح دون حذفه. تُرفض الطلبات التي تستخدم مفتاحاً غير مُنشَّط فوراً، لكن الصفّ يبقى في القائمة لأغراض التدقيق، ويمكنك إعادة تنشيطه لاحقاً. وإلغاء التنشيط هو الأداة المناسبة عندما تشتبه في وجود مشكلة لكنك لم تتأكد بعد من النظام الذي يتبعه المفتاح: فهو يوقف الوصول على الفور مع إبقاء السجل سليماً والقرار قابلاً للرجوع عنه.
إبطال مفتاح والتغيير إلى بديل
اختر أيقونة الحذف لإبطال مفتاح نهائياً. ويفقد كل ما يستخدمه القدرة على إثبات هويته فوراً، ولا يمكن الرجوع عن الإبطال.
ولتغيير مفتاح دون انقطاع في الخدمة، أنشئ البديل أولاً، وحدّث النظام المستخدِم ليعتمده، وتأكّد من أن المفتاح الجديد يعمل، وبعد ذلك فقط أبطل القديم. وغيّر المفاتيح وفق جدول منتظم لا في حالات الطوارئ وحدها، وغيّرها فوراً كلما ترك الفريق شخص كان يملك صلاحية الوصول إلى مفتاح. أما تحديد تاريخ انتهاء للمفاتيح التي تستخدمها الأنظمة الآلية، فيحوّل هذا التغيير الدوري إلى أمر يفرضه الحساب لا أمر يتعيّن على شخص أن يتذكّره.
الخاتمة
إنشاء مفتاح API أمر سريع؛ والعناية تكمن في ما يأتي بعده. سمِّ كل مفتاح باسم النظام الذي يستخدمه، وانسخ القيمة مرة واحدة إلى تخزين أسرار سليم، واحتفظ بمفتاح واحد لكل تكامل، واستخدم عمود آخر استخدام (Last Used) للعثور على صلاحيات وصول تجاوزت الغرض منها. وعندما يحين وقت إزالة مفتاح، ألغِ تنشيطه إن احتجت إلى إيقاف قابل للرجوع، وأبطله عندما تكون على يقين، مع إنشاء البديل دائماً قبل إزالة المفتاح الذي لا يزال في الخدمة.