ניטור API

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

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

יכולות עיקריות

• בדיקת נקודות הקצה של ה‑API שלכם ממיקומים שונים בעולם כל 30 שניות.
• אימות קודי סטטוס HTTP, גוף JSON, כותרות וזמני תגובה.
• הוספת כותרות מותאמות, פרמטרי שאילתה או מטעני JSON.
• קבלת התראות מיידיות אם נקודת קצה מושבתת, איטית או מחזירה תוצאות לא צפויות.
• חיבור ל‑Slack, אימייל, SMS, שיחות טלפון, webhooks ועוד.

הוספת ניטור ה‑API הראשון שלכם

כדי ליצור ניטור, עברו אל הפרויקט שלכם ← ניטורים ← הוספת ניטור.

סוג הניטור

בחרו API כסוג הניטור.

הזינו את כתובת נקודת הקצה שברצונכם לנטר — למשל,
https://api.yourservice.com/v1/users.

הגדרת הבקשה

אפשר להתאים את בקשת ה‑API שלכם באופן מלא:

• שיטת HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS או HEAD
• גוף: שלחו JSON, נתוני טופס, GraphQL או טקסט רגיל עם הבקשה
• אימות: הוסיפו אימות בסיסי, מפתח API או הרשאת Bearer Token
• פרמטרי שאילתה: הוסיפו זוגות מפתח/ערך לכתובת הבקשה
• כותרות: הוסיפו כותרות מותאמות שנדרשות לבקשת ה‑API שלכם

הניטור מוצלח אם

ניטור API מצליח כאשר כל הבדיקות שהוגדרו מתקיימות.
אפשר להגדיר אחת או יותר מהבדיקות הבאות:

• קוד סטטוס: למשל התשובה היא 200 OK
• זמן תגובה: למשל מתחת ל‑שנייה אחת
• הגוף מכיל: למשל "success": true
• נתיב JSON: למשל data.status שווה ל‑"active"
• הכותרת מכילה: למשל Content-Type: application/json

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

הגדרות מתקדמות

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