Skip to content

API ključevi

Autentificirajte API zahtjeve sa sigurnim API ključevima.

Nadzorna ploča API ključeva

Pregled

API ključevi vam omogućuju:

  • Autentifikaciju API zahtjeva
  • Integraciju s vanjskim sustavima
  • Automatizaciju tijekova rada zahtjeva za fotografije
  • Izgradnju prilagođenih aplikacija

Zahtjev plana

Pristup API-ju zahtijeva plan koji uključuje API značajke.

Kreiranje API ključa

Koraci

  1. Idite na API ključevi u bočnoj traci
  2. Kliknite Kreiraj API ključ
  3. Unesite opisni naziv
  4. Uključite Aktivan (zadano: uključeno)
  5. Kliknite Kreiraj

Spremite svoj ključ

Jednokratni prikaz

Potpuni API ključ prikazuje se samo jednom prilikom kreiranja. Kopirajte ga i sigurno pohranite. Ne možete ga kasnije dohvatiti.

Nakon kreiranja:

  • Odmah kopirajte ključ
  • Pohranite na sigurnu lokaciju
  • Nikad ne dijelite javno

Korištenje API ključeva

Zaglavlje autentifikacije

Uključite API ključ u zaglavlja zahtjeva:

bash
curl -X GET "https://api.visio.now/v1/status" \
  -H "X-API-Key: vas-api-kljuc-ovdje"

Naziv zaglavlja

ZaglavljeVrijednost
X-API-KeyVaš API ključ

Primjer zahtjeva

bash
# Kreirajte zahtjev za fotografije
curl -X POST "https://api.visio.now/v1/photo-requests" \
  -H "X-API-Key: vsk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "instructions": "Molimo pošaljite fotografije vozila",
    "photo_slots": [
      {"instructions": "Prednji pogled", "is_required": true},
      {"instructions": "Stražnji pogled", "is_required": true}
    ]
  }'

Upravljanje API ključevima

Pregled ključeva

Popis API ključeva prikazuje:

  • Naziv ključa
  • Maskirani ključ (djelomični prikaz)
  • Status aktivno/neaktivno
  • Datum zadnjeg korištenja
  • Datum kreiranja

Uredi ključ

  1. Kliknite ikonu za uređivanje
  2. Ažurirajte naziv
  3. Uključite/isključite aktivni status
  4. Spremite promjene

Deaktiviraj ključ

Privremeno onemogućite ključ:

  1. Kliknite Deaktiviraj na ključu
  2. Potvrdite akciju
  3. Ključ odmah prestaje raditi

Aktiviraj ključ

Ponovno omogućite deaktivirani ključ:

  1. Kliknite Aktiviraj na ključu
  2. Potvrdite akciju
  3. Ključ odmah ponovno radi

Regeneriraj ključ

Kreirajte novu vrijednost ključa:

  1. Kliknite Regeneriraj
  2. Potvrdite akciju (stari ključ prestaje raditi)
  3. Odmah kopirajte novi ključ

Trenutna invalidacija

Regeneriranje trenutno invalidira stari ključ. Ažurirajte sve integracije prije regeneriranja.

Obriši ključ

Trajno uklonite ključ:

  1. Kliknite Obriši
  2. Potvrdite akciju
  3. Ključ je trajno uklonjen

Format API ključa

Ključevi slijede ovaj format:

vsk_[okruženje]_[nasumični-string]
PrefiksOkruženje
vsk_live_Produkcija
vsk_test_Testiranje

Najbolje sigurnosne prakse

Pohrana ključeva

  • Pohranite u varijable okruženja
  • Koristite sustave za upravljanje tajnama
  • Nikad ne commitajte u kontrolu verzija
  • Ne uključujte u klijentski kod

Rotacija ključeva

  • Periodički rotirajte ključeve
  • Odmah rotirajte ako je kompromitiran
  • Koristite kratkotrajne ključeve za testiranje

Kontrola pristupa

  • Kreirajte zasebne ključeve po integraciji
  • Koristite opisne nazive
  • Pratite korištenje ključeva
  • Deaktivirajte nekorištene ključeve

Što NE raditi

  • Dijeliti ključeve u e-poštama
  • Objavljivati ključeve u chatu/Slacku
  • Uključivati u URL-ove
  • Pohranjivati u obične tekstualne datoteke

Ograničenje brzine

API zahtjevi imaju ograničenje brzine:

OgraničenjeVrijednost
Po minuti60 zahtjeva
Po satu1.000 zahtjeva

Zaglavlja ograničenja brzine

Odgovori uključuju:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1609459200

Prekoračeno ograničenje

Kada je prekoračeno:

  • HTTP 429 odgovor
  • Pokušajte ponovno nakon naznačenog vremena
  • Implementirajte eksponencijalno povlačenje

Rješavanje problema

401 Neautoriziran

Uzroci:

  • Nevažeći API ključ
  • Ključ je deaktiviran
  • Ključ je obrisan/regeneriran
  • Nedostaje zaglavlje

Rješenja:

  1. Provjerite je li ključ ispravan
  2. Provjerite je li ključ aktivan
  3. Regenerirajte ako je potrebno

403 Zabranjeno

Uzroci:

  • Ključ nema dozvolu
  • Značajka nije u planu
  • Ograničenja radnog prostora

Rješenja:

  1. Provjerite značajke plana
  2. Provjerite vlasništvo ključa
  3. Kontaktirajte podršku

Ključ se ne prikazuje

Ako ste izgubili ključ:

  1. Original se ne može dohvatiti
  2. Regenerirajte za dobivanje novog
  3. Ažurirajte sve integracije

Ograničenja ključeva

Po planu

PlanMaks. API ključeva
Professional5 ključeva
EnterpriseNeograničeno

Preporuke

  • Produkcija: 1 ključ po integraciji
  • Razvoj: Zasebni ključevi za testiranje
  • CI/CD: Namjenski ključ za deployment

Povezane stranice

Profesionalna Platforma za Foto Dokumentaciju