# תיעוד ה-API של UptimeScout

מצב השירות, אינדיקציות אזוריות והיסטוריה דרך REST, ערכות SDK ו־MCP. בנו לוחות מחוונים וספקו לעוזרי AI הקשר ברור לגבי זמינות.

URL: https://uptimescout.com/he/docs/

## REST

```sh
curl -G https://api.uptimescout.com/v1/status --data-urlencode "service=github" --data-urlencode "region=US" -H "Authorization: Bearer $EVELODE_LICENSE_KEY"
```

## שיטות זמינות

- `GET /v1/services`: חיפוש בקטלוג השירותים ועיון בו לפי עמודים.

- `GET /v1/status`: קריאת המצב השמור העדכני של שירות אחד.

- `GET /v1/statuses`: קריאת מצבים של כמה שירותים בבקשה אחת.

- `GET /v1/summary`: סיכום האותות שנצפו באזור או בשירותים שנבחרו.

- `GET /v1/history`: קריאת תצפיות שנשמרו לאורך זמן, עם עיון לפי עמודים.

- `GET /v1/stats`: חישוב יחסי דגימות של אותות שנשמרו, ולא של זמינות שנמדדה.

- `GET /v1/incidents`: הצגת שירותים עם אותות מוגברים; אלה אינן תקריות גלובליות שאומתו.

## איך הנתונים פועלים

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

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

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

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

## רישיון ומגבלות בקשות

השתמשו במפתח הרישיון של Evelode כאסימון Bearer. שמרו אותו בשרת, מחוץ לקוד דפדפן ולמאגרי קוד ציבוריים. רק בקשות נתונים מורשות שהצליחו נכללות במכסה. מכסת הבקשות מתאפסת בעת חידוש הרישיון או שינוי התוכנית, ולא בתחילת כל חודש קלנדרי. תוכניות שנתיות מספקות מאגר בקשות אחד, השווה ל-12 מכסות חודשיות, לכל תקופת הרישיון השנתית.

## חיבור לעוזר AI

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

https://mcp.uptimescout.com

## טיפול בתגובות

בדקו את קוד מצב ה-HTTP לפני קריאת הנתונים: 400 מציין פרמטרים לא תקינים, 401 או 403 מציינים בעיית אימות או רישיון, 409 מציין שההרשאה הנלווית לרישיון השתנתה במהלך הבקשה, 429 מציין חריגה ממגבלת בקשות או קצב, ו-503 מציין חוסר זמינות זמני. פעלו לפי זמני ההמתנה לפני ניסיון חוזר והימנעו מלולאות של ניסיונות חוזרים בתדירות גבוהה.

OpenAPI: https://uptimescout.com/openapi.json
