Ukratko

  • API ključ je zaseban pristup za jedan vanjski sustav (webshop, agenciju, ERP). Ne dijelite vlastitu lozinku nego svakom sustavu napravite njegov ključ.
  • Ključ radi kao administrator koji ga je napravio, samo u toj poslovnici, i samo ono što mu dopustite.
  • Ključ se prikazuje samo jednom, kod izrade. Kigo čuva samo njegov sažetak, pa ga ni podrška ne može ponovno pročitati.
  • Ključ se može opozvati u svakom trenutku; opozvani ključ odmah prestaje raditi.
  • Ključevi rade kad je način prijave u API prebačen na API ključ (vidi niže).

Izrada ključa

  1. Otvorite Opcije → Integracije → API ključevi (vidi ga samo administrator računa).
  2. Kliknite Novi ključ i upišite Naziv ključa, npr. ime agencije ili sustava, da kasnije znate čiji je.
  3. Pod Što ključ smije odaberite prava (vidi niže) i kliknite Napravi ključ.
  4. Ključ se prikaže u prozoru: kopirajte ga gumbom Kopiraj i predajte sustavu koji ga koristi. Nakon gumba Gotovo više se ne može vidjeti; ako se izgubi, opozovite ga i napravite novi.

Prava ključa

  • Starter i Standard: Samo čitanje (artikli, grupe, kupci, računi i PDF računa) ili Čitanje i pisanje (uz to izrada i uređivanje artikala, grupa i kupaca te izrada, promjena statusa plaćanja i storno računa).
  • Business i viši paketi: uz to Odabrana prava, gdje se prava uključuju jedno po jedno: Artikli i grupe (pregled, kreiranje, uređivanje, grupe), Kupci (pregled, kreiranje, uređivanje), Računi (pregled i PDF, izrada i status plaćanja, storno).
  • Poziv koji ključ ne smije dobiva odgovor 403 s porukom This API key does not allow this action.
  • Šifrarnici načina plaćanja i statusa plaćanja dostupni su svakom ključu.

Za agenciju koja samo čita podatke dovoljno je Samo čitanje.

Korištenje ključa

Ključ se šalje u zaglavlju Authorization svakog poziva:

curl -H "Authorization: Bearer kgc_vas_kljuc" https://app.kigo.cloud/hr/api/v1/item/list

Svi pozivi i odgovori isti su kao u API dokumentaciji. Ograničenje broja poziva u minuti isto je kao do sada i ovisi o paketu.

Na popisu ključeva vidi se kada je svaki ključ zadnji put korišten.

Način prijave: Legacy ili API ključ

  • Račun se u API prijavljuje jednim od dva načina, nikad s oba: Legacy (korisničko ime i lozinka, zaglavlja X-USERNAME i X-PASSWORD) ili API ključ.
  • Zadano je Legacy, jer se tako prijavljuju WooCommerce dodatak bez upisanog ključa i starije integracije. Dok je odabran Legacy, API ključevi ne rade (401).
  • Ključeve možete napraviti unaprijed i predati ih sustavima. Kad ih svi koriste, na kartici Postavke ekrana API ključevi pod Način prijave u API odaberite API ključ i potvrdite s Prebaci.
  • Od tada rade samo ključevi, a Legacy prijava dobiva odbijenicu (401). Povratak na Legacy ide istim putem; ključevi ostaju na popisu.
Prije prebacivanja na API ključ provjerite da ga koriste svi vaši sustavi. U WooCommerce dodatku ključ se upisuje na kartici Connection (verzija 2.1.34 ili novija), s pravima Čitanje i pisanje; bez toga dodatak prestaje slati narudžbe. Shopify integracija ne ovisi o ovom izboru.