Початок роботи

Перший запит

Перевірте підключення до Alerts Energy API: надішліть запит із ключем та отримайте коротку JSON-відповідь.

GET/api/v1/check

API-ключ - спільна квота облікового запису

1. Підготуйте API-ключ

Отримайте ключ у кабінеті. Якщо ключа ще немає, почніть з інструкції з отримання доступу.

2. Виконайте запит

Замініть YOUR_API_KEY власним ключем і виконайте GET /api/v1/check. Параметри та тіло запиту не потрібні.

3. Перевірте відповідь

HTTP-статус 200 і відповідь {"ok":true} підтверджують успішний доступ до API. Запит нічого не змінює та враховується у квоті акаунта.

Атрибути відповіді

okboolean: Успішна відповідь містить true: ключ прийнято, доступ до API підтверджено.

Якщо запит не вдався

При 401 перевірте ключ і заголовок Authorization. При 403 перевірте статус підписки та доступність методу. При 429 дочекайтеся завершення затримки з Retry-After.

Приклад запиту

curl --fail-with-body --max-time 10 \
  'https://alerts.energy/api/v1/check' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Приклад відповіді

Відповідь на успішний перевірочний запит.

{
  "ok": true
}