Довідка та інструкції › API та інтеграції › Генерація API токена

Генерація API токена

2 хв читання · API та інтеграції

Токен API - це ваш особистий ключ для програмного доступу до ePulz.io. Він стане в пригоді, коли ви хочете звертатися до сервісу зі скриптів, власних інструментів або з CI/CD-конвеєра. Через API можна створювати та змінювати монітори, завантажувати дані про доступність або вбудовувати результати вимірювань у власні системи. Цей посібник показує, де згенерувати токен, як він виглядає, де безпечно його зберігати та як його відкликати.

Керування токенами API - префікс epulzio_ та останнє використання
Керування токенами API: назва, префікс epulzio_ та час останнього використання.

Де згенерувати токен

Токени прив'язані до конкретного користувача - кожен учасник команди має власні токени зі своїми правами.

  • У панелі керування відкрийте розділ Токени API (шлях /dashboard/api-tokens).
  • Натисніть + Новий токен.
  • Введіть зрозумілу назву, за якою ви впізнаєте токен (наприклад CI/CD-конвеєр або Внутрішня панель).
  • Токен діє, доки ви його не відкличете - у нього немає фіксованої дати завершення.
  • Після натискання Створити відобразиться повне значення токена. Скопіюйте його одразу - з міркувань безпеки ви більше його не побачите.

Як виглядає токен

Кожен токен починається з префікса epulzio_ і налічує загалом понад 40 символів. Приклад (скорочений):

epulzio_2bF7nQ9k4Lm8XzR0pT3vYw5sH1cJ6dE...

Префікс потрібен для того, щоб ви одразу впізнавали токен серед інших рядків - наприклад під час пошуку в логах або сканування репозиторіїв на наявність витоку ключа.

Як використовувати токен

Токен передається в HTTP-заголовку Authorization у вигляді:

Authorization: Bearer epulzio_xxxxxxxxxxxxxxxx

Приклад виклику в терміналі:

curl -H "Authorization: Bearer epulzio_..." https://epulz.io/api/v1/monitors

Де безпечно зберігати токен

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

  • Локально під час розробки: у змінній середовища, наприклад EPULZIO_TOKEN у файлі .env (який зазначено в .gitignore).
  • У CI/CD: через секрети, які пропонує ваша платформа (GitHub Actions secrets, GitLab CI variables, Bitbucket repository variables тощо).
  • На серверах: через системні змінні середовища або менеджер секретів (HashiCorp Vault, AWS Secrets Manager).
Порада: Для кожної системи, що використовує API, створюйте окремий токен із власною назвою. У разі можливого витоку ви просто відкличете лише той, якого це стосується, а решта інтеграцій працюватимуть далі без втручання.

Як відкликати токен

  • У списку токенів знайдіть той, який хочете відкликати, і натисніть Відкликати.
  • Відкликання набуває чинності негайно - наступні виклики з цим токеном отримають відповідь 401 Unauthorized (токен недійсний).
  • Відкликаний токен відновити не можна. Якщо він знову потрібен, згенеруйте новий.

Час від часу переглядайте список активних токенів і видаляйте ті, які вже не використовуєте. Менше активних токенів означає меншу поверхню для атаки.

Чи був цей посібник корисним?
Далі →
Огляд API endpoints