# שילוב API של UptimeScout לבדיקת זמינות שירותים



URL: https://uptimescout.com/he/blog/availability-api-integration/



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



## גלו מזהי שירות לפני שליחת בקשות מחזוריות



התחילו בנקודת הקצה של השירותים כדי למצוא את המזהה שבו משתמש UptimeScout. שם מותג קריא לבני אדם אינו תמיד המזהה של ה-API. שמרו את המזהה ואת האזור בתצורת היישום, כדי שבקשות סטטוס והיסטוריה יתייחסו לאותו שירות.

רכשו רישיון מתאים דרך Evelode ושמרו אותו בסוד בצד השרת או במשתנה סביבה. אל תטמיעו מפתח בתשלום ב-JavaScript של הדפדפן, במאגר ציבורי, בצילום מסך או בכתובת URL.



## שלחו בקשת סטטוס מאומתת



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



```sh

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

```



## פרשו את התגובה לפני הצגתה



תגובה מוצלחת של שכבת התעבורה ואות הזמינות של השירות הם שני דברים נפרדים. תחילה אמתו את סטטוס ה-HTTP ואת מעטפת התגובה. לאחר מכן בדקו את service.status, את service.observed_at ואת service.stale. השאירו מצבי unknown ותצפיות שהתיישנו גלויים, במקום להתייחס אליהם בשקט כאילו היו operational.

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



## תכננו את נפח הבקשות וטפלו במגבלות



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

במקרה של HTTP 429, כבדו את Retry-After והימנעו מפרץ ניסיונות חוזרים מיידיים. השתמשו במספר מוגבל של ניסיונות חוזרים עם השהיה הולכת וגדלה במקרה של כשלים זמניים; אל תמשיכו לנסות ללא הגבלה במקרה של שגיאות אימות או פרמטרים לא תקינים. מכסת הבקשות מתאפסת בעת חידוש הרישיון או שינוי התוכנית, ולא בראשון לחודש קלנדרי.



## בדקו מקרי אי־ודאות לפני ההשקה



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

תיעוד ה-API כולל את כל שבע השיטות הציבוריות ואת סכמת OpenAPI. jsonscraper מקשר לערכות הפיתוח Python,‏ Node.js,‏ PHP,‏ Go,‏ Java ו-.NET. ספריית לקוח מפשטת את התעבורה, אך היישום שלכם עדיין זקוק למדיניות לפרשנות של אי־ודאות.



## משאבים

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

https://uptimescout.com/he/methodology/

https://uptimescout.com/he/contacts/
