API ključi

Avtenticirajte API zahteve z varnimi API ključi.

Pregled

API ključi vam omogočajo:

• Avtenticiranje API zahtev
• Integracijo z zunanjimi sistemi
• Avtomatizacijo delovnih tokov foto zahtev
• Gradnjo prilagojenih aplikacij

Zahteva paketa

Dostop do API zahteva paket, ki vključuje funkcije API.

Ustvarjanje API ključa

Koraki

1. Pojdite na API ključi v stranski vrstici
2. Kliknite Ustvari API ključ
3. Vnesite opisno ime
4. Preklopite Aktiven (privzeto: vključeno)
5. Kliknite Ustvari

Shranite svoj ključ

Enkratni prikaz

Celoten API ključ je prikazan samo enkrat ob ustvaritvi. Kopirajte in ga varno shranite. Pozneje ga ne morete pridobiti.

Po ustvaritvi:

• Takoj kopirajte ključ
• Shranite na varno lokacijo
• Nikoli ne delite javno

Uporaba API ključev

Avtentikacijska glava

Vključite API ključ v glave zahtev:

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

Ime glave

Glava	Vrednost
X-API-Key	Vaš API ključ

Primer zahteve

# Ustvarite foto zahtevo
curl -X POST "https://api.visio.now/v1/photo-requests" \
  -H "X-API-Key: vsk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "instructions": "Prosimo, pošljite fotografije vozila",
    "photo_slots": [
      {"instructions": "Pogled spredaj", "is_required": true},
      {"instructions": "Pogled zadaj", "is_required": true}
    ]
  }'

Upravljanje API ključev

Ogled ključev

Seznam API ključev prikazuje:

• Ime ključa
• Prikrit ključ (delni prikaz)
• Status aktiven/neaktiven
• Datum zadnje uporabe
• Datum ustvarjanja

Urejanje ključa

1. Kliknite ikono za urejanje
2. Posodobite ime
3. Preklopite status aktivnosti
4. Shranite spremembe

Deaktivacija ključa

Začasno onemogočite ključ:

1. Kliknite Deaktiviraj na ključu
2. Potrdite dejanje
3. Ključ takoj preneha delovati

Aktivacija ključa

Ponovno omogočite deaktiviran ključ:

1. Kliknite Aktiviraj na ključu
2. Potrdite dejanje
3. Ključ takoj znova deluje

Regeneracija ključa

Ustvarite novo vrednost ključa:

1. Kliknite Regeneriraj
2. Potrdite dejanje (stari ključ preneha delovati)
3. Takoj kopirajte novi ključ

Takojšnja razveljavitev

Regeneracija takoj razveljavi stari ključ. Posodobite vse integracije pred regeneracijo.

Brisanje ključa

Trajno odstranite ključ:

1. Kliknite Izbriši
2. Potrdite dejanje
3. Ključ je trajno odstranjen

Format API ključa

Ključi sledijo temu formatu:

vsk_[okolje]_[naključni-niz]

Predpona	Okolje
vsk_live_	Produkcija
vsk_test_	Testiranje

Varnostne najboljše prakse

Shranjevanje ključev

• Shranite v spremenljivke okolja
• Uporabite sisteme za upravljanje skrivnosti
• Nikoli ne commitajte v nadzor različic
• Ne vključujte v kodo na strani odjemalca

Rotacija ključev

• Periodično rotirajte ključe
• Takoj rotirajte, če so kompromitirani
• Uporabljajte kratkotrajne ključe za testiranje

Nadzor dostopa

• Ustvarite ločene ključe za vsako integracijo
• Uporabite opisna imena
• Spremljajte uporabo ključev
• Deaktivirajte neuporabljene ključe

Česa NE storiti

• Deliti ključe v e-pošti
• Objavljati ključe v klepetu/Slacku
• Vključiti v URL-je
• Shraniti v datoteke z navadnim besedilom

Omejitve hitrosti

API zahteve so omejene po hitrosti:

Omejitev	Vrednost
Na minuto	60 zahtev
Na uro	1.000 zahtev

Glave omejitve hitrosti

Odgovori vključujejo:

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

Presežena omejitev

Ko je presežena:

• HTTP 429 odgovor
• Poskusite znova po navedenem času
• Implementirajte eksponentno upočasnitev

Odpravljanje težav

401 Nepooblaščeno

Vzroki:

• Neveljaven API ključ
• Ključ je deaktiviran
• Ključ je bil izbrisan/regeneriran
• Manjkajoča glava

Rešitve:

1. Preverite, ali je ključ pravilen
2. Preverite, ali je ključ aktiven
3. Po potrebi regenerirajte

403 Prepovedano

Vzroki:

• Ključ nima dovoljenja
• Funkcija ni v paketu
• Omejitve delovnega prostora

Rešitve:

1. Preverite funkcije paketa
2. Preverite lastništvo ključa
3. Obrnite se na podporo

Ključ se ne prikazuje

Če ste izgubili ključ:

1. Originala ni mogoče pridobiti
2. Regenerirajte za novega
3. Posodobite vse integracije

Omejitve ključev

Glede na paket

Paket	Maks. API ključev
Profesionalni	5 ključev
Poslovni	Neomejeno

Priporočila

• Produkcija: 1 ključ na integracijo
• Razvoj: Ločeni ključi za testiranje
• CI/CD: Namenski ključ za uvajanje

Povezane strani

• API referenca - Celotna API dokumentacija
• Webhooks - Obvestila v realnem času
• Integracije - Vnaprej zgrajene integracije