API token generálása

2 perc olvasás · API és integrációk

Az API token a személyes kulcsa az ePulz.io programozott eléréséhez. Akkor jön jól, ha szkriptekből, saját eszközökből vagy egy CI/CD folyamatból szeretné elérni a szolgáltatást. Az API-n keresztül monitorokat hozhat létre és módosíthat, letöltheti a rendelkezésre állási adatokat, vagy beépítheti a mérési eredményeket a saját rendszereibe. Ez az útmutató megmutatja, hol hozhat létre tokent, hogyan néz ki, hová érdemes biztonságosan eltenni és hogyan vonhatja vissza.

API tokenek kezelése - epulzio_ előtag és utolsó használat — API tokenek kezelése: név, epulzio_ előtag és az utolsó használat ideje.

Hol hozhat létre tokent

A tokenek egy adott felhasználóhoz kötődnek - minden csapattagnak saját tokenjei vannak a saját jogosultságaikkal.

A vezérlőpulton nyissa meg az API tokenek szakaszt (útvonal /dashboard/api-tokens).
Kattintson a + Új token gombra.
Adjon meg egy beszédes nevet, amely alapján felismeri a tokent (például CI/CD folyamat vagy Belső vezérlőpult).
A token addig érvényes, amíg vissza nem vonja - nincs fix lejárati dátuma.
A Létrehozás gombra kattintva megjelenik a token teljes értéke. Másolja ki azonnal - biztonsági okokból többé nem fogja látni.

Hogyan néz ki a token

Minden token az epulzio_ előtaggal kezdődik, és összesen több mint 40 karakterből áll. Példa (rövidítve):

epulzio_2bF7nQ9k4Lm8XzR0pT3vYw5sH1cJ6dE...

Az előtag arra szolgál, hogy a tokent azonnal felismerje más karakterláncok között - például naplók átvizsgálásakor vagy repository-k átfésülésekor, hogy nincs-e valahol kiszivárgott kulcs.

Hogyan használja a tokent

A tokent az Authorization HTTP fejlécben kell elküldeni, a következő formában:

Authorization: Bearer epulzio_xxxxxxxxxxxxxxxx

Példa hívás a terminálban:

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

Hová tegye el biztonságosan a tokent

A tokent kezelje úgy, mint egy jelszót. Soha ne tegye nyilvánosan elérhető kódba, dokumentációba vagy csevegőüzenetekbe.

Helyileg fejlesztés közben: környezeti változóba, például EPULZIO_TOKEN egy .env fájlban (amely a .gitignore-ban van).
CI/CD-ben: a platformja által kínált titkokon keresztül (GitHub Actions secrets, GitLab CI variables, Bitbucket repository variables és hasonlók).
Szervereken: rendszerszintű környezeti változókon vagy titokkezelőn keresztül (HashiCorp Vault, AWS Secrets Manager).

Tipp: Minden olyan rendszerhez, amely az API-t használja, hozzon létre saját tokent saját névvel. Esetleges kiszivárgás esetén egyszerűen csak az érintettet vonja vissza, a többi integráció pedig beavatkozás nélkül fut tovább.

Hogyan vonjon vissza egy tokent

A tokenek listájában keresse meg azt, amelyet vissza szeretne vonni, és kattintson a Visszavonás gombra.
A visszavonás azonnal érvénybe lép - a tokennel indított további hívások 401 Unauthorized választ kapnak (a token érvénytelen).
A visszavont token már nem állítható vissza. Ha újra szüksége van rá, hozzon létre egy újat.

Időnként menjen végig az aktív tokenek listáján, és törölje azokat, amelyeket már nem használ. Kevesebb aktív token kisebb támadási felületet jelent.

Hasznos volt ez az útmutató?