קביעת הדגמההרשמה בחינםהרשמההתחברות

REST API

בנו על גבי הפרויקטים שלכם ב-Skimle

נקודות קצה של JSON לקריאה ולכתיבה של נתוני פרויקט ולהרצת פרויקט מקצה לקצה. מזדהים עם מפתח Bearer, שולחים action ומקבלים JSON בחזרה.

מתחילים בשלושה שלבים

מאפס ועד הקריאה המאומתת הראשונה.

1

יצירת מפתח API

מפתח פרויקט ניגש לפרויקט אחד. מפתח חשבון ניגש לצוות אחד ויכול ליצור בו פרויקטים. שניהם זמינים ברמות קריאה ועריכה.

  1. 1. פתחו את דף מפתחות ה-API
  2. 2. בחרו את הפרויקט שהמפתח ייגש אליו ובחרו גישת קריאה או עריכה
  3. 3. העתיקו את המפתח, Skimle שומר רק את ה-hash שלו

העתיקו את המפתח מיד.

ערך המפתח המלא מוצג פעם אחת ביצירה. אחרי שסוגרים את החלון נשאר אצלנו רק ה-hash, ומפתח שאבד צריך להנפיק מחדש.

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 ללקוחות מבוססי סוכנים.

יצירת מפתח APIלהשתמש ב-MCP במקום