RevGlanceתיעוד

API ועוזרי AI

לקרוא את המדדים מהקוד שלך עם ה-REST API, או מ-Claude, ChatGPT ו-Cursor דרך MCP.

עוזרי AI (MCP)

RevGlance מריצה שרת MCP, כך שעוזרי AI יכולים לקרוא את המדדים עם אותן בדיקות ואותם דוחות כמו Ask. הם אף פעם לא קוראים למודל של RevGlance ואף פעם לא מנצלים שאלות.

הגדרות › עוזרי AI מציג את כתובת השרת עם השלבים לכל לקוח. בקצרה:

  1. להוסיף את RevGlance כמחבר מותאם אישית עם הכתובת מאותו עמוד, שמסתיימת ב-/mcp.
  2. להתחבר ל-RevGlance כשהעוזר מבקש. מסך ההסכמה מפרט מה הוא יכול ומה הוא לא יכול לקרוא.
  3. לשאול. כל שאילתה נשמרת כתשובה עם קישור להצגת החישוב שלה.

עבור Claude Code:

bash
claude mcp add --transport http revglance https://your-revglance-address/mcp

ואז להריץ /mcp ב-Claude Code כדי להתחבר.

העוזר מקבל ארבעה כלים לקריאה בלבד:

  • list-businesses: העסקים שיש לך הרשאה לקרוא, עם המטבע שלהם, התפקיד שלך וכל מקור עם מועד הסנכרון האחרון שלו.
  • describe-data: מה אפשר לשאול על עסק אחד: כל מדד עם המשמעות והיחידה שלו, החודשים שיש בהם נתונים, והתוכניות, מחזורי החיוב, המדינות, המקורות והמאפיינים שאפשר לסנן או לפצל לפיהם שאילתה.
  • query-metrics: מדד אחד או יותר לאורך טווח חודשים, מסוננים ומפוצלים כמו בעמודי המדדים. RevGlance בודקת כל שם, אומרת מה היא שינתה וסופרת עם אותם דוחות, ושומרת כל תשובה עם קישור להצגת החישוב.
  • explain-figure: החישוב שמאחורי נתון אחד: הנוסחה שלו מפורטת והשורות הגדולות ביותר שמרכיבות אותו. במצב פרטיות לקוחות מופיעים כתוויות קצרות.

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

REST API

REST API לקריאה בלבד בכתובת /api/v1, בתוכניות בתשלום.

  1. ליצור מפתח ב-הגדרות › מפתחות API. הוא מוצג פעם אחת בלבד.
  2. לשלוח אותו כ-bearer token: Authorization: Bearer <key>.
bash
curl https://your-revglance-address/api/v1/businesses \
  -H "Authorization: Bearer $REVGLANCE_KEY" \
  -H "Accept: application/json"

הוא מכסה עסקים, את קטלוג המדדים, מדדים עם אותם מסננים ופיצולים כמו בעמודי המדדים (כל נתון עם קישור להצגת החישוב), את ההסבר של למה, ולקוחות וחיובים עם דפדוף לפי סמן. מצב פרטיות חל כמו על המסך. כל מפתח יכול לבצע 120 בקשות בדקה, כל בקשה מתועדת בעמוד המפתחות, ומפתחות פגים אחרי שנה. מפתחות API אף פעם לא עובדים עבור MCP.

התיעוד המלא, עם כל endpoint וכל שדה, נמצא בתיעוד העזר של ה-REST API.