Autentimine

Kordoni API kasutab päringute turvamiseks Bearer token autentimist. Iga API päringu Authorization päises peab sisalduma kehtiv autentimisvõti.

API võtmete tüübid

Isiklikud võtmed

Isiklikel võtmetel on samad õigused ja ligipääsutase nagu kasutajal, kes need lõi.

Kasutusjuhud:

• Isiklikud automatiseerimisskriptid
• Arendus ja testimine
• Kasutaja isiklikud töövood

Omadused:

• Sama roll ja õigused nagu loonud kasutajal
• Võti tühistatakse, kui kasutaja deaktiveeritakse

Boti võtmed

Boti võtmetel on õigused vastavalt määratud rollile, sõltumata ühestki konkreetsest kasutajast.

Kasutusjuhud:

• Toodangukeskkonna liidestused
• Süsteemidevaheline suhtlus
• Jagatud organisatsiooni töövood

Omadused:

• Rollipõhised õigused
• Sõltumatu individuaalsetest kasutajakontodest

API võtmete genereerimine

1. Logi Kordoni kontole sisse
2. Mine Seaded → Integratsioonid
3. Klõpsa Loo uus võti
4. Vali võtme tüüp ja seadista õigused
5. Kopeeri ja salvesta võti turvaliselt

API võtmete kasutamine

Lisa oma võti iga päringu Authorization päisesse:

Authorization: Bearer SINU_VÕTI_SIIN

Päringu näide

Testi API ühendust

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/users" \
--header "Authorization: Bearer SINU_VÕTI_SIIN"

Autentimise vead

401 Autoriseerimata

{
    "error": {
        "code": "unauthorized",
        "message": "Invalid or missing authentication key",
        "status": 401
    }
}

Levinud põhjused:

• Puuduv Authorization päis
• Vigane API võtme formaat
• Tühistatud API võti

403 Keelatud

{
    "error": {
        "code": "forbidden",
        "message": "Insufficient permissions for this resource",
        "status": 403
    }
}

Levinud põhjused:

• Kehtiv API võti, kuid ebapiisavad õigused
• Ressursi ligipääsupiirangud
• Rollipõhised ligipääsupiirangud