התחברותהרשמה בחינם

הגדרת סוכן בינה מלאכותית

שתפו כתובת גילוי אחת עם Claude Code, Codex או OpenClaw. הסוכן יקרא את תגובת הגילוי, יאמת את הקוד בן 8 הספרות, ישמור את ה-ApiKey ארוך הטווח שלו ויתחיל לעבוד עם סביבת העבודה שלכם.

הקישור שצריך לתת לסוכן

שתפו את הכתובת המדויקת הזו:

https://api.expense-budget-tracker.com/v1/

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

מדריך זה מתאר התחברות ישירה דרך Agent API עבור סוכני מסוף ולקוחות HTTP. אם הלקוח שלכם תומך ב-MCP, השתמשו במקום זאת ב-מחבר ה-MCP המתארח; הוא מתחבר אל https://mcp.expense-budget-tracker.com/mcp ומקבל הרשאה אינטראקטיבית דרך OAuth בדפדפן, בלי תהליך יצירת ה-ApiKey המתואר כאן.

מה המשתמש עושה

  1. פתחו את Claude Code, את Codex, את OpenClaw, או כל סוכן אחר שיכול לבצע בקשות HTTP.
  2. אמרו לסוכן להתחבר ל-Expense Budget Tracker באמצעות https://api.expense-budget-tracker.com/v1/.
  3. כשהסוכן מבקש כתובת אימייל, ספקו את כתובת האימייל שבה אתם משתמשים ב-Expense Budget Tracker.
  4. בדקו את תיבת הדואר הנכנס שלכם וחפשו את הקוד בן 8 הספרות.
  5. שלחו את הקוד הזה בחזרה לסוכן.
  6. אפשרו לסוכן לשמור את ה-ApiKey שהוחזר מחוץ לזיכרון הצ'אט, ואז להמשיך למשימת הייבוא, השאילתה או ניהול התקציב שלכם.

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

מה הסוכן עושה

הרצף המלא הוא:

  1. GET https://api.expense-budget-tracker.com/v1/
  2. לקרוא את תגובת הגילוי ולפעול לפי הפעולות שמוחזרות בה, במקום לקודד מראש את השלבים הבאים
  3. לשלוח את אימייל המשתמש ב-POST אל bootstrapUrl שהוחזר
  4. לקבל את otpSessionToken ואת הפעולה verify_code
  5. לבקש מהמשתמש את קוד האימייל בן 8 הספרות
  6. לשלוח ב-POST את code, את otpSessionToken ואת label של החיבור אל https://auth.expense-budget-tracker.com/api/agent/verify-code
  7. לקבל ApiKey חדש
  8. לשמור את המפתח הזה מחוץ לזיכרון הצ'אט, רצוי תחת EXPENSE_BUDGET_TRACKER_API_KEY
  9. לשלוח GET https://api.expense-budget-tracker.com/v1/me עם Authorization: ApiKey <key>
  10. לשלוח GET https://api.expense-budget-tracker.com/v1/workspaces
  11. במידת הצורך, ליצור סביבת עבודה עם POST /v1/workspaces
  12. לשמור סביבת עבודה כברירת מחדל עם POST /v1/workspaces/{workspaceId}/select
  13. לבדוק אילו קשרים מותרים עם GET https://api.expense-budget-tracker.com/v1/schema
  14. לקרוא נתונים דרך POST https://api.expense-budget-tracker.com/v1/sql/query ולשלוח כתיבות שאושרו דרך POST https://api.expense-budget-tracker.com/v1/sql/execute

בחירת סביבת העבודה היא פעולה מפורשת, אבל לא פעולה חסרת מצב. סביבת העבודה שנבחרה נשמרת עבור אותו מפתח API אחרי POST /v1/workspaces/{workspaceId}/select, ולכן בבקשות עתידיות אל /v1/sql/query ו-/v1/sql/execute אפשר להשמיט את X-Workspace-Id. עדיין אפשר לשלוח X-Workspace-Id כדי לעקוף את סביבת העבודה השמורה בבקשה מסוימת. נקודת התאימות POST /v1/sql מיועדת רק לסקריפטים אטומיים מרובי פקודות, ולא לקריאה או כתיבה רגילות.

אם למשתמש יש בדיוק סביבת עבודה אחת, ועדיין לא נשמרה בחירה עבור אותו מפתח, השרת ישמור אותה אוטומטית וישתמש בה.

מה הסוכן צריך לשמור

המפתח שמוחזר מ-verify-code הוא מפתח ארוך טווח. אל תסתמכו רק על זיכרון הצ'אט.

  • אם המשתמש מאשר כתיבה לקבצים, שמרו אותו בקובץ .env מקומי תחת EXPENSE_BUDGET_TRACKER_API_KEY='<PASTE_KEY_HERE>'
  • אחרת, ייצאו אותו במעטפת הנוכחית בתור EXPENSE_BUDGET_TRACKER_API_KEY='<PASTE_KEY_HERE>' ובקשו מהמשתמש לשמור אותו במקום קבוע

בקשות מאומתות משתמשות ב:

  • Authorization: ApiKey <key>
  • X-Workspace-Id: <workspaceId> רק אם רוצים לעקוף את סביבת העבודה השמורה או לפני שנשמרה בחירה כלשהי

אם אתם סוכן בינה מלאכותית

התחילו עם:

curl https://api.expense-budget-tracker.com/v1/

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

אחרי verify-code, שמרו את ה-ApiKey שהוחזר בצורה מאובטחת. לאחר מכן טענו:

  • /v1/me כדי לקבל את פרטי החשבון
  • /v1/workspaces כדי לקבל את סביבות העבודה הזמינות
  • /v1/schema כדי לקבל את הקשרים והעמודות המותרים ב-SQL
  • /v1/openapi.json או /v1/swagger.json רק כאשר לקוח בודק כתובות מפרט מקובלות; הן מחזירות קישורים לגילוי ולקוד המקור, לא מפרט API

דוגמאות להנחיות שאפשר לתת לסוכן

Claude Code

התחבר ל-Expense Budget Tracker באמצעות https://api.expense-budget-tracker.com/v1/.
השתמש בכתובת האימייל של החשבון שלי כשצריך, בקש ממני את הקוד בן 8 הספרות, שמור את ה-ApiKey שמוחזר מחוץ לזיכרון הצ'אט, ואז ייבא את תדפיס הבנק האחרון שלי מתוך ~/Downloads.

Codex

השתמש ב-https://api.expense-budget-tracker.com/v1/ כדי להתחבר לחשבון Expense Budget Tracker שלי.
בקש את כתובת האימייל שלי, המתן לקוד שמגיע באימייל, שמור את המפתח, בדוק את /schema ואז הצג לי את העסקאות האחרונות שלי.

OpenClaw

התחבר ל-Expense Budget Tracker דרך https://api.expense-budget-tracker.com/v1/.
אחרי ההתחברות, הצג את סביבות העבודה שלי, שמור אחת מהן כברירת המחדל עבור המפתח הזה וייבא את קובץ ה-CSV החדש שהעליתי.

מה אפשר לעשות אחרי ההגדרה

  • לייבא תדפיסי בנק או ייצואי כרטיסי אשראי
  • לסווג עסקאות לפי הקטגוריות הקיימות שלכם
  • לאמת יתרות חשבון מול הבנק
  • להריץ שאילתות על ההוצאות לפי קטגוריה, תקופה, בית עסק או חשבון
  • לעדכן שורות תקציב לחודש הבא

לפרטי נקודות הקצה ברמה הנמוכה יותר ולפרטי האימות, ראו מדריך ה-API.