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

نظرة عامة على API

تتضمن وحدة Perfex CRM SaaS REST API تتيح لك إدارة منصة SaaS الخاصة بك برمجياً. هذا مفيد لـ:

  • صفحات تسجيل مخصصة - إنشاء تدفق التسجيل الخاص بك
  • تكاملات الطرف الثالث - الاتصال بأدوات خارجية (Zapier، Integromat، تطبيقات مخصصة)
  • أتمتة الفوترة - مزامنة مع أنظمة الفوترة الخارجية
  • المراقبة - إنشاء لوحات تحكم وأدوات مراقبة مخصصة
  • تطبيقات الهاتف المحمول - إنشاء واجهات إدارة للجوال

البدء مع API​

الخطوة 1: تفعيل API​

  1. انتقل إلى SaaS Management → SuperAdmin Settings
  2. انقر على تبويب API Settings
  3. قم بتشغيل API ON
  4. قم بإنشاء رمز API

الخطوة 2: المصادقة​

جميع طلبات API تتطلب المصادقة عبر رمز Bearer في رأس الطلب:

Authorization: Bearer YOUR_API_TOKEN_HERE

الخطوة 3: عنوان URL الأساسي​

عنوان URL الأساسي لـ API الخاص بك هو:

https://yoursite.com/api/saas/

استبدل yoursite.com بنطاقك الفعلي.

مثال سريع​

إليك مثال سريع لإنشاء مستأجر عبر API:

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

قدرات API​

مجموعة نقاط النهايةما يمكنك فعله
Tenantsإنشاء، قراءة، تحديث، حذف المستأجرين
Plansعرض، إنشاء، تحديث الخطط
Subscriptionsإدارة اشتراكات المستأجرين
Usageاستعلام عن استخدام المستأجر والحصص

للقائمة الكاملة لنقاط النهاية، راجع API Reference.

تحديد المعدل​

ينفذ API تحديد المعدل لحماية خادمك:

  • 100 طلب في الدقيقة لكل رمز API
  • يتم تضمين رؤوس حد المعدل في كل استجابة

إذا تجاوزت حد المعدل، ستتلقى استجابة 429 Too Many Requests.

أفضل الممارسات​

  1. احتفظ برمز API سرياً - لا تعرضه أبداً في كود العميل أو المستودعات العامة
  2. استخدم HTTPS - قم دائماً بطلبات API عبر HTTPS
  3. تعامل مع الأخطاء بشكل صحيح - تحقق من رموز حالة الاستجابة وتعامل مع الأخطاء بشكل مناسب
  4. الاستخدام المؤقت عند الإمكان - لا تستعلم عن نفس البيانات مراراً وتكراراً؛ استخدم التخزين المؤقت للاستجابات التي لا تتغير غالباً
معلومات

هل تحتاج تكامل مخصص؟ إذا لم يغطي API حالة الاستخدام الخاصة بك، تواصل معنا عبر support. نحن نوسع API باستمرار بناءً على ملاحظات العملاء.

API Reference