مرجع API

ادمج NineApps في تطبيقاتك مع واجهة برمجة تطبيقات RESTful. وصول كامل لجهات الاتصال والصفقات والحملات والمخزون والمزيد.

المصادقة

جميع طلبات API تتطلب المصادقة عبر مفتاح API. ضع مفتاحك في header المصادقة:

Authorization: Bearer YOUR_API_KEY

تقدر تنشئ وتدير مفاتيح API من لوحة التحكم بتاعتك في NineApps تحت إعدادات الحساب ← مفاتيح API.

الرابط الأساسي

جميع طلبات API لازم تتعمل على:

https://api.nineapps.com/api/v1

جميع الطلبات لازم تتعمل عبر HTTPS. الطلبات اللي بتيجي عن طريق HTTP العادي هتترفض.

نقاط النهاية

oints API المتاحة مرتّبة حسب المورد:

GET
/api/v1/contacts

عرض جميع جهات الاتصال في مساحة العمل بتاعتك

POST
/api/v1/contacts

إنشاء جهة اتصال جديدة

GET
/api/v1/contacts/:id

استرجاع جهة اتصال محددة بالمعرف

PUT
/api/v1/contacts/:id

تحديث جهة اتصال موجودة

DELETE
/api/v1/contacts/:id

حذف جهة اتصال

GET
/api/v1/deals

عرض جميع الصفقات في خط المبيعات

POST
/api/v1/deals

إنشاء صفقة جديدة

GET
/api/v1/campaigns

عرض جميع حملات البريد الإلكتروني

POST
/api/v1/campaigns

إنشاء حملة بريد إلكتروني جديدة

GET
/api/v1/inventory

عرض جميع عناصر المخزون

GET
/api/v1/invoices

عرض جميع الفواتير

POST
/api/v1/invoices

إنشاء فاتورة جديدة

صيغة الاستجابة

جميع الاستجابات بترجع بصيغة JSON. استجابة النجاح النموذجية بتبقى كده:

{ "status": "success", "data": { ... }, "meta": { "page": 1, "per_page": 25, "total": 142 } }

استجابات الخطأ بتبين حالة 'error' ورسالة بتشرح إيه اللي حصل غلط.

حدود الطلبات

طلبات API ليها حد عشان نضمن استخدام عادل:

  • الخطة المجانية: 100 طلب في الدقيقة
  • الخطة الاحترافية: 1,000 طلب في الدقيقة
  • المؤسسات: حدود مخصصة متاحة

معلومات حدود الطلبات موجودة في headers الاستجابة: X-RateLimit-Limit و X-RateLimit-Remaining و X-RateLimit-Reset.

Webhooks

اشترك في الأحداث الفورية من حسابك في NineApps. Webhooks بتبعت طلبات HTTP POST للرابط الليحدده لما الأحداث بتحصل.

الأحداث المدعومة تشمل: contact.created و contact.updated و deal.created و deal.stage_changed و invoice.created و invoice.paid والمزيد.

اعمل إعدادات Webhooks من لوحة التحكم تحت إعدادات الحساب ← Webhooks.