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

Source: https://instatus.com/help/he/api

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

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

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

## אימות

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

אפשר לקבל את מפתח ה‑API בהגדרות משתמש ← [הגדרות מפתחים](https://dashboard.instatus.com/developer)

```bash
Authorization: Bearer <API_KEY>
```

## איך משיגים את מזהה הדף
אפשר למצוא את מזהה הדף שלכם בדאשבורד לפי השלבים הבאים:
1. עברו לדאשבורד שלכם.
2. לחצו לחיצה ימנית על הפרויקט בפינה השמאלית העליונה כדי לפתוח את התפריט.
3. לחצו על **העתקת מזהה הפרויקט** ומזהה הדף יועתק ללוח.

![מזהה דף](https://instatus.com/help/page_id.png)

## שגיאות

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

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

## ערכי סטטוס

סטטוסים אפשריים של דף. זהו ערך ה‑`status` המפורט שמוחזר על ידי ה‑API הנוכחי (v2 ואילך). נקודת הקצה הישנה `summary.json` ו[התראות ה‑webhook](https://instatus.com/help/he/webhooks) משתמשות בצורה מקוצרת עם `UP`, `HASISSUES` ו‑`UNDERMAINTENANCE` בלבד.

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

סטטוסים אפשריים של רכיב:

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

סטטוסים אפשריים של תקרית:

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

סטטוסים אפשריים של תחזוקה:

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## מעבר לנקודות הקצה:

- [דפי סטטוס](https://instatus.com/help/he/api/status-pages)
- [סביבות עבודה](https://instatus.com/help/he/api/workspaces)
- [רכיבים](https://instatus.com/help/he/api/components)
- [תקריות](https://instatus.com/help/he/api/incidents)
- [עדכוני תקריות](https://instatus.com/help/he/api/incident-updates)
- [תחזוקות](https://instatus.com/help/he/api/maintenances)
- [עדכוני תחזוקה](https://instatus.com/help/he/api/maintenance-updates)
- [תבניות](https://instatus.com/help/he/api/templates)
- [הודעות כלליות](https://instatus.com/help/he/api/generic-notices)
- [השבתות](https://instatus.com/help/he/api/outages)
- [חברי הצוות](https://instatus.com/help/he/api/teammates)
- [מנויים](https://instatus.com/help/he/api/subscribers)
- [מדדים](https://instatus.com/help/he/api/metrics)
- [פרופיל משתמש](https://instatus.com/help/he/api/user-profile)
- [נתונים ציבוריים](https://instatus.com/help/he/api/public-data)
- [דפים פרטיים](https://instatus.com/help/he/api/private-pages)
- [קבוצות קהל](https://instatus.com/help/he/api/audience-groups)
- [ניטורים](https://instatus.com/help/he/api/monitors)
- [אינטגרציות ניטור](https://instatus.com/help/he/api/monitoring-integrations)
- [כללי ניתוב](https://instatus.com/help/he/api/routing-rules)
- [מדיניות הסלמה](https://instatus.com/help/he/api/escalation-policies)
- [לוחות כוננות](https://instatus.com/help/he/api/on-call-schedules)