Išbandyk

Verskis API

Gaukite pagalbą gyvame pokalbyje - detaliai aprašykite poreikį ir ką norite pasiekti.

Verskis API

Verskis API yra techninė sąsaja, skirta automatizuoti duomenų mainus tarp el. parduotuvės ir išorinių sistemų, pavyzdžiui, sandėlio, buhalterijos, siuntų ar kitų integracijų.

Kur rasti administravime: Nustatymai > Trečiųjų šalių integracijos > verskis.lt API
API sąsaja gali priklausyti nuo plano arba papildomo modulio

Jeigu skilties „verskis.lt API“ nematote arba negalite sugeneruoti API rakto, patikrinkite, ar API sąsaja įjungta Jūsų el. parduotuvei.

API raktas yra konfidencialus

Niekada neskelbkite API rakto nepatikimoms šalims. API raktas yra konfidenciali informacija.

API raktą perduokite tik patikimam programuotojui arba integracijos partneriui.

Ką matysite API skiltyje?

API raktas
Rodoma, ar API raktas jau sugeneruotas. Jeigu matote pranešimą „API raktas nerastas“, API prieiga dar nėra sukurta.
Sugeneruoti naują API raktą
Sukuria API raktą, kurį galima perduoti integracijai arba programuotojui.
Pašalinti API raktą
Panaikina esamą API raktą. Po pašalinimo sistema arba partneris, naudojantis šį raktą, nebegalės prisijungti prie API.
Atsisiųsti Verskis API dokumentaciją
Atsiunčia techninę dokumentaciją su API naudojimo aprašymu ir pavyzdžiais.
Client
Integracijos arba kliento pavadinimas, kuriam priskirtas konkretus API raktas, jeigu tokia informacija rodoma.
API key
Partneriui arba integracijai skirtas API raktas. Jo viešai neskelbkite ir nesiųskite nepatikimais kanalais.

Kaip paruošti API prieigą?

1

Administravime atidarykite Nustatymai > Trečiųjų šalių integracijos > verskis.lt API.

2

Jeigu API raktas dar nesukurtas, spauskite „Sugeneruoti naują API raktą“.

3

Atsisiųskite techninę dokumentaciją per „Atsisiųsti Verskis API dokumentaciją“.

4

API raktą ir dokumentaciją perduokite tik patikimam programuotojui arba integracijos partneriui.

5

Integracijos partneris pagal dokumentaciją prijungia savo sistemą prie Jūsų el. parduotuvės API.

Kiekvienai integracijai naudokite atskirą prieigą, kai tai įmanoma

Jeigu API naudoja keli partneriai ar kelios sistemos, saugiau turėti atskiras prieigas. Taip lengviau suprasti, kas naudoja API, ir prireikus išjungti tik konkrečią integraciją.

Ką galima atlikti su API?

Prekių valdymas
  • Atnaujinti kiekius, kainas, bazines kainas ir PVM tarifus.
  • Nustatyti kelių kainoraščių reikšmes.
  • Pridėti akcijines kainas su nuolaida.
  • Automatiškai sinchronizuoti prekių duomenis pagal pasirinktą grafiką, pavyzdžiui, kas valandą perduoti tik pasikeitusius duomenis, o naktį atnaujinti visą asortimentą.
Užsakymų gavimas
  • Gauti visą informaciją apie užsakymus: kliento duomenis, pristatymo būdus, prekes, sumas, nuolaidas, kuponus ir mokėjimus.
  • Filtruoti užsakymus pagal laiką, statusą ar kitus kriterijus.
Sąskaitų gavimas
  • Atsisiųsti sąskaitas faktūras su visa reikalinga informacija, susieta su užsakymais.
  • Filtruoti sąskaitas pagal datą ir statusą.
Užsakymų būsenų valdymas
  • Patvirtinti užsakymą.
  • Pažymėti užsakymą kaip apmokėtą, supakuotą ar išsiųstą.
  • Atšaukti užsakymą.
  • Patikrinti dabartines užsakymo būsenas.
Siuntos sekimas
  • Priskirti arba atnaujinti siuntos sekimo numerį.

Techninė informacija

Duomenų mainai
Duomenų mainai vyksta per saugų HTTPS protokolą, naudojant JSON formatą.
Autentifikacija
Prieiga suteikiama naudojant API raktą. API raktas perduodamas Api-Key antraštėje.
Greitaveikos limitai
Įprastas limitas yra 30 užklausų per minutę. Informacija apie limitus pateikiama Rate-Limit antraštėse.
Atsakymai
API grąžina standartizuotus HTTP kodus, pavyzdžiui, 200, 202, 400, 401, 429 ir 500.

API dokumentacija

Pilną techninę dokumentaciją su pavyzdžiais galite atsisiųsti el. parduotuvės administravimo zonoje.

Kur atsisiųsti dokumentaciją: Nustatymai > Trečiųjų šalių integracijos > verskis.lt API
Dokumentacija skirta techniniam specialistui

Jeigu API jungia išorinė sistema, dokumentaciją perduokite programuotojui arba integracijos partneriui. Joje pateikiami techniniai metodai, užklausų struktūra ir atsakymų pavyzdžiai.

Kada pašalinti API raktą?

1

Pašalinkite API raktą, jeigu nutraukėte darbą su partneriu, kuriam raktas buvo perduotas.

2

Pašalinkite API raktą, jeigu įtariate, kad jis galėjo būti paviešintas ar perduotas nepatikimai šaliai.

3

Po pašalinimo, jei integracija vis dar reikalinga, sugeneruokite naują API raktą ir perduokite jį tik atsakingam partneriui.

Pašalinus API raktą integracija sustos

Jeigu išorinė sistema naudojo pašalintą API raktą, ji nebegalės gauti ar perduoti duomenų, kol nebus įvestas naujas galiojantis API raktas.

Dažniausios problemos

Rodoma „API raktas nerastas“

Tai reiškia, kad API raktas dar nesugeneruotas arba buvo pašalintas. Jeigu API prieiga reikalinga, spauskite „Sugeneruoti naują API raktą“.

Partneris gauna 401 klaidą

401 dažniausiai reiškia, kad API raktas neteisingas, pašalintas arba neperduodamas Api-Key antraštėje. Patikrinkite, ar partneris naudoja naujausią galiojantį API raktą.

Partneris gauna 429 klaidą

429 reiškia, kad viršytas užklausų limitas. Patikrinkite integracijos grafiką ir sumažinkite užklausų kiekį, pavyzdžiui, dažniau perduokite tik pasikeitusius duomenis, o visą asortimentą atnaujinkite rečiau.

Duomenys nesinchronizuojami
  • Patikrinkite, ar API raktas sugeneruotas ir nepašalintas.
  • Patikrinkite, ar partneris naudoja teisingą API raktą.
  • Patikrinkite, ar užklausos siunčiamos per HTTPS ir JSON formatu.
  • Patikrinkite, ar neviršijami užklausų limitai.
  • Patikrinkite, ar integracijos partneris naudoja aktualią API dokumentaciją.
Susiję pagalbos puslapiai