Fynchat
· فينشات مفاتيح API
أنشئ مفاتيح API وأدِرها (إنشاء، تدوير، إلغاء) للوصول إلى واجهة Fynchat البرمجية العامة عبر مصادقة Bearer.
ما هي مفاتيح API؟
تبويب مفاتيح API في الإعدادات ← التكاملات يتيح لك إنشاء مفاتيح خادمية (server-side) للوصول إلى واجهة Fynchat البرمجية العامة (Public REST API). تستخدم أنظمتك الخارجية هذه المفاتيح للمصادقة عند استدعاء الـ API. المفتاح مرتبط بحسابك (workspace) الحالي.
- عنوان الـ API الأساسي:
https://fynchat.com/api/public/v1 - المصادقة: ترويسة
Authorization: Bearer <المفتاح>
من هذا التبويب تقدر:
- إنشاء مفتاح جديد بصلاحيات محدّدة.
- تدوير مفتاح قائم (إلغاؤه وإصدار بديل بنفس الصلاحيات).
- إلغاء مفتاح لم تعد بحاجته.
الوصول إلى هذه الميزة يعتمد على باقتك. إن ظهرت لك رسالة قفل، فهي غير متاحة في باقتك الحالية وتحتاج ترقية.
إنشاء مفتاح جديد
اضغط زر مفتاح جديد أعلى القائمة لفتح نافذة الإنشاء، ثم املأ ثلاثة حقول:
| الحقل | الوصف |
|---|---|
| اسم وصفي | اسم وصفي للمفتاح (إلزامي، حتى 120 حرفاً) — مثلاً «تكامل المتجر». يظهر لاحقاً في الجدول. |
| البيئة | اختر live للإنتاج أو test للاختبار. |
| الصلاحيات | حدّد صلاحية واحدة على الأقل من قائمة الصلاحيات المجمّعة (إلزامي). |
بعد الحفظ يُنشئ النظام المفتاح ويعرضه مرّة واحدة فقط في شريط تنبيه بلون كهرماني، مع زر نسخ، وتظهر معه الرسالة:
تم إنشاء المفتاح. انسخه الآن — لن يظهر مرّة أخرى.
انسخ المفتاح فوراً واحفظه في مكان آمن. لا يخزّن النظام المفتاح الأصلي إطلاقاً — يحفظ فقط بصمة تجزئة (hash) بصيغة SHA-256 وبادئة من 12 حرفاً للعرض. بعد إغلاق الشريط لن تتمكّن من رؤية المفتاح كاملاً مرّة أخرى؛ يعرض الجدول البادئة فقط بالشكل fynk_live_aB….
يأخذ المفتاح الصيغة fynk_{البيئة}_{سلسلة عشوائية} — مثل fynk_live_... أو fynk_test_....
البيئتان: live و test
عند الإنشاء تختار بيئة المفتاح:
live— للإنتاج (الاستخدام الحقيقي).test— للاختبار أثناء التطوير.
تظهر البيئة في عمود النوع بالجدول كوسم ملوّن لكل مفتاح.
الصلاحيات (Scopes)
الصلاحيات تحدّد ما يستطيع المفتاح فعله بالضبط، وفق مبدأ أقلّ صلاحية: امنح المفتاح ما يحتاجه فقط. تُعرض 24 صلاحية موزّعة على 11 مجموعة داخل النافذة، ويوجد زر اختر الكل لتحديدها جميعاً دفعة واحدة.
| المجموعة | الصلاحية | ماذا تتيح |
|---|---|---|
| الرسائل | messages.send |
إرسال رسائل |
| الرسائل | messages.read |
قراءة الرسائل |
| الرسائل | templates.read |
قراءة القوالب |
| جهات الاتصال | contacts.read |
قراءة جهات الاتصال |
| جهات الاتصال | contacts.write |
إضافة/تعديل جهات الاتصال |
| الحملات | campaigns.read |
قراءة الحملات |
| الحملات | campaigns.write |
إنشاء/إطلاق حملات |
| السيارات | vehicles.read |
قراءة السيارات |
| السيارات | vehicles.write |
إضافة/تعديل السيارات |
| العقارات | properties.read |
قراءة العقارات |
| العقارات | properties.write |
إضافة/تعديل العقارات |
| الحجوزات | bookings.read |
قراءة الحجوزات |
| الحجوزات | bookings.write |
إنشاء حجوزات |
| الطلبات | orders.read |
قراءة الطلبات |
| الطلبات | orders.write |
تعديل الطلبات |
| تذاكر الدعم | tickets.read |
قراءة التذاكر |
| تذاكر الدعم | tickets.write |
إنشاء/تحديث التذاكر |
| العملاء (Leads) | leads.read |
قراءة العملاء المهتمين |
| العملاء (Leads) | leads.write |
إنشاء/تحديث العملاء |
| الطلبات المركزية | requests.read |
قراءة الطلبات المركزية ومراحلها |
| الطلبات المركزية | requests.write |
إنشاء/تحديث الطلبات + نقل المرحلة |
| متقدّم | flows.read |
قراءة Bot Flows |
| متقدّم | webhooks.read |
قراءة الـ webhooks |
| متقدّم | webhooks.write |
إدارة الـ webhooks |
جدول المفاتيح
تظهر كل مفاتيحك في جدول بالأعمدة التالية:
| العمود | المحتوى |
|---|---|
| الاسم | اسم المفتاح، ومعه اسم من أنشأه (بالشكل «بواسطة …»). |
| المفتاح | يعرض البادئة فقط (أول 12 حرفاً) بالشكل fynk_live_aB… — لا يظهر المفتاح كاملاً أبداً. |
| النوع | وسم live أو test (بيئة المفتاح). |
| آخر استخدام | تاريخ آخر مرة استُخدم فيها المفتاح. |
| الاستخدامات | عدد المرات التي استُخدم فيها المفتاح. |
| الحالة | ✓ نشط أو ملغى. |
لكل مفتاح نشط زرّان: دوران (لتدوير المفتاح) وإلغاء.
تدوير المفتاح (Rotate)
التدوير (زر «دوران» 🔄 في الجدول) يلغي المفتاح الحالي ويصدر بديلاً فوراً بنفس الصلاحيات ونفس البيئة، ويحمل الاسم نفسه مضافاً إليه « (rotated)». يظهر المفتاح الجديد مرّة واحدة في شريط أزرق مع زر نسخ — انسخه فوراً. استخدم التدوير عند الاشتباه في تسرّب مفتاح أو ضمن دورة تجديد دورية.
الزر محمي بتأكيد قبل التنفيذ، وتُسجَّل العملية في سجل التدقيق (audit) كحدث api_key.rotated. يمكنك إغلاق شريط الكشف بالضغط على زر الإغلاق فيه.
إلغاء المفتاح (Revoke)
الإلغاء يوقف المفتاح نهائياً (يضبط وقت الإلغاء على اللحظة الحالية). بعده يفشل أي طلب يستخدم هذا المفتاح، ولا يمكن التراجع. الزر محمي بتأكيد، وتظهر بعد الإلغاء الرسالة:
تم إلغاء المفتاح.
يبقى المفتاح الملغى ظاهراً في الجدول بحالة «ملغى»، لكن دون زرَّي التدوير والإلغاء.
استخدام المفتاح
أضف المفتاح في ترويسة Authorization مع كل طلب:
curl https://fynchat.com/api/public/v1/contacts \
-H "Authorization: Bearer fynk_live_YOUR_KEY"
الباقات والحدود
هذه الميزة مرتبطة بقدرة public_api في باقتك:
- باقة business: حتى 5 مفاتيح فعّالة.
- باقة enterprise: بلا حدّ.
- إذا كانت باقتك لا تتيح الـ API، يظهر أعلى الصفحة لوح قفل 🔒 مع زر ترقية يقودك إلى /upgrade، ويكون زر مفتاح جديد معطّلاً.
عندما تكون هناك حدود، يعرض أعلى القائمة عدد مفاتيحك الفعّالة مقارنةً بالحدّ المسموح.
نصائح
- انسخ المفتاح فور إنشائه — لن يظهر مرّة أخرى.
- امنح أقلّ الصلاحيات الممكنة لكل مفتاح.
- استخدم بيئة
testأثناء التطوير وliveللإنتاج. - دوّر المفتاح عند أي اشتباه في تسربه، وألغِ أي مفتاح لم تعد تستخدمه.