نظرة عامة على API

يساعدك هذا القسم على بدء استخدام Teable API بسرعة وأمان.

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

Teable السحابية: https://app.teable.ai
الاستضافة الذاتية: استخدم نطاقك الخاص (على سبيل المثال https://teable.example.com)

جميع مسارات API في هذه الوثائق مرتبطة بعنوان URL الأساسي وتبدأ بـ /api.

تستخدم واجهات Teable API رموز Bearer:

curl -H 'Authorization: Bearer __token__' \
  'https://app.teable.ai/api/table/__tableId__/record'

يمكنك استخدام أحد الخيارين التاليين:

رمز الوصول الشخصي: الأنسب للنصوص البرمجية والأدوات الداخلية وعمليات التكامل من جانب الخادم. راجع رمز الوصول.
رمز وصول OAuth: الأنسب لعمليات التكامل متعددة المستأجرين التي يمنح فيها المستخدمون النهائيون حق الوصول. راجع تطبيق OAuth.

تتطلب معظم نقاط النهاية معرّفات مثل tbl... وrec.... راجع الحصول على المعرّفات.

تُقيّد رموز الوصول الشخصية ورموز OAuth بنطاقات أذونات محددة. إذا تلقيت الخطأ 403، فهذا يعني عادةً أن الرمز لا يتضمن النطاق المطلوب.

تدعم العديد من نقاط النهاية التي تعرض قوائم ما يلي:

take: عدد العناصر المطلوب إرجاعها (تضع بعض نقاط النهاية حدًا أقصى لهذا العدد؛ فمثلًا، الحد الأقصى للسجلات هو 100 لكل طلب، لذا تنقّل بين الصفحات باستخدام skip)
skip: عدد العناصر المطلوب تخطيها

تتيح لك بعض واجهات API التحكم في كيفية تمثيل حقول السجلات:

للاطلاع على بُنى قيم حقول السجلات، راجع واجهة حقول السجلات.