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

​
نظرة عامة

تتيح Twenty API للمطورين التفاعل برمجيًا مع منصة Twenty CRM. باستخدام API، يمكنك دمج Twenty مع أنظمة أخرى، وأتمتة تزامن البيانات، وبناء حلول مخصصة حول بيانات العملاء. يوفر API نقاط نهاية لـ إضافة، قراءة، تحديث، وحذف الكائنات الأساسية في CRM (مثل الأشخاص والشركات) وكذلك الوصول إلى إعدادات البيانات الوصفية. ملعب API: يمكنك الآن الوصول إلى ملعب API ضمن إعدادات التطبيق. لتجربة استدعاءات API في الوقت الفعلي، قم بتسجيل الدخول إلى مساحة عمل Twenty الخاصة بك وانتقل إلى الإعدادات → واجهات برمجة التطبيقات وWebhooks. هذا يفتح ملعب API داخل التطبيق وإعدادات مفاتيح API. اذهب إلى إعدادات API

​
المصادقة

تستخدم Twenty مفاتيح API للمصادقة. يجب أن تتضمن كل طلب إلى نقاط الوصول المحمية مفتاح API في العنوان.
  • مفاتيح API: يمكنك إنشاء مفتاح API جديد من صفحة إعدادات API الخاصة بتطبيق Twenty. كل مفتاح API هو رمز سري يمنح الوصول إلى بيانات CRM الخاصة بك، لذا احتفظ به بأمان. إذا تم الكشف عن المفتاح، قم بإلغائه من الإعدادات وإنشاء مفتاح جديد.
  • رأس المصادقة: بمجرد الحصول على مفتاح API، قم بتضمينه في العنوان Authorization لطلبات HTTP الخاصة بك. استخدم نظام الرمز Bearer. على سبيل المثال: 
    Authorization: Bearer YOUR_API_KEY
    استبدل YOUR_API_KEY بالمفتاح الذي حصلت عليه. يجب أن يكون هذا العنوان موجودًا في جميع طلبات API. إذا كان الرمز مفقودًا أو غير صالح، ستستجيب API بخطأ مصادقة (HTTP 401 Unauthorized).

​
نقاط نهاية API

يمكن الوصول إلى جميع الموارد عبر REST أو GraphQL.
  • السحابة: https://api.twenty.com/ أو نطاقك المخصص / النطاق الفرعي
  • Self-Hosted Instances: If you are running Twenty on your own server, use your own domain in place of api.twenty.com (for example, https://{your-domain}/rest/).
تنقسم نقاط النهاية إلى فئتين: API الأساسي وAPI البيانات الوصفية. تتعامل واجهة برمجة التطبيقات الأساسية مع البيانات الأساسية لـ CRM (مثل الأشخاص، الشركات، الملاحظات، المهام)، بينما تغطي واجهة برمجة البيانات الوصفية بيانات التكوين (مثل الحقول المخصصة أو تعريفات الكائنات). سيستخدم معظم التكاملات بشكل أساسي واجهة برمجة التطبيقات الأساسية.

​
واجهة برمجة التطبيقات الأساسية

يتم الوصول إليها عبر /rest/ أو /graphql/. يعمل API الأساسي كواجهة موحدة لإدارة الكيانات الأساسية في CRM (الأفراد، الشركات، الملاحظات، المهام) وعلاقاتهم، حيث يوفر نموذجي تفاعل REST و GraphQL.

​
واجهة برمجة البيانات الوصفية

يتم الوصول إليها عبر /rest/metadata/ أو /metadata/. تتيح لك نقاط وصول واجهة برمجة البيانات الوصفية استرداد معلومات حول المخطط والإعدادات الخاصة بك. على سبيل المثال، يمكنك جلب تعريفات الحقول المخصصة، مخططات الكائنات، إلخ.
  • نقاط وصول أمثلة:
    • GET /rest/metadata/objects – قائمة بجميع أنواع الكائنات وبيانات الوصفية الخاصة بها (الحقول، العلاقات).
    • GET /rest/metadata/objects/{objectName} – الحصول على البيانات الوصفية لكائن محدد (مثل، people، companies).
    • GET /rest/metadata/picklists – لاسترداد خيارات حقل القوائم المنسدلة المعرفة في CRM.
عادةً ما تُستخدم نقاط وصول البيانات الوصفية لفهم هيكل البيانات (للتكامل الديناميكي أو بناء النماذج) بدلاً من إدارة السجلات الفعلية. هي للقراءة فقط في معظم الحالات. المصادقة مطلوبة لهذه أيضًا (استخدم مفتاح API الخاص بك).