⌘ K

Zacznij korzystać z API Instatus

Wszystkie endpointy znajdują się pod adresem https://api.instatus.com. Zasadniczo są zgodne z architekturą REST.

Wszystkie żądania muszą być zakodowane jako JSON, z nagłówkiem Content-Type: application/json.

Odpowiedzi API Instatus, łącznie z błędami, również są kodowane jako JSON.

Uwierzytelnianie

Żądania do API Instatus muszą przekazywać token API w nagłówku Authorization:

Swój klucz API znajdziesz w Ustawieniach użytkownika → Ustawienia dewelopera

Authorization: Bearer <API_KEY>

Znajdź swoje ID strony

ID strony znajdziesz w panelu, wykonując poniższe kroki:

Przejdź do swojego panelu.
Kliknij projekt w lewym górnym rogu prawym przyciskiem myszy, aby otworzyć menu.
Kliknij Copy Project ID, a ID strony zostanie skopiowane do schowka.

Błędy

Wszystkie endpointy API zwracają w odpowiedziach błędu kod i komunikat.

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

Wartości statusów

Możliwe statusy strony. To szczegółowy status zwracany przez bieżące API (v2 i nowsze). Starszy endpoint summary.json oraz powiadomienia webhook używają formy skróconej, obejmującej tylko UP, HASISSUES i UNDERMAINTENANCE.