Hitelesítés
API kulcs hitelesítés
Az API-kulcsok az ajánlott mód az automatizált kérések hitelesítésére. Add át a kulcsot a X-API-Key kérés fejlécébe.
curl https://your-IntraCord-instance/api/v1/workflow/fetch \
-H "X-API-Key: dg_your_api_key"
Az API-kulcsok egy szervezetre vonatkoznak. A kulccsal létrehozott vagy elért összes erőforrás az adott szervezethez tartozik.
Hozzon létre egy API-kulcsot
Hozzon létre kulcsokat a Dashboardon a Beállítások → API-kulcsok alatt. A teljes kulcs csak egyszer jelenik meg a létrehozáskor – azonnal tárolja egy titkos kezelőben vagy környezeti változóban.
API-kulcsok kezelése
| Akció | Módszer | Útvonal |
|---|---|---|
| Gombok listája | GET | /user/api-keys |
| Kulcs létrehozása | POST | /user/api-keys |
| Archív kulcs | DELETE | /user/api-keys/{api_key_id} |
| Aktiválja újra a kulcsot | PUT | /user/api-keys/{api_key_id}/reactivate |
A kulcs archiválása azonnal visszavonja azt. Minden ezt a kulcsot használó kérés a következőt adja vissza: 401.
Hibaválaszok
| Állapot | Ok |
|---|---|
401 Unauthorized | Hiányzó, érvénytelen vagy lejárt Credentials |
403 Forbidden | Érvényes Credentials, de nem rendelkeznek elegendő jogosultsággal az erőforráshoz |
{
"detail": "Invalid or expired API key"
}