⌘ K

בואו נתחיל עם ה‑API של Instatus

כל נקודות הקצה נמצאות תחת הכתובת https://api.instatus.com. הן פועלות באופן כללי לפי ארכיטקטורת REST.

כל הבקשות חייבות להיות מקודדות כ‑JSON עם הכותרת Content-Type: application/json.

התשובות מה‑API של Instatus, כולל שגיאות, מקודדות אף הן כ‑JSON.

אימות

בקשות ל‑API של Instatus חייבות לספק אסימון API דרך כותרת Authorization:

אפשר לקבל את מפתח ה‑API בהגדרות משתמש ← הגדרות מפתחים

Authorization: Bearer <API_KEY>

איך משיגים את מזהה הדף

אפשר למצוא את מזהה הדף שלכם בדאשבורד לפי השלבים הבאים:

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

שגיאות

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

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

ערכי סטטוס

סטטוסים אפשריים של דף. זהו ערך ה‑status המפורט שמוחזר על ידי ה‑API הנוכחי (v2 ואילך). נקודת הקצה הישנה summary.json והתראות ה‑webhook משתמשות בצורה מקוצרת עם UP, HASISSUES ו‑UNDERMAINTENANCE בלבד.