مفاتيح API
مفاتيح API هي رموز Bearer تمنح وصولًا برمجيًا إلى واجهة برمجية REST الخاصة بـ LeadHub. استخدمها لبناء تكاملات مخصصة، أو مزامنة البيانات مع أنظمة أخرى، أو أتمتة المهام عبر الكود.
إنشاء مفتاح API
- انتقل إلى التكاملات ← مفاتيح API.
- انقر مفتاح API جديد.
- أكمل الحقول:
| الحقل | الوصف |
|---|---|
| الاسم | اسم وصفي (مثل: "تكامل تطبيقي"، "Zapier") |
| الصلاحيات | الإجراءات المسموح بها لهذا المفتاح (قراءة فقط، قراءة وكتابة) |
| ينتهي في | تاريخ انتهاء اختياري؛ اتركه فارغًا لعدم انتهاء الصلاحية |
- انقر حفظ.
- انسخ الرمز فورًا — يُعرض مرة واحدة فقط. إذا فقدته، يجب إعادة إنشائه.
استخدام مفتاح API
أدرج المفتاح كرمز Bearer في كل طلب API:
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
نقاط نهاية API
| الطريقة | نقطة النهاية | الوصف |
|---|---|---|
GET | /api/leads | قائمة جميع العملاء المحتملين (مع ترقيم الصفحات) |
GET | /api/leads/{id} | الحصول على عميل محتمل واحد |
POST | /api/leads | إنشاء عميل محتمل جديد |
PUT | /api/leads/{id} | تحديث عميل محتمل |
DELETE | /api/leads/{id} | حذف عميل محتمل |
GET | /api/pipelines | قائمة خطوط الأنابيب |
GET | /api/tags | قائمة الوسوم |
POST | /api/leads/{id}/tags | إضافة وسوم لعميل محتمل |
توجد مرجع API الكامل في وثائق Swagger الخاصة بـ LeadHub على /api/documentation في نظامك المثبّت.
إلغاء مفتاح
لإلغاء مفتاح API:
- انتقل إلى التكاملات ← مفاتيح API.
- انقر أيقونة الحذف في صف المفتاح وأكّد.
يُبطَل المفتاح فورًا. ستتلقى أي طلبات تستخدمه استجابة 401 Unauthorized.
أفضل ممارسات الأمان
- لا تُودِع مفاتيح API في نظام إدارة الإصدارات (GitHub، Bitbucket، إلخ)
- استخدم مفاتيح للقراءة فقط عندما تحتاج إلى قراءة البيانات فقط
- حدد تواريخ انتهاء للمفاتيح المستخدمة في تكاملات مؤقتة
- ألغِ المفاتيح فورًا إذا احتُمل كشفها
- استخدم مفتاحًا واحدًا لكل تكامل لإمكانية إلغاء كل منها بشكل مستقل