# Näin integroit UptimeScoutin saatavuus-API:n



URL: https://uptimescout.com/fi/blog/availability-api-integration/



Rakenna saatavuusnäkymä, jossa aikaleimat ja epävarmuus pysyvät näkyvissä sen sijaan, että kaikki pelkistettäisiin värilliseksi pisteeksi.



## Etsi palveluiden ID-tunnisteet ennen kyselyjen tekemistä



Aloita palvelupäätepisteestä ja etsi UptimeScoutin käyttämä tunniste. Ihmisluettava tuotemerkki ei aina vastaa API:n tunnistetta. Säilytä ID ja alue sovelluksesi asetuksissa, jotta tila- ja historiapyynnöt viittaavat samaan palveluun.

Hanki soveltuva lisenssi Evelodesta ja säilytä se palvelinpuolen salaisuutena tai ympäristömuuttujana. Älä upota maksullista avainta selaimen JavaScript-koodiin, julkiseen tietovarastoon, kuvakaappaukseen tai URL-osoitteeseen.



## Lähetä todennettu tilapyyntö



Aseta EVELODE_LICENSE_KEY omassa ympäristössäsi ennen esimerkin suorittamista. Esimerkki pyytää GitHubin US-havaintoja; se on pyyntömalli, ei väite GitHubin nykyisestä tilasta.



```sh

curl -G https://api.uptimescout.com/v1/status \
  --data-urlencode "service=github" \
  --data-urlencode "region=US" \
  -H "Authorization: Bearer $EVELODE_LICENSE_KEY"

```



## Tulkitse vastaus ennen sen näyttämistä



Onnistunut HTTP-vastaus ja palvelun saatavuussignaali ovat eri asioita. Tarkista ensin HTTP-tila ja vastauksen rakenne. Tarkastele sitten kenttiä service.status, service.observed_at ja service.stale. Pidä unknown ja stale näkyvissä sen sijaan, että käsittelisit niitä hiljaisesti operational-tilana.

Tallenna alue havaintoajan yhteyteen. Jos käyttöliittymäsi päivittyy minuutin välein, näytä havaintoaika erikseen ajasta, jolloin sovelluksesi haki vastauksen. Tuore HTTP-vastaus voi kuvata vanhempaa havaintoa.



## Suunnittele pyyntömäärä ja käsittele rajoitukset



Käytä tilojen erätarkistusta, jos se sopii työnkulkuusi, ja tarkista valitun tilauksen eräpyynnön enimmäiskoko. Pyyntökiintiö ja minuuttikohtainen pyyntörajoitus ovat eri asioita. REST-, SDK- ja MCP-käytössä sovelletaan samaa lisenssikohtaista pyyntölaskentaa.

Jos saat HTTP 429 -vastauksen, noudata Retry-After-otsaketta äläkä tee heti peräkkäisiä pyyntöjä. Käytä tilapäisissä virheissä rajattua määrää uudelleenyrityksiä ja pidennä viivettä asteittain. Älä yritä toistuvasti uudelleen todennus- tai virheellisten parametrien virheitä. Uusiminen ja tilausmuutokset päivittävät lisenssin pyyntökiintiön; se ei nollaudu kalenterikuukauden ensimmäisenä päivänä.



## Testaa epävarmat tilanteet ennen käyttöönottoa



Testaa tunnettu palvelu, tuntematon ID, puuttuva avain, virheelliset parametrit sekä vanhentunut tai puuttuva havainto. Varmista, että käyttöliittymäsi näyttää näissä tilanteissa hyödylliset viestit. Älä jätä täydellisiä diagnostiikkatietoja julkisiin lokeihin, jos ne sisältävät tunnistetietoja tai tilitietoja.

API-dokumentaatiossa on kaikki seitsemän julkista menetelmää ja OpenAPI-skeema. jsonscraper sisältää linkit Python-, Node.js-, PHP-, Go-, Java- ja .NET-SDK:ihin. Asiakaskirjasto yksinkertaistaa tiedonsiirtoa, mutta sovelluksesi tarvitsee silti käytännön epävarmuuden tulkitsemiseen.



## Resurssit

https://uptimescout.com/fi/docs/

https://uptimescout.com/fi/methodology/

https://uptimescout.com/fi/contacts/
