تخط وانتقل إلى المحتوى الرئيسي

كيفية إنشاء وإدارة مفاتيح واجهة برمجة التطبيقات (API)

ملخص

تسمح مفاتيح واجهة برمجة التطبيقات (API Keys) لتطبيقاتك، وبرامجك النصية، وخدمات الواجهة الخلفية بالوصول الآمن إلى Astra APIs دون الحاجة إلى تسجيل دخول المستخدم عبر الواجهة الويب في كل مرة. تشرح هذه المقالة ما هي مفاتيح واجهة برمجة التطبيقات (API Keys)، وكيفية إنشائها واستخدامها، وكيفية إدارة أو إلغاء المفاتيح الحالية.

تعليمات

ما هو مفتاح واجهة برمجة التطبيقات (API Key)؟

مفتاح واجهة برمجة التطبيقات (API Key) هو بيانات اعتماد سرية تبدأ بـ sk_live_. يسمح لتطبيقك بالمصادقة وإجراء طلبات إلى Astra APIs برمجيًا.

تُستخدم مفاتيح واجهة برمجة التطبيقات (API Keys) بشكل شائع عندما تحتاج إلى اتصال من نظام إلى نظام يعمل تلقائيًا دون تفاعل المستخدم.

حالات الاستخدام الموصى بها

مفاتيح واجهة برمجة التطبيقات (API Keys) مثالية عندما تريد:

  • مزامنة العملاء المحتملين المؤهلين من Astra إلى نظام إدارة علاقات العملاء (CRM) الخاص بك تلقائيًا.

  • إنشاء لوحات تحكم مخصصة عن طريق سحب بيانات المحادثات والعملاء المحتملين من Astra.

  • تشغيل سير عمل الأعمال عند التقاط وكيل الذكاء الاصطناعي لعميل محتمل جديد.

  • إرسال بيانات المحادثات إلى أنظمة التحليلات أو التقارير الداخلية.

متى لا تستخدم مفاتيح واجهة برمجة التطبيقات (API Keys)

لا يُنصح باستخدام مفاتيح واجهة برمجة التطبيقات (API Keys) للتطبيقات المواجهة للجمهور حيث يحتاج كل مستخدم إلى منح الإذن بالوصول إلى حسابه الخاص.

في هذه الحالات، استخدم مصادقة OAuth بدلاً من ذلك.

كيفية إنشاء مفتاح واجهة برمجة التطبيقات (API Key)

لإنشاء مفتاح واجهة برمجة تطبيقات (API Key) جديد:

  • قم بتسجيل الدخول إلى حساب Astra الخاص بك.

  • انتقل إلى الحساب > مفاتيح واجهة برمجة التطبيقات (API Keys).

  • انقر فوق إنشاء مفتاح.

  • أدخل اسمًا وصفيًا للمفتاح، مثل مزامنة نظام إدارة علاقات العملاء (CRM) للإنتاج.

  • انقر فوق إنشاء.

هام: احفظ مفتاح واجهة برمجة التطبيقات (API Key) الخاص بك فورًا

  • بعد إنشاء المفتاح، يعرض Astra مفتاح واجهة برمجة التطبيقات (API Key) الكامل مرة واحدة فقط.

  • تأكد من نسخ المفتاح وتخزينه في مكان آمن قبل إغلاق الإشعار أو مغادرة الصفحة.

بعد ذلك، سيعرض Astra فقط بادئة مختصرة للمفتاح لأغراض التعريف. لا يمكن عرض المفتاح الكامل مرة أخرى.

كيفية استخدام مفتاح واجهة برمجة التطبيقات (API Key)

بعد إنشاء مفتاح واجهة برمجة التطبيقات (API Key)، قم بإضافته إلى تطبيقك، أو البرنامج النصي، أو التكامل الخاص بك.

عند إجراء طلبات واجهة برمجة التطبيقات (API requests)، قم بتضمين المفتاح في رأس المصادقة للطلب، عادةً كرمز وصول (Bearer token).

بمجرد التكوين، يمكن لتطبيقك الوصول بأمان إلى Astra APIs دون الحاجة إلى قيام المستخدمين بتسجيل الدخول عبر المتصفح.

إدارة مفاتيح واجهة برمجة التطبيقات (API Keys) الحالية

تعرض صفحة مفاتيح واجهة برمجة التطبيقات (API Keys) معلومات حول جميع المفاتيح النشطة.

العمود

الوصف

الاسم

الاسم المعين لمفتاح واجهة برمجة التطبيقات (API Key) أثناء الإنشاء

بادئة المفتاح

الأحرف القليلة الأولى من مفتاح واجهة برمجة التطبيقات (API Key)، المستخدمة لتحديد المفتاح

تم الإنشاء

التاريخ والوقت الذي تم فيه إنشاء المفتاح

آخر استخدام

آخر مرة تم فيها استخدام المفتاح؛ يبقى فارغًا إذا لم يتم استخدام المفتاح مطلقًا

كيفية إلغاء مفتاح واجهة برمجة التطبيقات (API Key)

قد تحتاج إلى إلغاء مفتاح واجهة برمجة التطبيقات (API Key) إذا:

  • تم الكشف عن المفتاح أو مشاركته عن غير قصد

  • لم يعد التكامل مطلوبًا

  • غادر عضو في الفريق لديه وصول إلى المفتاح المنظمة

  • تجري تدوير بيانات الاعتماد كجزء من عملية أمنية

لإلغاء مفتاح واجهة برمجة التطبيقات (API Key):

  • حدد موقع المفتاح في قائمة مفاتيح واجهة برمجة التطبيقات (API Keys).

  • انقر فوق خيار حذف.

  • قم بتأكيد الإجراء.

ماذا يحدث بعد الإلغاء؟

يصبح مفتاح واجهة برمجة التطبيقات (API Key) غير صالح على الفور.

أي تطبيق، أو برنامج نصي، أو تكامل يستخدم هذا المفتاح لن يكون قادرًا على الوصول إلى Astra APIs حتى يتم تكوين مفتاح جديد صالح.

أفضل ممارسات الأمان عند العمل مع مفاتيح واجهة برمجة التطبيقات (API Keys)

اتبع هذه التوصيات للحفاظ على أمان مفاتيح واجهة برمجة التطبيقات (API Keys) الخاصة بك:

  • لا تقم أبدًا بتضمين مفاتيح واجهة برمجة التطبيقات (API Keys) في التعليمات البرمجية الواجهة الأمامية أو الواجهة الأمامية للعميل.

  • قم بتخزين مفاتيح واجهة برمجة التطبيقات (API Keys) في مدير أسرار آمن أو متغير بيئة.

  • استخدم مفاتيح واجهة برمجة تطبيقات (API Keys) منفصلة لبيئات الاختبار والإنتاج.

  • قم بتدوير مفاتيح واجهة برمجة التطبيقات (API Keys) بانتظام.

  • قم بإلغاء المفاتيح غير المستخدمة أو القديمة.

  • إذا تم اختراق مفتاح واجهة برمجة التطبيقات (API Key)، قم بإلغائه فورًا وأنشئ مفتاحًا جديدًا.

هل أجاب هذا عن سؤالك؟