API

API Gem Logic Vám umožňuje integraci s externími systémy a automatizaci pracovních postupů. Můžete jej využít k programové správě produktů, prodejů, kontaktů, oprav, inventarizací a tiskových úloh.

Přejděte do Nastavení ‣ API, abyste vytvořili a spravovali své API klíče.

Autentizace

Všechny požadavky API musí obsahovat API klíč v HTTP hlavičce x-api-key. Klíče můžete vytvářet na stránce Nastavení ‣ API. Klíče lze kdykoli deaktivovat nebo smazat.

Příklad požadavku:

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

Nebezpečí

Uchovávejte své API klíče v tajnosti. Nikdy je nesdílejte ve veřejných repozitářích ani v klientském kódu. Pokud dojde ke kompromitaci klíče, okamžitě jej deaktivujte a vytvořte nový.

Základní URL

Všechny endpointy jsou relativní k URL Vaší instance pod předponou /api/:

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

Formát odpovědi

Všechny odpovědi jsou vráceny jako JSON. Úspěšné požadavky vrací stavový kód 200 (pro GET) nebo 201 (pro POST). Chyby vrací příslušný stavový kód se zprávou:

• 200 OK — úspěšný GET požadavek

• 201 Created — úspěšný POST požadavek

• 400 Bad Request — neplatná nebo chybějící data

• 401 Unauthorized — neplatný nebo chybějící API klíč

• 404 Not Found — zdroj neexistuje

Endpointy

Tržiště

Metoda	GET
URL	/api/marketplaces/
Popis	Vrací seznam všech prodejních kanálů.

Pole odpovědi:

Pole	Typ	Popis
id	integer	Unikátní identifikátor
marketplace	string	Název tržiště

Produkty

Seznam produktů

Metoda	GET
URL	/api/products/{marketplace_id}
Popis	Vrací produkty filtrované podle tržiště. Použijte ID tržiště z koncového bodu marketplaces.

Pole odpovědi:

Pole	Typ	Popis
id	integer	Unikátní identifikátor
item_sku	string	SKU produktu
created	datetime	Datum vytvoření
status	string	Stav produktu
images	array	Seznam obrázků produktu (id, image)
item_weight	decimal	Hmotnost
item_height	decimal	Výška
item_length	decimal	Délka
item_width	decimal	Šířka

Vytvořit obrázek produktu

Metoda	POST
URL	/api/products/create/image/
Popis	Nahraje obrázek produktu pomocí kódování base64. Pokud SKU produktu ještě neexistuje, nový produkt se vytvoří automaticky.

Pole požadavku:

Pole	Typ	Povinné	Popis
item_sku	string	Ano	SKU produktu, ke kterému se má připojit obrázek
image	string (base64)	Ano	Obrázkové data kódované v base64

Prodej

Vypsat prodeje

Metoda	GET
URL	/api/sales/
Popis	Vrací seznam všech prodejních objednávek.

Pole odpovědi:

Pole	Typ	Popis
order_id	string	Jedinečný identifikátor objednávky

Vytvořit prodej

Metoda	POST
URL	/api/sales/create/
Popis	Vytvoří novou prodejní objednávku.

Kontakty

Metoda	GET
URL	/api/contacts/
Popis	Vrací seznam všech kontaktů.

Pole odpovědi:

Pole	Typ	Popis
id	integer	Unikátní identifikátor
complete_name	string	Celé jméno
contact_type	string	Typ kontaktu
email	string	E-mailová adresa
phone	string	Telefonní číslo
language	string	Preferovaný jazyk

Opravy

Vytvořit opravu

Metoda	POST
URL	/api/repairs/create/
Popis	Vytvoří novou opravní zakázku s přiřazenou opravovanou položkou. Pokud není zadáno prodejní místo nebo oddělení, použije se první dostupné.

Pole požadavku:

Pole	Typ	Povinné	Popis
client_id	integer	Ne	ID klienta/kontaktu
marketplace	string / integer	Ne	ID nebo název prodejního místa
division_id	integer	Ne	ID obchodního oddělení
title	string	Ne	Název nebo popis opravované položky
repair_info_1	string	Ne	Doplňující poznámka k opravě
repair_info_2	string	Ne	Doplňující poznámka k opravě
repair_info_3	string	Ne	Doplňující poznámka k opravě
quantity	decimal	Ne	Množství (výchozí: 1)
weight	decimal	Ne	Hmotnost položky
weight_unit	string	Ne	Jednotka hmotnosti
size	string	Ne	Velikost položky
color	string	Ne	Barva položky
engravement	string	Ne	Text rytiny
client_reference | string		Ne	Referenční číslo klienta

Příklad odpovědi:

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

Přidat položku k opravě

Metoda	POST
URL	/api/repairs/add-item/
Popis	Přidá novou položku k existující opravě.

Pole požadavku:

Pole	Typ	Povinné	Popis
order_id	string	Ano	ID opravy, do které se má položka přidat
item_sku	string	Ne	SKU produktu, které se má propojit s položkou
title	string	Ne	Název nebo popis
repair_info_1	string	Ne	Doplňující poznámka k opravě
repair_info_2	string	Ne	Doplňující poznámka k opravě
repair_info_3	string	Ne	Doplňující poznámka k opravě
quantity	decimal	Ne	Množství (výchozí: 1)
weight	decimal	Ne	Hmotnost položky
weight_unit	string	Ne	Jednotka hmotnosti
size	string	Ne	Velikost položky
color	string	Ne	Barva položky
engravement	string	Ne	Text rytiny
client_reference | string		Ne	Referenční číslo klienta
cost	decimal	Ne	Náklad položky

Inventury

Vytvořit inventuru

Metoda	POST
URL	/api/inventory-counts/
Popis	Vytvoří novou relaci inventury.

Pole odpovědi:

Pole	Typ	Popis
id	string	ID inventury
created_at	datetime	Časové razítko vytvoření
status	string	Vždy active
tag_count	integer	Počet sečtených produktů

Zobrazit produkty v inventuře

Metoda	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Popis	Vrátí všechny produkty sečtené v konkrétní inventuře.

Pole odpovědi:

Pole	Typ	Popis
id	string	Unikátní identifikátor
created_at	datetime	Kdy byl produkt sečten
product_sku	string	SKU produktu
product_name	string	Název produktu
quantity	integer	Spočítané množství

Tiskové úlohy

Metoda	POST
URL	/api/print-pdf/
Popis	Nahrajte soubor PDF do tiskové fronty pro konkrétní tiskárnu. Soubor je ověřen na formát a bezpečnost. Maximální velikost souboru je 20 MB. Použijte typ obsahu multipart/form-data.

Pole požadavku:

Pole	Typ	Povinné	Popis
pdf	soubor	Ano	Soubor PDF k tisku (max. 20 MB)
printer_uuid	UUID	Ano	UUID cílové tiskárny
landscape	boolean	Ne	Tisknout v režimu na šířku (výchozí: false)

Příklad požadavku:

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"

Příklad odpovědi:

{"status": "queued", "print_job_id": 42}

Interaktivní průzkumník API

Gem Logic obsahuje vestavěný interaktivní průzkumník API založený na Swagger UI. Můžete k němu přistoupit přes odkaz Dokumentace API na stránce Nastavení ‣ API. Průzkumník Vám umožňuje vyzkoušet jednotlivé endpointy přímo z Vašeho prohlížeče.

Viz také

• Integrace