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 Postavke ‣ API 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 Postavke ‣ API. 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

GET

URL

/api/marketplaces/

Opis

Vraća popis svih prodajnih kanala.

Polja odgovora:

Polje

Tip

Opis

id

integer

Jedinstveni identifikator

marketplace

string

Naziv tržišta

Proizvodi

Popis proizvoda

Metoda

GET

URL

/api/products/{marketplace_id}

Opis

Vraća proizvode filtrirane po tržištu. Koristite ID tržišta iz krajnje točke marketplaces.

Polja odgovora:

Polje

Tip

Opis

id

integer

Jedinstveni identifikator

item_sku

string

SKU proizvoda

created

datetime

Datum stvaranja

status

string

Status proizvoda

images

array

Popis slika proizvoda (id, image)

item_weight

decimal

Težina

item_height

decimal

Visina

item_length

decimal

Duljina

item_width

decimal

Širina

Stvorite sliku proizvoda

Metoda

POST

URL

/api/products/create/image/

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

item_sku

string

Da

SKU proizvoda na koji se veže slika

image

string (base64)

Da

Podaci slike kodirani u base64

Prodaja

Popis prodaja

Metoda

GET

URL

/api/sales/

Opis

Vraća popis svih prodajnih naloga.

Polja odgovora:

Polje

Tip

Opis

order_id

string

Jedinstveni identifikator naloga

Stvorite prodaju

Metoda

POST

URL

/api/sales/create/

Opis

Stvara novi prodajni nalog.

Kontakti

Metoda

GET

URL

/api/contacts/

Opis

Vraća popis svih kontakata.

Polja odgovora:

Polje

Tip

Opis

id

integer

Jedinstveni identifikator

complete_name

string

Puno ime

contact_type

string

Vrsta kontakta

email

string

Adresa e-pošte

phone

string

Telefonski broj

language

string

Preferirani jezik

Popravci

Stvori popravak

Metoda

POST

URL

/api/repairs/create/

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

client_id

integer

Ne

ID klijenta/kontakta

marketplace

string / integer

Ne

ID ili naziv prodajnog mjesta

division_id

integer

Ne

ID poslovnog odjela

title

string

Ne

Naslov ili opis artikla popravka

repair_info_1

string

Ne

Dodatni komentar o popravku

repair_info_2

string

Ne

Dodatni komentar o popravku

repair_info_3

string

Ne

Dodatni komentar o popravku

quantity

decimal

Ne

Količina (zadano: 1)

weight

decimal

Ne

Težina artikla

weight_unit

string

Ne

Jedinica mjerenja težine

size

string

Ne

Veličina artikla

color

string

Ne

Boja artikla

engravement

string

Ne

Tekst gravure

client_reference | string

Ne

Referentni broj klijenta

Primjer odgovora:

{"message": "Repair created successfully.", "order_id": "R-0001"}

Dodaj artikl u popravak

Metoda

POST

URL

/api/repairs/add-item/

Opis

Dodaje novi artikl u postojeći nalog za popravak.

Polja zahtjeva:

Polje

Tip

Obavezno

Opis

order_id

string

Da

ID naloga za popravak kojem se dodaje artikl

item_sku

string

Ne

SKU proizvoda koji se povezuje s artiklom

title

string

Ne

Naslov ili opis

repair_info_1

string

Ne

Dodatni komentar o popravku

repair_info_2

string

Ne

Dodatni komentar o popravku

repair_info_3

string

Ne

Dodatni komentar o popravku

quantity

decimal

Ne

Količina (zadano: 1)

weight

decimal

Ne

Težina artikla

weight_unit

string

Ne

Jedinica mjerenja težine

size

string

Ne

Veličina artikla

color

string

Ne

Boja artikla

engravement

string

Ne

Tekst gravure

client_reference | string

Ne

Referentni broj klijenta

cost

decimal

Ne

Trošak artikla

Popisi inventara

Kreiraj popis inventara

Metoda

POST

URL

/api/inventory-counts/

Opis

Kreira novu sesiju popisa inventara.

Polja odgovora:

Polje

Tip

Opis

id

string

ID popisa inventara

created_at

datetime

Vremenska oznaka kreiranja

status

string

Uvijek active

tag_count

integer

Broj popisanih proizvoda

Prikaži proizvode popisa inventara

Metoda

GET

URL

/api/inventory-counts/{inventory_count_id}/products/

Opis

Vraća sve proizvode popisane u određenom popisu inventara.

Polja odgovora:

Polje

Tip

Opis

id

string

Jedinstveni identifikator

created_at

datetime

Kada je proizvod popisivan

product_sku

string

SKU proizvoda

product_name

string

Naziv proizvoda

quantity

integer

Prebrojana količina

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 Postavke ‣ API. Preglednik Vam omogućava da isprobate svaku krajnju točku izravno iz Vašeg preglednika.

Više informacija