uptimescout
Získat klíč API

Návod UptimeScout

Jak integrovat API dostupnosti služeb s UptimeScout

Vytvořte panel dostupnosti, který zobrazuje časová razítka a nejistotu, místo aby každý výsledek redukoval na barevnou tečku.

Optické a síťové konektory na serverovém panelu.
Redakční ilustrace vytvořená pomocí AI

Než začnete odesílat požadavky, vyhledejte ID služeb

Začněte endpointem služeb a vyhledejte identifikátor používaný v UptimeScout. Název značky čitelný pro člověka nemusí být totožný s identifikátorem API. Uložte ID a region do konfigurace aplikace, aby se požadavky na stav i historii vztahovaly ke stejné službě.

Získejte příslušnou licenci prostřednictvím Evelode a uložte ji do tajného úložiště na straně serveru nebo do proměnné prostředí. Nevkládejte placený klíč do JavaScriptu v prohlížeči, veřejného repozitáře, snímku obrazovky ani URL.

Odešlete ověřený požadavek na stav

Než spustíte ukázku, nastavte ve vlastním prostředí EVELODE_LICENSE_KEY. Tato ukázka požaduje pozorování GitHub pro US; jde o šablonu požadavku, nikoli o tvrzení o aktuálním stavu GitHub.

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

Než výsledek zobrazíte, správně jej vyhodnoťte

Úspěšná odpověď HTTP a signál dostupnosti služby jsou dvě oddělené vrstvy. Nejprve ověřte stav HTTP a obálku odpovědi. Poté zkontrolujte service.status, service.observed_at a service.stale. Stavy unknown a stale zobrazujte jako takové, místo abyste je tiše považovali za operational.

Ukládejte region spolu s časem pozorování. Pokud se vaše rozhraní obnovuje každou minutu, zobrazujte čas pozorování odděleně od času, kdy vaše aplikace načetla odpověď. Nová odpověď HTTP může obsahovat starší pozorování.

Plánujte objem požadavků a počítejte s limity

Pokud váš pracovní postup umožňuje dávkové požadavky, použijte endpoint pro hromadné stavy a ověřte maximální velikost dávky ve vybraném tarifu. Počet povolených požadavků a limit požadavků za minutu jsou dvě odlišná omezení. Přístup přes REST, SDK a MCP sdílí stejné licencované účtování požadavků.

Při HTTP 429 dodržte Retry-After a vyhněte se rychlé sérii opakovaných požadavků. U dočasných chyb používejte omezený počet opakování s postupně se prodlužujícími prodlevami; chyby ověřování ani neplatné parametry neopakujte bez omezení. Obnovení licence a změna tarifu aktualizují licencovaný počet požadavků; první den kalendářního měsíce se neobnovuje.

Před nasazením otestujte i nejisté případy

Otestujte známou službu, neznámé ID, chybějící klíč, neplatné parametry a zastaralé nebo chybějící pozorování. Ověřte, že tyto případy ve vašem rozhraní vedou k užitečným zprávám. Pokud diagnostické údaje obsahují přihlašovací údaje nebo informace o účtu, nezapisujte je v úplné podobě do veřejných logů.

Dokumentace API obsahuje všech sedm veřejných metod a schéma OpenAPI. jsonscraper odkazuje na SDK pro Python, Node.js, PHP, Go, Java a .NET. Knihovna klienta zjednodušuje přenos dat, ale vaše aplikace stále potřebuje pravidla pro vyhodnocování nejistoty.

Obsah zkontrolován 18. listopadu 2026.

Markdown

REST / MCP / SDK

Ověřte službu nebo integrujte API

Aktuální regionální signál najdete v katalogu služeb a postup pro opakovatelnou integraci v dokumentaci.

Katalog služebDokumentace API