API

Gem Logic API Vam omogoča integracijo z zunanjimi sistemi in avtomatizacijo delovnih tokov. Uporabite ga lahko za programsko upravljanje produktov, prodaj, stikov, popravil, inventur in opravil tiskanja.

Pojdite na Nastavitve ‣ API za ustvarjanje in upravljanje Vaših API ključev.

Preverjanje pristnosti

Vsi zahtevki API morajo vključevati API ključ v HTTP glavi x-api-key. Ključe lahko ustvarite na strani Nastavitve ‣ API. Ključi so lahko kadar koli deaktivirani ali izbrisani.

Primer zahtevka:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Nevarno

Vaše API ključe ohranite skrivne. Nikoli jih ne delite v javnih repozitorijih ali kodi na strani odjemalca. Če je ključ ogrožen, ga takoj deaktivirajte in ustvarite novega.

Osnovni URL

Vsi končni parametri so relativni glede na URL Vaše instance, pod predpono /api/:

https://your-instance.gem-logic.com/api/

Oblika odziva

Vsi odzivi so vrnjeni kot JSON. Uspešni zahtevki vrnejo kodo stanja 200 (za GET) ali 201 (za POST). Napake vrnejo ustrezno kodo stanja s sporočilom:

  • 200 OK — uspešen zahtevek GET

  • 201 Created — uspešen zahtevek POST

  • 400 Bad Request — neveljavni ali manjkajoči podatki

  • 401 Unauthorized — neveljaven ali manjkajoč API ključ

  • 404 Not Found — vir ne obstaja

Končni parametri

Trgovski centri

Metoda

GET

URL

/api/marketplaces/

Opis

Vrne seznam vseh prodajnih kanalov.

Polja odziva:

Polje

Tip

Opis

id

integer

Edinstveni identifikator

marketplace

string

Ime tržnice

Izdelki

Seznam izdelkov

Metoda

GET

URL

/api/products/{marketplace_id}

Opis

Vrne izdelke, filtrirane po tržnici. Uporabite ID tržnice iz končne točke marketplaces.

Polja odziva:

Polje

Tip

Opis

id

integer

Edinstveni identifikator

item_sku

string

SKU izdelka

created

datetime

Datum ustvarjanja

status

string

Status izdelka

images

array

Seznam slik izdelka (id, image)

item_weight

decimal

Teža

item_height

decimal

Višina

item_length

decimal

Dolžina

item_width

decimal

Širina

Ustvari sliko izdelka

Metoda

POST

URL

/api/products/create/image/

Opis

Naloži sliko izdelka z uporabo kodiranja base64. Če SKU izdelka še ne obstaja, se samodejno ustvari nov izdelek.

Polja zahteve:

Polje

Tip

Obvezno

Opis

item_sku

string

Da

SKU izdelka, na katerega se pripne slika

image

string (base64)

Da

Podatki slike v base64 kodiranju

Prodaja

Seznam prodaj

Metoda

GET

URL

/api/sales/

Opis

Vrne seznam vseh prodajnih naročil.

Polja odziva:

Polje

Tip

Opis

order_id

string

Unikatni identifikator naročila

Ustvari prodajo

Metoda

POST

URL

/api/sales/create/

Opis

Ustvari novo prodajno naročilo.

Kontakti

Metoda

GET

URL

/api/contacts/

Opis

Vrne seznam vseh stikov.

Polja odziva:

Polje

Tip

Opis

id

integer

Edinstveni identifikator

complete_name

string

Polno ime

contact_type

string

Vrsta stika

email

string

E-poštni naslov

phone

string

Telefonska številka

language

string

Prednostni jezik

Popravila

Ustvarite popravilo

Metoda

POST

URL

/api/repairs/create/

Opis

Ustvari novo naročilo za popravilo z pripadajočim popravilnim artiklom. Če prodajno mesto ali oddelek nista podana, se uporabi prvo razpoložljivo.

Polja zahteve:

Polje

Tip

Obvezno

Opis

client_id

integer

Ne

ID stranke/kontakta

marketplace

niz / celo število

Ne

ID ali naziv prodajnega mesta

division_id

integer

Ne

ID poslovnega oddelka

title

string

Ne

Naslov ali opis popravilnega artikla

repair_info_1

string

Ne

Dodatni komentar popravila

repair_info_2

string

Ne

Dodatni komentar popravila

repair_info_3

string

Ne

Dodatni komentar popravila

quantity

decimal

Ne

Količina (privzeto: 1)

weight

decimal

Ne

Teža artikla

weight_unit

string

Ne

Enota za merjenje teže

size

string

Ne

Velikost artikla

color

string

Ne

Barva artikla

engravement

string

Ne

Besedilo gravure

client_reference | string

Ne

Referenčna številka stranke

Primer odgovora:

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

Dodaj artikel k popravilu

Metoda

POST

URL

/api/repairs/add-item/

Opis

Doda nov artikel k obstoječemu nalogu za popravilo.

Polja zahteve:

Polje

Tip

Obvezno

Opis

order_id

string

Da

ID naloga za popravilo, ki mu se bo dodal artikel

item_sku

string

Ne

SKU izdelka za povezavo z artiklom

title

string

Ne

Naslov ali opis

repair_info_1

string

Ne

Dodatni komentar popravila

repair_info_2

string

Ne

Dodatni komentar popravila

repair_info_3

string

Ne

Dodatni komentar popravila

quantity

decimal

Ne

Količina (privzeto: 1)

weight

decimal

Ne

Teža artikla

weight_unit

string

Ne

Enota za merjenje teže

size

string

Ne

Velikost artikla

color

string

Ne

Barva artikla

engravement

string

Ne

Besedilo gravure

client_reference | string

Ne

Referenčna številka stranke

cost

decimal

Ne

Strošek artikla

Štetja inventarja

Ustvari štetje inventarja

Metoda

POST

URL

/api/inventory-counts/

Opis

Ustvari novo sejo štetja inventarja.

Polja odziva:

Polje

Tip

Opis

id

string

ID štetja inventarja

created_at

datetime

Časovni žig ustvarjanja

status

string

Vedno active

tag_count

integer

Število prešteti izdelkov

Prikaži izdelke štetja inventarja

Metoda

GET

URL

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

Opis

Vrne vse izdelke preštete v določenem štetju inventarja.

Polja odziva:

Polje

Tip

Opis

id

string

Edinstveni identifikator

created_at

datetime

Kdaj je bil izdelek preštet

product_sku

string

SKU izdelka

product_name

string

Ime izdelka

quantity

integer

Prešteta količina

Interaktivni raziskovalec API

Gem Logic vključuje vgrajen interaktivni raziskovalec API, ki ga poganja Swagger UI. Dostopate lahko do njega prek povezave Dokumentacija API na strani Nastavitve ‣ API. Raziskovalec Vam omogoča, da vsako končno točko preskusite neposredno iz Vašega brskalnika.

Poglej Tudi