API

Gem Logic API Vám umožňuje integrovať externé systémy a automatizovať pracovné toky. Môžete ho použiť na programové spravovanie produktov, predajov, kontaktov, opráv, inventúr a tlačových úloh.

Prejdite na Nastavenia ‣ API a vytvorte a spravujte svoje API kľúče.

Autentifikácia

Všetky API požiadavky musia obsahovať API kľúč v HTTP hlavičke x-api-key. Kľúče môžete vytvoriť na stránke Nastavenia ‣ API. Kľúče je možné kedykoľvek deaktivovať alebo zmazať.

Príklad požiadavky:

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

Nebezpečné

Uchovávajte svoje API kľúče v tajnosti. Nikdy ich nezdieľajte vo verejných repozitároch ani v kóde na strane klienta. Ak dôjde ku kompromitácii kľúča, okamžite ho deaktivujte a vytvorte nový.

Základná URL

Všetky endpointy sú relatívne k URL Vašej inštancie, pod prefixom /api/:

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

Formát odpovede

Všetky odpovede sú vrátené ako JSON. Úspešné požiadavky vrátia stavový kód 200 (pre GET) alebo 201 (pre POST). Chyby vrátia príslušný stavový kód so správou:

  • 200 OK — úspešná GET požiadavka

  • 201 Created — úspešná POST požiadavka

  • 400 Bad Request — neplatné alebo chýbajúce dáta

  • 401 Unauthorized — neplatný alebo chýbajúci API kľúč

  • 404 Not Found — zdroj neexistuje

Endpointy

Trhoviska

Metóda

GET

URL

/api/marketplaces/

Popis

Vracia zoznam všetkých predajných kanálov.

Polia odpovede:

Pole

Typ

Popis

id

integer

Jedinečný identifikátor

marketplace

string

Názov trhoviska

Produkty

Zoznam produktov

Metóda

GET

URL

/api/products/{marketplace_id}

Popis

Vracia produkty filtrované podľa trhoviska. Použite ID trhoviska z koncového bodu marketplaces.

Polia odpovede:

Pole

Typ

Popis

id

integer

Jedinečný identifikátor

item_sku

string

SKU produktu

created

datetime

Dátum vytvorenia

status

string

Stav produktu

images

array

Zoznam obrázkov produktu (id, image)

item_weight

decimal

Hmotnosť

item_height

decimal

Výška

item_length

decimal

Dĺžka

item_width

decimal

Šírka

Vytvoriť obrázok produktu

Metóda

POST

URL

/api/products/create/image/

Popis

Nahráva obrázok produktu pomocou base64 kódovania. Ak SKU produktu ešte neexistuje, nový produkt sa vytvorí automaticky.

Polia požiadavky:

Pole

Typ

Požadované

Popis

item_sku

string

Áno

SKU produktu, ku ktorému sa pripojí obrázok

image

string (base64)

Áno

Údaje obrázka kódované base64

Predaj

Zobraziť predaje

Metóda

GET

URL

/api/sales/

Popis

Vráti zoznam všetkých objednávok predaja.

Polia odpovede:

Pole

Typ

Popis

order_id

string

Unikátny identifikátor objednávky

Vytvoriť predaj

Metóda

POST

URL

/api/sales/create/

Popis

Vytvorí novú objednávku predaja.

Kontakty

Metóda

GET

URL

/api/contacts/

Popis

Vráti zoznam všetkých kontaktov.

Polia odpovede:

Pole

Typ

Popis

id

integer

Jedinečný identifikátor

complete_name

string

Celé meno

contact_type

string

Typ kontaktu

email

string

E-mailová adresa

phone

string

Telefónne číslo

language

string

Preferovaný jazyk

Opravy

Vytvoriť opravu

Metóda

POST

URL

/api/repairs/create/

Popis

Vytvorí nový príkaz na opravu s pripojenou položkou opravy. Ak nie je uvedené predajné miesto alebo oddelenie, použije sa prvé dostupné.

Polia požiadavky:

Pole

Typ

Požadované

Popis

client_id

integer

Nie

ID klienta/kontaktu

marketplace

reťazec / celé číslo

Nie

ID alebo názov predajného miesta

division_id

integer

Nie

ID oddelenia

title

string

Nie

Názov alebo popis položky opravy

repair_info_1

string

Nie

Doplňujúci komentár k oprave

repair_info_2

string

Nie

Doplňujúci komentár k oprave

repair_info_3

string

Nie

Doplňujúci komentár k oprave

quantity

decimal

Nie

Množstvo (predvolené: 1)

weight

decimal

Nie

Hmotnosť položky

weight_unit

string

Nie

Jednotka merania hmotnosti

size

string

Nie

Veľkosť položky

color

string

Nie

Farba položky

engravement

string

Nie

Text gravírovania

client_reference | string

Nie

Referenčné číslo klienta

Príklad odpovede:

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

Pridať položku do opravy

Metóda

POST

URL

/api/repairs/add-item/

Popis

Pridá novú položku do existujúcej opravy.

Polia požiadavky:

Pole

Typ

Požadované

Popis

order_id

string

Áno

ID opravy, do ktorej sa má položka pridať

item_sku

string

Nie

SKU produktu na prepojenie s položkou

title

string

Nie

Názov alebo popis

repair_info_1

string

Nie

Doplňujúci komentár k oprave

repair_info_2

string

Nie

Doplňujúci komentár k oprave

repair_info_3

string

Nie

Doplňujúci komentár k oprave

quantity

decimal

Nie

Množstvo (predvolené: 1)

weight

decimal

Nie

Hmotnosť položky

weight_unit

string

Nie

Jednotka merania hmotnosti

size

string

Nie

Veľkosť položky

color

string

Nie

Farba položky

engravement

string

Nie

Text gravírovania

client_reference | string

Nie

Referenčné číslo klienta

cost

decimal

Nie

Náklad položky

Inventúry

Vytvoriť inventúru

Metóda

POST

URL

/api/inventory-counts/

Popis

Vytvorí novú inventúru.

Polia odpovede:

Pole

Typ

Popis

id

string

ID inventúry

created_at

datetime

Časová pečiatka vytvorenia

status

string

Vždy active

tag_count

integer

Počet spočítaných produktov

Zoznam produktov inventúry

Metóda

GET

URL

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

Popis

Vráti všetky produkty spočítané v konkrétnej inventúre.

Polia odpovede:

Pole

Typ

Popis

id

string

Jedinečný identifikátor

created_at

datetime

Kedy bol produkt spočítaný

product_sku

string

SKU produktu

product_name

string

Názov produktu

quantity

integer

Spočítané množstvo

Interaktívny prieskumník API

Gem Logic obsahuje vstavaný interaktívny prieskumník API poháňaný Swagger UI. Môžete k nemu pristúpiť cez odkaz Dokumentácia API na stránke Nastavenia ‣ API. Prieskumník Vám umožňuje vyskúšať každý koncový bod priamo z Vášho prehliadača.

Viď aj