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

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

لا توجد مرجعية ثابتة لواجهة برمجة التطبيقات الخاصة بـ Twenty. لكل مساحة عمل مخططها الخاص — عند إضافة كائن مخصص (مثل Invoice)، يحصل فورًا على نقاط نهاية REST وGraphQL مطابقة لتلك الخاصة بالكائنات المدمجة مثل Company أو Person. تُولَّد واجهة برمجة التطبيقات من المخطط، لذا تستخدم نقاط النهاية أسماء الكائنات والحقول لديك مباشرة — بدون معرّفات غامضة. وثائق واجهة برمجة التطبيقات الخاصة بمساحة عملك متاحة ضمن الإعدادات → واجهات برمجة التطبيقات وخطافات الويب بعد إنشاء مفتاح API. يتضمن ساحة تجريبية تفاعلية يمكنك من خلالها تنفيذ استدعاءات حقيقية على بياناتك.

واجهتا برمجة تطبيقات

واجهة برمجة التطبيقات الأساسية/rest/ و/graphql/ عمليات CRUD على السجلات: الأشخاص، الشركات، الفرص، وكائناتك المخصصة. استعلام، تصفية، والتنقل عبر العلاقات. واجهة برمجة تطبيقات البيانات الوصفية/rest/metadata/ و/metadata/ إدارة المخطط: إنشاء/تعديل/حذف الكائنات والحقول والعلاقات. هذه هي الطريقة لتغيير نموذج بياناتك برمجيًا. كلاهما متاحان عبر REST وGraphQL. تضيف GraphQL عمليات upsert على دفعات وإمكانية التنقل عبر العلاقات في استعلام واحد. نفس البيانات الأساسية بأي من الطريقتين.

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

البيئةعنوان URL الأساسي
السحابةhttps://api.twenty.com/
الاستضافة الذاتيةhttps://{your-domain}/

المصادقة

Authorization: Bearer YOUR_API_KEY
أنشئ مفتاح API من الإعدادات → واجهات برمجة التطبيقات وخطافات الويب → + Create key. انسخه فورًا — يُعرَض مرة واحدة فقط. يمكن تقييد نطاق المفاتيح بدور محدد ضمن الإعدادات → الأدوار → علامة التبويب Assignment للحد مما يمكنها الوصول إليه. للوصول المعتمد على OAuth (تطبيقات خارجية تتصرف نيابةً عن المستخدمين)، راجع OAuth.

عمليات الدفعات

يدعم كلٌّ من REST وGraphQL التجميع لما يصل إلى 60 سجلًا لكل طلب — إنشاء أو تحديث أو حذف. كما تدعم GraphQL عملية upsert على دفعات (إنشاء-أو-تحديث في استدعاء واحد) باستخدام أسماء جمع مثل CreateCompanies.

حدود المعدل

الحدالقيمة
الطلبات100 استدعاء في الدقيقة
حجم الدفعة60 سجل لكل استدعاء