Dokumentacija

Autentifikacija

Saznajte kako autentifikovati svoje API zahtjeve koristeći API ključeve.

Pregled #

FireCustos API koristi autentifikaciju putem API ključeva. Svaki zahtjev mora sadržavati važeći API ključ u Authorization zaglavlju.

Izrada API ključeva #

API ključ pravi administrator jedinice u aplikaciji FireCustos:

  1. Prijavite se u FireCustos kao administrator jedinice
  2. U meniju otvorite Administracija, API ključevi
  3. Kliknite "Novi API ključ", upišite naziv po kojem ćete ga prepoznati i kliknite "Napravi ključ"
  4. Odmah kopirajte ključ: prikazuje se samo jednom
Important

API keys are prefixed with fc_ and are 68 characters long. The full key is displayed only once at creation — store it securely immediately.

Korištenje API ključeva #

Uključite API ključ u Authorization zaglavlje kao Bearer token:

bash
curl -X GET https://app.firecustos.com/api/v1/firefighters \
  -H "Authorization: Bearer fc_your_api_key_here"

Šta ključ smije #

Svaki ključ ima ovlasti (scopes) koje određuju šta smije raditi. Ključ bez odabranih ovlasti može samo čitati. Ovlasti se mogu promijeniti u bilo kojem trenutku i vrijede od sljedećeg zahtjeva.

Scope
api:firefighters.readČitanje spiska vatrogasaca. Za svakog člana: ime i prezime, telefon, e-mail, datum rođenja, zvanje, kategorija članstva, funkcije, broj intervencija i osposobljenosti, ima li račun i do kada je nedostupan
api:firefighters.writeDodavanje, uređivanje i brisanje vatrogasaca

Zahtjev izvan ovlasti ključa vraća 403 Forbidden:

json
{
  "status": 403,
  "title": "Forbidden",
  "detail": "You are not authorized to perform this action."
}

Sigurnost #

API ključevi su osjetljivi podaci. Pridržavajte se ovih najboljih praksi:

  • Nikada ne dijelite API ključeve u javnim repozitorijima ili klijentskom kodu
  • Koristite varijable okruženja za pohranu ključeva
  • Povremeno zamijenite ključeve: napravite novi, a stari opozovite
  • Svaki ključ se prije pohrane sažima algoritmom SHA-256, pa FireCustos nikada ne pohranjuje vaš ključ u čistom tekstu
  • Postavite datum isteka na ključeve kad je moguće

Greške autentifikacije #

Kada autentifikacija ne uspije, API vraća 401 Unauthorized odgovor:

API ključ nije naveden

json
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Missing or invalid Authorization header."
}

API ključ je nevažeći

json
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "Invalid API key."
}

API ključ je opozvan

json
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "API key has been revoked."
}

API ključ je istekao

json
{
  "status": 401,
  "title": "Unauthorized",
  "detail": "API key has expired."
}