תיעוד

API admin

אוטומציה של betool ממערכות שלכם — יצירת פייפליינים, קריאת היסטוריות, ניהול ארגונים.

API admin

כל ממשק הניהול של betool נגיש דרך REST API מאומתת. זהו הערוץ לאוטומציה: provisioning של ארגונים לפי דרישה, סנכרון פייפליינים מ-repo Git שלכם, dashboards מותאמים, אינטגרציית ITSM.

אימות

טוקן Bearer המונפק מניהול → טוקנים בארגון שלכם.

curl -H "Authorization: Bearer $BETOOL_TOKEN" \
  https://platform.betool.ai/api/admin/me

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

עימוד וסינון

כל endpoints הרשימה עוקבים אחר אותה קונוונציה:

  • ?limit=50 (ברירת מחדל 25, מקסימום 200)
  • ?offset=0
  • ?sort=-created_at (קידומת - לסדר יורד)
  • פילטרים ad-hoc: ?status=ok&created_after=2026-05-01

התגובה כוללת header‏ X-Total-Count לעימוד cursor-less.

Endpoints עיקריים

Endpointתיאור
GET /api/admin/meזהות, ארגון נוכחי, תפקיד
GET /api/admin/pipelinesרשימת פייפליינים
POST /api/admin/pipelinesיצירת פייפליין
PATCH /api/admin/pipelines/{id}עריכה
GET /api/admin/pipelines/{id}/executionsהיסטוריית הרצות
GET /api/admin/billing/balanceיתרת קרדיטים
POST /api/admin/billing/topupטעינה ידנית
GET /api/admin/me/content-readsיומן ביקורת גישות cross-tenant

תיעוד OpenAPI המלא זמין בכתובת /api/admin/openapi.json לאחר כניסה.

אידמפוטנטיות

ה-endpoints מסוג POST מקבלים header‏ Idempotency-Key. אם תשלחו את אותה בקשה עם אותו מפתח, תקבלו את אותה תגובה — שימושי לאסטרטגיית retry בצד הקורא.

Webhooks יוצאים

הגדירו את betool לשלוח התראות על אירועים מרכזיים (הרצה שנכשלה, יתרה נמוכה, משתמש חדש). ראו Webhooks יוצאים.

Rate limiting

כברירת מחדל:

  • 1,000 בקשות / דקה לכל טוקן
  • 100 בקשות / דקה עבור endpoints כתיבה יקרים (יצירת פייפליין, batch import)

בתוכנית Enterprise, המגבלות ניתנות להגדרה.

SDK

(עדיין) אין SDK רשמיים. ה-API פשוט מספיק לצריכה מכל שפת תכנות עם client HTTP.

אם כתבתם SDK לארגון שלכם — הודיעו לנו ונוסיף אותו לרשימה.