API-valvonta

API-monitorien avulla voit varmistaa automaattisesti, että API-päätepisteesi ovat saavutettavissa, toimivat tehokkaasti ja palauttavat oikeat tiedot. Näin voit taata, että sovelluksesi ja integraatiosi toimivat tarkoitetulla tavalla.

Kuten muidenkin monitorien kohdalla, jos API-monitori havaitsee ongelman, voit ratkaista häiriön yhdessä tiimisi kanssa ja halutessasi päivittää statussivusi.

Tärkeimmät ominaisuudet

• Testaa API-päätepisteesi eri puolilta maailmaa 30 sekunnin välein.
• Validoi HTTP-tilakoodit, JSON-sisältö, otsakkeet ja vastausajat.
• Sisällytä mukautetut otsakkeet, kyselyparametrit tai JSON-hyötykuormat.
• Saat ilmoituksen heti, jos päätepiste on alhaalla, hidas tai palauttaa odottamattomia tuloksia.
• Yhdistä Slackiin, sähköpostiin, tekstiviesteihin, puheluihin, webhookeihin ja muihin.

Ensimmäisen API-monitorin lisääminen

Luodaksesi monitorin siirry projektiisi → Monitorit → Lisää monitori.

Monitorin tyyppi

Valitse monitorin tyypiksi API.

Syötä valvottavan päätepisteen URL — esimerkiksi
https://api.yourservice.com/v1/users.

Pyynnön määritys

Voit räätälöidä API-pyyntösi täysin:

• HTTP-metodi: GET, POST, PUT, PATCH, DELETE, OPTIONS tai HEAD
• Sisältö: Lähetä pyynnön mukana JSON, lomaketiedot, GraphQL tai pelkkä teksti
• Todennus: Lisää perustodennus, API-avain tai Bearer-token
• Kyselyparametrit: Liitä avain–arvo-pareja pyynnön URL-osoitteeseen
• Otsakkeet: Lisää API-pyyntösi vaatimat mukautetut otsakkeet

Monitori onnistuu, jos

API-monitori onnistuu, kun kaikki määritetyt ehdot täyttyvät.
Voit asettaa yhden tai useamman seuraavista ehdoista:

• Tilakoodi: esim. vastaus on 200 OK
• Vastausaika: esim. alle 1 second
• Sisältö sisältää: esim. "success": true
• JSON-polku: esim. data.status on "active"
• Otsake sisältää: esim. Content-Type: application/json

Jos jokin näistä ehdoista ei täyty, monitori merkitään tilaan alhaalla ja hälytykset lähetetään hälytysasetustesi mukaisesti.

Lisäasetukset

• Kutsumanimi: Anna monitorillesi kuvaava nimi, jotta tunnistat sen helpommin.
• Suorita tarkistukset joka: Päätä, kuinka usein päätepiste testataan.
• Suorita sijainnista: Valitse testaussijainnit (Yhdysvallat, Kanada, Eurooppa, Aasia).
• Lisää statussivulle: Näytä API:n käyttöaika ja vastaustilastot julkisesti.
• Kun monitori epäonnistuu: Luo häiriö, ilmoita tilaajille tai julkaise se statussivullesi.
• Kun monitori palautuu: Ratkaise häiriöt ja päivitä statussivusi automaattisesti.