uptimescout
Отримати ключ API

Посібник UptimeScout

Як інтегрувати API доступності сервісів з UptimeScout

Створіть панель доступності, яка показує часові позначки й невизначеність, а не зводить кожну відповідь до кольорової крапки.

Оптоволоконні та мережеві роз’єми на серверній панелі.
Ілюстрація, створена за допомогою ШІ

Перш ніж надсилати запити, знайдіть ID сервісів

Почніть із кінцевої точки сервісів, щоб знайти ідентифікатор, який використовує UptimeScout. Зрозуміла користувачам назва бренду не завжди збігається з ідентифікатором API. Збережіть ID і регіон у конфігурації застосунку, щоб запити статусу й історії стосувалися того самого сервісу.

Отримайте відповідну ліцензію через Evelode та зберігайте її в секреті на сервері або в змінній середовища. Не вбудовуйте платний ключ у JavaScript у браузері, публічний репозиторій, знімок екрана чи URL.

Надішліть автентифікований запит статусу

Перш ніж запускати приклад, задайте EVELODE_LICENSE_KEY у власному середовищі. Цей приклад запитує спостереження GitHub для US; це шаблон запиту, а не твердження про поточний статус GitHub.

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

Перш ніж показувати відповідь, правильно її витлумачте

Успішне передавання відповіді та сигнал доступності сервісу — це різні рівні. Спочатку перевірте HTTP-статус і структуру відповіді. Потім перевірте service.status, service.observed_at і service.stale. Відображайте unknown і stale явно, а не трактуйте їх мовчки як operational.

Зберігайте регіон разом із часом спостереження. Якщо ваш інтерфейс оновлюється щохвилини, окремо вказуйте час спостереження та час отримання відповіді застосунком. Свіжа HTTP-відповідь може містити давніше спостереження.

Плануйте обсяг запитів і враховуйте ліміти

Якщо для вашого процесу підходить пакетний запит, використовуйте його та перевірте максимальний розмір пакета для вибраного плану. Доступний обсяг запитів і кількість запитів за хвилину — це різні ліміти. Для REST, SDK і MCP використовується спільний ліцензований облік запитів.

У разі HTTP 429 дотримуйтеся Retry-After і не надсилайте одразу багато повторних запитів. Для тимчасових помилок використовуйте обмежену кількість повторних спроб із дедалі більшими затримками; не повторюйте безкінечно запити з помилками автентифікації чи неприпустимими параметрами. Після продовження ліцензії чи зміни плану обсяг запитів оновлюється; автоматичного скидання першого числа календарного місяця немає.

Перед запуском перевірте сценарії з невизначеністю

Перевірте відомий сервіс, невідомий ID, відсутній ключ, неприпустимі параметри та застаріле чи відсутнє спостереження. Переконайтеся, що в кожному випадку інтерфейс показує зрозуміле повідомлення. Не зберігайте повну діагностичну відповідь у публічних журналах, якщо вона містить облікові дані чи інформацію про обліковий запис.

Документація API містить усі сім публічних методів і схему OpenAPI. На сторінці інтеграції jsonscraper наведено посилання на SDK для Python, Node.js, PHP, Go, Java і .NET. Бібліотека клієнта спрощує передавання даних, але застосунку все одно потрібна політика трактування невизначеності.

Вміст перевірено 18 листопада 2026 року.

Markdown

REST / MCP / SDK

Перевірити сервіс або інтегрувати API

Скористайтеся каталогом сервісів, щоб переглянути актуальний регіональний сигнал, а документацією — щоб створити відтворювану інтеграцію.

Каталог сервісівДокументація API