API dokumentacija za KPD 2025 klasifikaciju i integraciju
Detaljna REST dokumentacija za ERP, kataloge, webshopove i interne sustave: autentifikacija, endpointi, request i response schema, status kodovi, retry pravila i primjeri integracije za više jezika.
Kako API radi u stvarnom workflowu
Vanjski sustav pošalje opis stavke i opcionalni poslovni kontekst. Servis vraća strukturirani JSON s najjačim KPD prijedlogom, povezanim NKD smjerom, confidence signalom, warnings i alternativama. Taj rezultat možete odmah spremiti uz artikl, dokument, cjenik ili interni audit trag.
Za vanjske integracije koristite verzionirani endpoint /api/v1/classify s API ključem. Endpoint /api/status služi za health check. Interna same-origin klasifikacija kroz korisničku sesiju postoji zasebno, ali za ERP, webshop, middleware ili queue rad preporuka je uvijek ići na javni verzionirani API.
Primarna uporaba
ERP, webshop, POS, batch importi, sinkronizacija kataloga i interni middleware servisi.
Minimalan payload
Dovoljno je poslati query. Za višu točnost preporučeno je poslati i type te po potrebi supplement.
Operativni rezultat
Osim koda, dobivate i signal sigurnosti, warnings i follow-up pitanja za rubne i miješane slučajeve.
Endpointi
Autorizacija
Authorization: Bearer <API_KEY> je preporučeni način. Podržan je i X-API-Key.
Format
Request i response su JSON. Za stabilan rad pošaljite i Accept: application/json.
Timeout
Praktična preporuka za klijentski timeout je 15–20 sekundi uz retry samo za 429 i 5xx odgovore.
Polja zahtjeva
| Polje | Tip | Obavezno | Opis |
|---|---|---|---|
query | string | Da | Opis stvarne stavke, usluge, robe ili procesa koji želite klasificirati. |
type | string | Ne | Kontekst isporuke, npr. Usluge, Prodaja na veliko, Prodaja na malo, Proizvodnja. |
context | string | Ne | Alternativni naziv za isto polje; servis prihvaća type ili context. |
supplement | string | Ne | Dodatna nadopuna opisa kad osnovni naziv nije dovoljno precizan. |
meta | object | Ne | Vaš interni identifikator artikla, dokumenta, reda cjenika ili izvora podataka. |
Najveću razliku u točnosti obično ne radi sam naziv proizvoda, nego točan opis poslovnog modela: prodaja, usluga, ugradnja, održavanje, najam, otkup, obrada ili proizvodnja.
Preporučeni zahtjev
Kad koristiti supplement
Kad osnovni naziv ne razlikuje dovoljno jasno prodaju, uslugu, ugradnju, obradu, otkup ili reciklažu.
Kad koristiti type
Kad vaš sustav već zna je li riječ o robi, usluzi, proizvodnji ili prodajnom kanalu.
Vanjski API odgovor
Javni verzionirani endpoint /api/v1/classify vraća sažeti, stabilni response format namijenjen integracijama. Ključna polja su ispod.
Status kodovi i retry pravila
200
Zahtjev je uspješno obrađen i vraćen je klasifikacijski rezultat.
400
Payload nije valjan, nedostaje query ili su vrijednosti u krivom formatu.
401
API ključ nedostaje, nije valjan ili je opozvan.
403
Ključ postoji, ali nema pravo pristupa resursu ili domena nije dopuštena.
405
Ruta postoji, ali metoda nije podržana.
429
Dosegnut je limit zahtjeva; poštujte Retry-After header.
500
Privremena interna greška; uvedite retry s backoff logikom.
429 rate limit
Poštujte Retry-After header i uvedite kontrolirani retry. Nemojte odmah slati isti zahtjev u petlji.
5xx odgovori
Preporuka je eksponencijalni backoff, npr. 1 s → 2 s → 4 s, uz ograničen broj pokušaja.
4xx odgovori
To su u pravilu poslovne ili autorizacijske greške i obično ih ne treba slijepo retryati bez promjene payloada ili ključa.
Operativne preporuke za produkciju
API je dovoljno jednostavan za izravne pozive, ali u ozbiljnijoj integraciji vrijedi nekoliko pravila koja pomažu da rezultat ostane auditabilan i upotrebljiv i kad opis nije savršen.
Spremite originalni input
Uz rezultat zadržite i izvorni query, poslovni kontekst i interni identifikator stavke.
Ne ignorirajte warnings
Warnings i follow-up pitanja služe upravo za rubne i miješane slučajeve gdje jedna kriva podkategorija može biti skupa.
Radite audit trail
Spremite korisničku odluku kad operator ručno potvrdi ili zamijeni šifru. To kasnije pomaže i u internoj validaciji.
Status endpoint
Health endpoint je koristan za deploy pipeline, nadzor dostupnosti i jednostavne readiness provjere prije većeg batch slanja.
Primjeri integracije za više programskih jezika
API koristi standardni HTTP + JSON pa ga možete integrirati iz praktično bilo kojeg jezika, frameworka ili job workera koji zna poslati HTTPS zahtjev.
Idempotentni retry i operativna pravila
Za produkcijske integracije preporuka je da zahtjev prema klasifikatoru tretirate kao zapisivu poslovnu operaciju: pošaljite čisti opis stavke, spremite originalni payload, odgovor i odluku operatera te retry radite samo za stvarno privremene greške.
Retry
Ponovite zahtjev samo za 429 i 5xx uz exponential backoff. Za 400, 401 i 403 problem je u payloadu ili autorizaciji i retry bez izmjene nema smisla.
Idempotency
Preporuka je da u vlastitom sustavu spremite hash opisa + konteksta i isti zahtjev ne šaljete više puta ako rezultat već postoji i operator ga je potvrdio.
Audit trail
Za rubne slučajeve spremite i upozorenja, follow-up pitanja i konačnu ručnu odluku. To je najkorisniji trag kad kasnije čistite katalog ili radite batch korekcije.
Brzi checklist
1. Čisti input
Ne šaljite količine, cijene, PDV i interne oznake ako nisu važne za stvarnu klasifikaciju.
2. Stabilan timeout
Držite klijentski timeout oko 15–20 sekundi i obavezno logirajte response body za greške.
3. Manual override
Omogućite operatoru ručnu korekciju i povratnu informaciju kad opis miješa robu, uslugu, najam, upravljanje ili obradu.
API je pogodan i za prilagođene integracijske modele
Ako trebate veći promet, više klijenata, zasebni sandbox/prod workflow, internu queue obradu ili pomoć oko mapiranja KPD rezultata u vaš ERP, javite se s kratkim opisom sustava i očekivanog volumena.