REST API

روی پروژه‌های Skimle خود بسازید

نقاط پایانی JSON برای خواندن و نوشتن دادهٔ پروژه و اجرای یک پروژه از آغاز تا پایان. با کلید Bearer احراز هویت کنید، یک action بفرستید و JSON دریافت کنید.

در سه گام شروع کنید

از صفر تا نخستین فراخوانی احراز هویت‌شده.

1

ساخت کلید API

کلید پروژه به یک پروژه دسترسی دارد. کلید حساب به یک تیم دسترسی دارد و می‌تواند در آن پروژه بسازد. هر دو در سطح خواندن و ویرایش ارائه می‌شوند.

  1. 1. صفحهٔ کلیدهای API را باز کنید
  2. 2. پروژه‌ای را که کلید باید به آن دسترسی داشته باشد و سطح خواندن یا ویرایش را انتخاب کنید
  3. 3. کلید را کپی کنید؛ Skimle فقط هش آن را نگه می‌دارد

کلید را فوراً کپی کنید.

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

2

نخستین درخواست خود را بفرستید

کلید را به‌عنوان توکن Bearer و action را در بدنهٔ JSON بفرستید. همهٔ نقاط پایانی JSON می‌گیرند و JSON برمی‌گردانند.

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

کلیدهای خواندن به r و کلیدهای ویرایش به e ختم می‌شوند. کلیدهای پروژه /api/skimle-read و /api/skimle-write را فرامی‌خوانند. کلیدهای حساب /api/skimle-account را فرامی‌خوانند.

3

مرجع API را باز کنید

همهٔ نقاط پایانی را با توضیح، شکل درخواست و پنل آزمایش مرور کنید. هر مسیر بدنه‌ای از نوع discriminated union با کلید action می‌پذیرد.

مشخصات خام OpenAPI 3.1 در این نشانی در دسترس است: /api/openapi.json.

آمادهٔ ساختن هستید؟

کلیدهای پروژهٔ خود را مدیریت کنید یا سرور MCP را برای کلاینت‌های عامل‌محور ببینید.