API-overvåking

API-monitorer sender en konfigurerbar HTTP-forespørsel til et endepunkt hvert 30. sekund og varsler deg når det er utilgjengelig, tregt eller returnerer feil data. Du styrer metode, headere, body og autentisering, og gjør påstander om statuskode, JSON-innhold, headere og svartid.

Som med andre monitorer kan du, hvis en API-monitor oppdager et problem, jobbe sammen med teamet ditt om å løse hendelsen og eventuelt oppdatere statussiden din.

Monitor

Hva sjekker en API-monitor?

  • Test API-endepunktene dine fra flere lokasjoner i verden hvert 30. sekund.
  • Valider HTTP-statuskoder, JSON-innhold, headere og svartider.
  • Ta med egne headere, spørringsparametere eller JSON-nyttelast.
  • Få umiddelbar varsling hvis et endepunkt er nede, tregt eller returnerer uventede resultater.
  • Integrer med Slack, e-post, SMS, telefonanrop, webhooks og mer.

Hvordan legger jeg til en API-monitor?

Gå til prosjektet ditt → Monitorer → Legg til monitor, velg API, skriv inn endepunktets URL, konfigurer forespørselen og angi påstandene som betyr at endepunktet fungerer som det skal.

Legg til API-monitor

Monitortype

Velg API som monitortype.

Monitortypen API

Skriv inn URL-en til endepunktet du vil overvåke — for eksempel
https://api.yourservice.com/v1/users.

Konfigurasjon av forespørselen

Du kan tilpasse API-forespørselen fullstendig:

  • HTTP-metode: GET, POST, PUT, PATCH, DELETE, OPTIONS eller HEAD
  • Innhold: Send JSON, skjemadata, GraphQL eller ren tekst med forespørselen
  • Autentisering: Legg til basic-autentisering, API-nøkkel eller Bearer-token
  • Spørringsparametere: Legg nøkkel/verdi-par til forespørsels-URL-en
  • Headere: Legg til egne headere som API-forespørselen krever

Monitoren er vellykket hvis

En API-monitor er vellykket når alle angitte påstander er oppfylt.
Du kan sette opp én eller flere av følgende påstander:

  • Statuskode: f.eks. at svaret er 200 OK
  • Svartid: f.eks. under 1 sekund
  • Innholdet inneholder: f.eks. "success": true
  • JSON-sti: f.eks. at data.status er lik "active"
  • Headeren inneholder: f.eks. Content-Type: application/json

Hvis noen av disse betingelsene ikke er oppfylt, blir monitoren markert som nede, og varsler sendes ut fra varselinnstillingene dine.

Avanserte innstillinger

Avanserte monitorinnstillinger
  • Vennlig navn: Gi monitoren et beskrivende navn slik at den er lett å kjenne igjen.
  • Kjør sjekker hvert: Bestem hvor ofte endepunktet skal testes.
  • Kjør fra: Velg testlokasjoner (USA, Canada, Europa, Asia).
  • Legg til på statussiden: Vis oppetid og svarstatistikk for API-et offentlig.
  • Når en monitor feiler: Start en hendelse, varsle abonnenter eller publiser til statussiden din.
  • Når en monitor kommer seg: Løs hendelser og oppdater statussiden din automatisk.
Gratulerer, du har lagt til din første API-monitor!