رابط برنامه‌نویسی (API)

هرچه در رابط کاربری انجام می‌دهید از طریق REST API هم ممکن است. API برای اتصال به سایت، حسابداری، اسکریپت و ابزارهای دیگر استفاده می‌شود.

مستندات تعاملی#

مستندات کامل (OpenAPI با رابط Scalar) روی سامانهٔ خودتان در مسیر /api/v2/docs است. از آنجا می‌توانید همهٔ مسیرها را ببینید و امتحان کنید. همچنین در نمای جدولی، API (در نوار ابزار) نمونه کد آمادهٔ همان جدول را نشان می‌دهد.

احراز هویت#

در هدر Authorization یک توکن شخصی بفرستید:

Authorization: Bearer <TOKEN>

چند نمونه#

خواندن رکوردهای یک جدول:

curl -H "Authorization: Bearer $TOKEN" \
  "https://YOUR_HOST/api/table/tblXXXX/record?take=50"

افزودن رکورد (با تبدیل خودکار نوع مقدارها):

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  "https://YOUR_HOST/api/table/tblXXXX/record" \
  -d '{"typecast": true, "records": [{"fields": {"نام": "علی رضایی", "موبایل": "09121234567"}}]}'

ویرایش رکورد:

curl -X PATCH -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  "https://YOUR_HOST/api/table/tblXXXX/record/recXXXX" \
  -d '{"typecast": true, "record": {"fields": {"وضعیت": "پرداخت‌شده"}}}'

رابط‌های ویژهٔ ایران#

محدودیت‌ها#

درخواست‌ها محدودیت نرخ دارند و دسترسی بر اساس مجوزهای توکن و نقش کاربر است. برای کارهای حجیم از وارد کردن فایل یا درخواست‌های دسته‌ای (چند رکورد در یک درخواست) استفاده کنید.