تخطَّ إلى المحتوى
PrimoCRMPrimoCRM Docs

REST API

تقوم إضافة PrimoCRM بتسجيل مسارات REST الخاصة بها تحت نطاق primocrm/v1 عند خطاف rest_api_init. يستخدم تطبيق لوحة التحكم نقاط النهاية نفسها، لذا فإن أي إجراء تقوم به واجهة المستخدم يصبح متاحاً للبرمجة.

عنوان URL الأساسي

Section titled “عنوان URL الأساسي”
https://yoursite.com/wp-json/primocrm/v1/

المصادقة

Section titled “المصادقة”

تحتوي كل نقطة نهاية على رد نداء للتحقق من الأذونات يتحقق من قدرة WordPress، لذلك يجب أن يكون المُرسل معتمداً ومُصرحاً له.

  • من تطبيق لوحة التحكم (نفس المصدر): تتم مصادقة الطلبات بواسطة الجلسة المُسجلة ورمز أمان REST. يرسل WordPress رمز الأمان في ترويسة X-WP-Nonce. هذا يحدث تلقائياً للكود الذي يعمل داخل لوحة التحكم.
  • من كود خارجي: استخدم طريقة مصادقة يقبلها WordPress لواجهة برمجة تطبيقات REST، مثل كلمات مرور التطبيقات، مع مستخدم يمتلك القدرة المطلوبة. تضيف PrimoCRM Pro مفاتيح API مخصصة للوصول البرمجي.

تتطلب نقاط النهاية التي تدير الإعدادات، أو الإرسال، أو العمليات التدميرية صلاحيات بمستوى مدير. تتطلب عمليات القراءة وجهات الاتصال الروتينية صلاحية الوصول إلى CRM.

نقاط النهاية النموذجية

Section titled “نقاط النهاية النموذجية”

القائمة أدناه هي عينة نموذجية وليست شاملة. استكشف المجموعة الكاملة من علامة تبويب الشبكة في المتصفح أثناء استخدام تطبيق لوحة التحكم، نظراً لأن واجهة المستخدم تستخدم نفس المسارات.

جهات الاتصال

Section titled “جهات الاتصال”
الطريقة المسار الغرض
GET /contacts سرد جهات الاتصال (يدعم التصفح والفلترة)
POST /contacts إنشاء جهة اتصال
GET /contacts/{id} الحصول على جهة اتصال واحدة
PUT /contacts/{id} تحديث جهة اتصال
DELETE /contacts/{id} حذف جهة اتصال
POST /contacts/bulk-action تطبيق إجراء جماعي على العديد من جهات الاتصال
POST /contacts/bulk-delete حذف العديد من جهات الاتصال
GET /contacts/statuses سرد الحالات المتاحة
GET /contacts/{id}/activities سجل نشاط جهة الاتصال
GET /contacts/{id}/emails رسائل البريد الإلكتروني المرسلة إلى جهة الاتصال

الأتمتة

Section titled “الأتمتة”
الطريقة المسار الغرض
GET /automations/triggers جميع المشغلات المسجلة
GET /automations/actions جميع الإجراءات المسجلة
GET /automations/condition-options الحقول والمعاملات الخاصة بمنشئ الشروط

النماذج والرموز الذكية

Section titled “النماذج والرموز الذكية”
الطريقة المسار الغرض
GET /forms/field-types جميع أنواع حقول النماذج المسجلة
GET /smart-codes كتالوج علامات التخصيص

تقوم الحملات، والسلاسل، والقوائم، والوسوم، والقوالب، والهجرة، والإعدادات بعرض مساراتها الخاصة تحت نفس النطاق، باتباع نمط وحدة التحكم نفسه.

طلب مثال

Section titled “طلب مثال”

إنشاء جهة اتصال باستخدام مصادقة كلمة مرور التطبيق:

Terminal window
curl -X POST https://yoursite.com/wp-json/primocrm/v1/contacts \
  -u "admin:APPLICATION_PASSWORD" \
  -H "Content-Type: application/json" \
  -d '{"email":"ada@example.com","first_name":"Ada","status":"subscribed"}'

شكل الاستجابة

Section titled “شكل الاستجابة”

تُرجِع الاستجابات الناجحة بيانات بتنسيق JSON. تُرِجع الأخطاء نص JSON يحتوي على message (رسالة) يمكنك عرضها على المستخدم، وحالة HTTP توضح الخطأ الذي حدث: 400 للإدخالات التي ترفضها نقطة النهاية، و 401 أو 403 عندما لا يكون الطلب مُصرحاً به (لم يتم تسجيل الدخول، أو تفقد الصلاحية)، و 404 عندما لا يكون العنصر موجوداً.

لا توجد قيود على خطط PrimoCRM ولا توجد نقاط نهاية مُغلقة. المسار الذي تضيفه إضافة أخرى، مثل تلك الخاصة بـ PrimoCRM Pro، لا يوجد إلا أثناء تفعيل تلك الإضافة؛ وبدونها يُرجِع المسار 404. حفظ شيء لا توفره أي جهة على الموقع، على سبيل المثال مشغل أتمتة لم يتم تثبيت إضافته أو مزود بريد غير مسجل، يتم رفضه بـ 400 مع رسالة توضح ذلك.