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

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

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

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

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

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

​
المصادقة

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

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

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

​
تحديد الحقول (REST)

تقبل نقاط نهاية سجلات REST مَعلمة الاستعلام fields لإرجاع الحقول التي تحتاجها فقط:
  • يتم إرجاع id دائمًا.
  • تُحدَّد الحقول المركبة (مثل emails أو name) كاملةً باسم الحقل الخاص بها.
  • يُرجع حقل العلاقة متعدد-إلى-واحد عمود الربط الخاص به (مثل companyId) مع depth=0. لا يتم إرجاع حقول العلاقة واحد-إلى-متعدد إلا مع depth=1. باستخدام depth=1، لا يتم توسيع سوى حقول العلاقات المدرجة في fields.
  • تؤدي الحقول غير المعروفة، أو الحقول التي لا يمكن لدورك قراءتها، إلى إرجاع خطأ 400.
عند حذف fields في كائن يحتوي على أكثر من 200 حقل قابل للقراءة، يُرجع كل سجل مجموعة افتراضية من 200 حقل: id، وحقول معرّف التسمية والصورة، وcreatedAt، وupdatedAt، وdeletedAt، وposition، ثم الحقول القياسية قبل الحقول المخصصة، مرتبة حسب الاسم. مرر fields صراحةً لقراءة أي حقل يتجاوز تلك المجموعة الافتراضية.

​
حدود المعدل