API¶
Gem Logic API omogućava vam integraciju s vanjskim sustavima i automatizaciju radnih tokova. Možete ga koristiti za programsko upravljanje proizvodima, prodajom, kontaktima, popravcima, popisima inventara i poslovima ispisa.
Idite na kako biste stvorili i upravljali svojim API ključevima.
Autentifikacija¶
Svi API zahtjevi moraju sadržavati API ključ u HTTP zaglavlju x-api-key. Ključeve možete stvoriti sa stranice . Ključevi se mogu deaktivirati ili izbrisati u bilo kojem trenutku.
Primjer zahtjeva:
curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
-H "x-api-key: YOUR_API_KEY"
Opasnost
Čuvajte svoje API ključeve u tajnosti. Nikada ih ne dijelite u javnim spremištima ili kodu na strani klijenta. Ako je ključ kompromitiran, odmah ga deaktivirajte i stvorite novi.
Osnovni URL¶
Sve krajnje točke su relativne u odnosu na URL Vaše instance, pod prefiksom /api/:
https://your-instance.gem-logic.com/api/
Format odgovora¶
Svi odgovori se vraćaju kao JSON. Uspješni zahtjevi vraćaju kod statusa 200 (za GET) ili 201 (za POST). Greške vraćaju odgovarajući kod statusa s porukom:
200 OK — uspješan GET zahtjev
201 Created — uspješan POST zahtjev
400 Bad Request — nevažeći ili nedostajući podaci
401 Unauthorized — nevažeći ili nedostajući API ključ
404 Not Found — resurs ne postoji
Krajnje točke¶
Tržišta¶
Metoda |
|
|---|---|
URL |
|
Opis |
Vraća popis svih prodajnih kanala. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
integer |
Jedinstveni identifikator |
|
string |
Naziv tržišta |
Proizvodi¶
Popis proizvoda
Metoda |
|
|---|---|
URL |
|
Opis |
Vraća proizvode filtrirane po tržištu. Koristite ID tržišta iz krajnje točke marketplaces. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
integer |
Jedinstveni identifikator |
|
string |
SKU proizvoda |
|
datetime |
Datum stvaranja |
|
string |
Status proizvoda |
|
array |
Popis slika proizvoda ( |
|
decimal |
Težina |
|
decimal |
Visina |
|
decimal |
Duljina |
|
decimal |
Širina |
Stvorite sliku proizvoda
Metoda |
|
|---|---|
URL |
|
Opis |
Prenesite sliku proizvoda koristeći base64 kodiranje. Ako SKU proizvoda još ne postoji, novi proizvod se automatski stvara. |
Polja zahtjeva:
Polje |
Tip |
Obavezno |
Opis |
|---|---|---|---|
|
string |
Da |
SKU proizvoda na koji se veže slika |
|
string (base64) |
Da |
Podaci slike kodirani u base64 |
Prodaja¶
Popis prodaja
Metoda |
|
|---|---|
URL |
|
Opis |
Vraća popis svih prodajnih naloga. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
string |
Jedinstveni identifikator naloga |
Stvorite prodaju
Metoda |
|
|---|---|
URL |
|
Opis |
Stvara novi prodajni nalog. |
Kontakti¶
Metoda |
|
|---|---|
URL |
|
Opis |
Vraća popis svih kontakata. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
integer |
Jedinstveni identifikator |
|
string |
Puno ime |
|
string |
Vrsta kontakta |
|
string |
Adresa e-pošte |
|
string |
Telefonski broj |
|
string |
Preferirani jezik |
Popravci¶
Stvori popravak
Metoda |
|
|---|---|
URL |
|
Opis |
Stvara novi nalog za popravak s povezanim artiklom popravka. Ako prodajno mjesto ili odjel nisu navedeni, koristi se prvo dostupno. |
Polja zahtjeva:
Polje |
Tip |
Obavezno |
Opis |
|---|---|---|---|
|
integer |
Ne |
ID klijenta/kontakta |
|
string / integer |
Ne |
ID ili naziv prodajnog mjesta |
|
integer |
Ne |
ID poslovnog odjela |
|
string |
Ne |
Naslov ili opis artikla popravka |
|
string |
Ne |
Dodatni komentar o popravku |
|
string |
Ne |
Dodatni komentar o popravku |
|
string |
Ne |
Dodatni komentar o popravku |
|
decimal |
Ne |
Količina (zadano: 1) |
|
decimal |
Ne |
Težina artikla |
|
string |
Ne |
Jedinica mjerenja težine |
|
string |
Ne |
Veličina artikla |
|
string |
Ne |
Boja artikla |
|
string |
Ne |
Tekst gravure |
|
Ne |
Referentni broj klijenta |
|
Primjer odgovora:
{"message": "Repair created successfully.", "order_id": "R-0001"}
Dodaj artikl u popravak
Metoda |
|
|---|---|
URL |
|
Opis |
Dodaje novi artikl u postojeći nalog za popravak. |
Polja zahtjeva:
Polje |
Tip |
Obavezno |
Opis |
|---|---|---|---|
|
string |
Da |
ID naloga za popravak kojem se dodaje artikl |
|
string |
Ne |
SKU proizvoda koji se povezuje s artiklom |
|
string |
Ne |
Naslov ili opis |
|
string |
Ne |
Dodatni komentar o popravku |
|
string |
Ne |
Dodatni komentar o popravku |
|
string |
Ne |
Dodatni komentar o popravku |
|
decimal |
Ne |
Količina (zadano: 1) |
|
decimal |
Ne |
Težina artikla |
|
string |
Ne |
Jedinica mjerenja težine |
|
string |
Ne |
Veličina artikla |
|
string |
Ne |
Boja artikla |
|
string |
Ne |
Tekst gravure |
|
Ne |
Referentni broj klijenta |
|
|
decimal |
Ne |
Trošak artikla |
Popisi inventara¶
Kreiraj popis inventara
Metoda |
|
|---|---|
URL |
|
Opis |
Kreira novu sesiju popisa inventara. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
string |
ID popisa inventara |
|
datetime |
Vremenska oznaka kreiranja |
|
string |
Uvijek |
|
integer |
Broj popisanih proizvoda |
Prikaži proizvode popisa inventara
Metoda |
|
|---|---|
URL |
|
Opis |
Vraća sve proizvode popisane u određenom popisu inventara. |
Polja odgovora:
Polje |
Tip |
Opis |
|---|---|---|
|
string |
Jedinstveni identifikator |
|
datetime |
Kada je proizvod popisivan |
|
string |
SKU proizvoda |
|
string |
Naziv proizvoda |
|
integer |
Prebrojana količina |
Poslovi ispisa¶
Metoda |
|
|---|---|
URL |
|
Opis |
Prenijeti PDF datoteku u red čekanja za ispis na određeni pisač. Datoteka se provjerava na format i sigurnost. Maksimalna veličina datoteke je 20 MB. Koristite tip sadržaja |
Polja zahtjeva:
Polje |
Tip |
Obavezno |
Opis |
|---|---|---|---|
|
datoteka |
Da |
PDF datoteka za ispis (maks. 20 MB) |
|
UUID |
Da |
UUID ciljnog pisača |
|
boolean |
Ne |
Ispis u ležećem formatu (zadano: false) |
Primjer zahtjeva:
curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
-H "x-api-key: YOUR_API_KEY" \
-F "pdf=@document.pdf" \
-F "printer_uuid=YOUR_PRINTER_UUID"
Primjer odgovora:
{"status": "queued", "print_job_id": 42}
Interaktivni API preglednik¶
Gem Logic uključuje ugrađeni interaktivni API preglednik pokrenut Swagger UI-jem. Možete mu pristupiti putem poveznice API dokumentacija na stranici . Preglednik Vam omogućava da isprobate svaku krajnju točku izravno iz Vašeg preglednika.
Više informacija