ملخص
تسمح مفاتيح واجهة برمجة التطبيقات (API Keys) لتطبيقاتك، ونصوصك البرمجية، وخدمات الواجهة الخلفية بالوصول بشكل آمن إلى واجهات برمجة تطبيقات Astra دون الحاجة إلى تسجيل الدخول عبر واجهة الويب في كل مرة. يشرح هذا المقال ماهية مفاتيح واجهة برمجة التطبيقات، وكيفية إنشائها واستخدامها، وكيفية إدارتها أو إلغائها.
التعليمات
ما هو مفتاح واجهة برمجة التطبيقات (API Key)؟
مفتاح واجهة برمجة التطبيقات هو اعتماد سري يبدأ بالبادئة sk_live_. وهو يسمح لتطبيقك بالمصادقة وإجراء طلبات إلى واجهات برمجة تطبيقات Astra برمجياً.
تُستخدم مفاتيح واجهة برمجة التطبيقات عادةً عندما تحتاج إلى اتصال بين الأنظمة يعمل تلقائياً دون تدخل المستخدم.
حالات الاستخدام الموصى بها
تعد مفاتيح واجهة برمجة التطبيقات مثالية عندما ترغب في:
مزامنة العملاء المحتملين المؤهلين من Astra إلى نظام إدارة علاقات العملاء (CRM) الخاص بك تلقائياً.
إنشاء لوحات تحكم مخصصة عن طريق سحب بيانات المحادثات والعملاء المحتملين من Astra.
تشغيل سير عمل تجاري عندما يقوم وكيل الذكاء الاصطناعي بالتقاط عميل محتمل جديد.
إرسال بيانات المحادثات إلى أنظمة التحليلات أو إعداد التقارير الداخلية.
متى يجب عدم استخدام مفاتيح واجهة برمجة التطبيقات
لا يُنصح باستخدام مفاتيح واجهة برمجة التطبيقات للتطبيقات الموجهة للجمهور حيث يحتاج كل مستخدم إلى منح حق الوصول إلى حسابه الخاص.
في هذه الحالات، استخدم مصادقة OAuth بدلاً من ذلك.
كيفية إنشاء مفتاح واجهة برمجة التطبيقات
لإنشاء مفتاح واجهة برمجة تطبيقات جديد:
سجّل الدخول إلى حسابك في Astra.
انتقل إلى الإعدادات > مفاتيح واجهة برمجة التطبيقات (API Keys).
انقر على إنشاء مفتاح واجهة برمجة التطبيقات (Create API Key).
أدخل اسماً وصفياً للمفتاح، مثل مزامنة CRM للإنتاج.
انقر على إنشاء (Create).
هام: احفظ مفتاح واجهة برمجة التطبيقات الخاص بك فوراً
بعد إنشاء المفتاح، تعرض Astra مفتاح واجهة برمجة التطبيقات الكامل مرة واحدة فقط.
تأكد من نسخ المفتاح وتخزينه في مكان آمن قبل إغلاق الإشعار أو مغادرة الصفحة.
بعد ذلك، ستعرض Astra بادئة مختصرة فقط للمفتاح لأغراض تحديد الهوية. لا يمكن عرض المفتاح الكامل مرة أخرى.
كيفية استخدام مفتاح واجهة برمجة التطبيقات
بعد إنشاء مفتاح واجهة برمجة التطبيقات، أضفه إلى تطبيقك أو نصك البرمجي أو تكاملك.
عند إجراء طلبات واجهة برمجة التطبيقات، قم بتضمين المفتاح في ترويسة تفويض الطلب (authorization header)، عادةً كرمز "Bearer".
بمجرد التهيئة، يمكن لتطبيقك الوصول بأمان إلى واجهات برمجة تطبيقات Astra دون الحاجة إلى قيام المستخدمين بتسجيل الدخول عبر المتصفح.
إدارة مفاتيح واجهة برمجة التطبيقات الموجودة
تعرض صفحة مفاتيح واجهة برمجة التطبيقات معلومات حول جميع المفاتيح النشطة.
العمود | الوصف |
الاسم | الاسم المعين لمفتاح واجهة برمجة التطبيقات أثناء الإنشاء |
بادئة المفتاح | الأحرف القليلة الأولى من مفتاح واجهة برمجة التطبيقات، وتستخدم لتحديد المفتاح |
تاريخ الإنشاء | تاريخ ووقت إنشاء المفتاح |
آخر استخدام | آخر وقت تم فيه استخدام المفتاح؛ يظل فارغاً إذا لم يتم استخدام المفتاح من قبل |
كيفية إلغاء مفتاح واجهة برمجة التطبيقات
قد تحتاج إلى إلغاء مفتاح واجهة برمجة التطبيقات إذا:
تم كشف المفتاح أو مشاركته عن غير قصد
لم تعد هناك حاجة إلى التكامل
غادر المؤسسة أحد أعضاء الفريق ممن لديهم حق الوصول إلى المفتاح
أنت تقوم بتدوير الاعتمادات كجزء من عملية أمنية
لإلغاء مفتاح واجهة برمجة التطبيقات:
حدد موقع المفتاح في قائمة مفاتيح واجهة برمجة التطبيقات.
انقر على خيار حذف (Delete).
قم بتأكيد الإجراء.
ماذا يحدث بعد الإلغاء؟
يصبح مفتاح واجهة برمجة التطبيقات غير صالح على الفور.
لن يتمكن أي تطبيق أو نص برمجي أو تكامل يستخدم هذا المفتاح من الوصول إلى واجهات برمجة تطبيقات Astra حتى يتم تكوين مفتاح صالح جديد.
أفضل الممارسات الأمنية عند العمل مع مفاتيح واجهة برمجة التطبيقات
اتبع هذه التوصيات للحفاظ على أمان مفاتيح واجهة برمجة التطبيقات الخاصة بك:
لا تقم أبداً بتضمين مفاتيح واجهة برمجة التطبيقات في الواجهة الأمامية أو كود جانب العميل.
قم بتخزين مفاتيح واجهة برمجة التطبيقات في مدير أسرار آمن أو متغير بيئة.
استخدم مفاتيح واجهة برمجة تطبيقات منفصلة لبيئات الاختبار والإنتاج.
قم بتدوير مفاتيح واجهة برمجة التطبيقات بانتظام.
قم بإلغاء المفاتيح غير المستخدمة أو القديمة.
إذا تم اختراق مفتاح واجهة برمجة التطبيقات، فقم بإلغائه فوراً وأنشئ مفتاحاً جديداً.