uptimescout
Uzyskaj klucz API

Poradnik UptimeScout

Jak zintegrować API dostępności usług z UptimeScout

Zbuduj panel dostępności, który pokazuje znaczniki czasu i niepewność, zamiast sprowadzać każdą odpowiedź do kolorowej kropki.

Złącza światłowodowe i sieciowe w panelu serwerowym.
Ilustracja redakcyjna wygenerowana przez AI

Najpierw wyszukaj identyfikatory usług

Zacznij od endpointu usług, aby znaleźć identyfikator używany przez UptimeScout. Nazwa marki czytelna dla człowieka nie zawsze jest identyfikatorem API. Zapisz identyfikator i region w konfiguracji aplikacji, aby żądania statusu i historii odnosiły się do tej samej usługi.

Uzyskaj odpowiednią licencję przez Evelode i przechowuj ją po stronie serwera jako sekret lub zmienną środowiskową. Nie umieszczaj płatnego klucza w kodzie JavaScript w przeglądarce, publicznym repozytorium, zrzucie ekranu ani adresie URL.

Wyślij uwierzytelnione żądanie statusu

Przed uruchomieniem przykładu ustaw zmienną EVELODE_LICENSE_KEY we własnym środowisku. Ten przykład wysyła żądanie dotyczące obserwacji GitHub w US; to szablon żądania, a nie informacja o aktualnym statusie GitHub.

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

Zinterpretuj odpowiedź, zanim ją wyświetlisz

Pomyślna odpowiedź transportowa i sygnał dostępności usługi to odrębne warstwy. Najpierw zweryfikuj status HTTP i strukturę odpowiedzi. Następnie sprawdź service.status, service.observed_at i service.stale. Pokazuj stany unknown i nieaktualne obserwacje zamiast po cichu traktować je jako operational.

Zapisuj region razem z czasem obserwacji. Jeśli Twój interfejs odświeża się co minutę, wyświetlaj czas obserwacji oddzielnie od czasu pobrania odpowiedzi przez aplikację. Świeża odpowiedź HTTP może zawierać starszą obserwację.

Zaplanuj liczbę zapytań i obsługę limitów

Jeśli odpowiada to Twojemu procesowi pracy, korzystaj z endpointu statusów zbiorczych; maksymalny rozmiar partii sprawdź w wybranym planie. Limit zapytań i liczba zapytań na minutę to różne ograniczenia. Dostęp REST, SDK i MCP korzysta z tej samej licencjonowanej puli zapytań.

W przypadku HTTP 429 przestrzegaj nagłówka Retry-After i unikaj serii natychmiastowych ponowień. Przy błędach tymczasowych stosuj ograniczoną liczbę ponowień z coraz dłuższymi przerwami; nie ponawiaj bez końca żądań z błędami uwierzytelniania lub nieprawidłowymi parametrami. Odnowienie licencji i zmiana planu aktualizują limit; limit nie odnawia się pierwszego dnia miesiąca kalendarzowego.

Przed wdrożeniem przetestuj przypadki niepewne

Przetestuj znaną usługę, nieznane ID, brakujący klucz, nieprawidłowe parametry oraz nieaktualną lub brakującą obserwację. Upewnij się, że w tych przypadkach interfejs wyświetla przydatne komunikaty. Nie umieszczaj pełnych wyników diagnostycznych w publicznych dziennikach, jeśli zawierają dane uwierzytelniające lub informacje o koncie.

Dokumentacja API zawiera wszystkie siedem publicznych metod i schemat OpenAPI. jsonscraper zawiera odnośniki do SDK dla Python, Node.js, PHP, Go, Java i .NET. Biblioteka kliencka upraszcza obsługę transportu, ale aplikacja nadal potrzebuje zasad interpretacji niepewności.

Treść sprawdzono 18 listopada 2026 r.

Markdown

REST / MCP / SDK

Sprawdź usługę lub zintegruj API

Skorzystaj z katalogu usług, aby sprawdzić aktualny sygnał regionalny, a z dokumentacji — aby wdrożyć powtarzalną integrację.

Katalog usługDokumentacja API