APIPočetak
Autentifikacija
Ključevi, okruženja, pristupi, IP adrese i zamjena ključa bez prekida.
Svaki zahtjev nosi ključ u zaglavlju Authorization:
Authorization: Bearer cfr_live_6fN0cA2kQ9xR7vT1bL4mZ8pW3yH5gD0eAko vaš alat ne može postaviti Authorization, pošaljite isti ključ u x-api-key.
Okruženja
| Ključ | Okruženje | Šta vraća | Naplata |
|---|---|---|---|
cfr_live_… | Produkcija | Prave procjene, prave provjere | Po jedinici |
cfr_test_… | Sandbox | Prava provjera zahtjeva, fiksne vrijednosti | Besplatno |
Okruženja su potpuno odvojena: test ključ ne vidi procjene, praćena vozila ni webhookove live ključeva, i obrnuto. Više u Sandbox.
Pristup (scope)
Ključ može samo ono što mu dozvolite. Dajte svakom sistemu najmanji pristup koji treba.
| Pristup | Šta otvara |
|---|---|
valuations | Procjene (jedna, masovna, čitanje, prodajna cijena) i šifarnik. |
watchlist | Praćena vozila, dnevni izvještaj, alarmi i webhook adrese. |
listings | Historija vozila i signali Provjere, i šifarnik. |
widgets | Objava procjena kao widgeta na vašoj stranici (samo produkcijski ključ). |
Zahtjev bez potrebnog pristupa vraća 403 insufficient_scope.
Zaštita ključa
| Postavka | Šta radi | Greška |
|---|---|---|
| Dozvoljene IP adrese | Ključ radi samo s navedenih adresa ili CIDR raspona (do 50). | 403 ip_not_allowed |
| Mjesečni limit | Ključ troši najviše toliko jedinica mjesečno, i kad ugovor ima više. | 429 key_limit_reached |
| Datum isteka | Ključ prestaje raditi tog dana. | 401 token_expired |
| Pauza | Privremeno zaustavlja ključ; nastavlja se jednim klikom. | 403 key_paused |
Sve se mijenja na platformi bez novog ključa; API vidi promjenu za najviše 30 sekundi.
Zamjena ključa bez prekida
- 1
Zamijenite ključ na platformi
U Razvoj → API ključevi odaberite Zamijeni ključ. Dobijate novi ključ s istim pristupom i postavkama, a stari radi još 1 sat, 24 sata ili 7 dana — vi birate.
- 2
Postavite novi ključ
Uvedite novi ključ u svoje servere. Zahtjevi sa starog i novog ključa vide se odvojeno u logu zahtjeva.
- 3
Pustite stari da istekne
Kad stari ključ više nema zahtjeva, opozovite ga ili ga pustite da istekne sam.
Ako ključ procuri
Procuren ključ odmah opozovite (ne pauzirajte): opozvan ključ vraća401 invalid_token i ne može se vratiti.Ključ ne ide u preglednik
Ključ je tajna vaše kompanije: zovite API sa svog servera, nikad iz mobilne aplikacije ili JavaScripta u pregledniku. Jedini izuzetak je „Isprobaj” u ovoj dokumentaciji: šalje ključ samo direktno na api.cifra.ba, a pamti ga najduže do zatvaranja kartice, i to samo ako to izaberete. Za isprobavanje koristite testni ključ.