API

A Gem Logic API lehetővé teszi az integráció külső rendszerekkel és a munkafolyamatok automatizálását. Programozott módon kezelheti a termékeket, eladásokat, kapcsolatokat, javításokat, leltárokat és nyomtatási feladatokat.

Lépjen a Beállítások ‣ API menüpontra az API-kulcsok létrehozásához és kezeléséhez.

Hitelesítés

Minden API-kérésnek tartalmaznia kell egy API-kulcsot az x-api-key HTTP fejlécben. A kulcsokat a Beállítások ‣ API oldalról hozhatja létre. A kulcsok bármikor deaktiválhatók vagy törölhetők.

Példa kérés:

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

Veszély

Tartsa titokban az API-kulcsait. Soha ne ossza meg őket nyilvános tárolókban vagy kliens oldali kódban. Ha egy kulcs veszélybe kerül, azonnal deaktiválja, és hozzon létre egy újat.

Alap URL

Minden végpont relatív az Ön példányának URL-jéhez képest, az /api/ előtag alatt:

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

Válasz formátum

Minden válasz JSON formátumban érkezik. A sikeres kérések 200 (GET esetén) vagy 201 (POST esetén) státuszkódot adnak vissza. A hibák a megfelelő státuszkódot adják vissza egy üzenettel:

• 200 OK — sikeres GET kérés

• 201 Created — sikeres POST kérés

• 400 Bad Request — érvénytelen vagy hiányzó adatok

• 401 Unauthorized — érvénytelen vagy hiányzó API-kulcs

• 404 Not Found — az erőforrás nem létezik

Végpontok

Piacterek

Metódus	GET
URL	/api/marketplaces/
Leírás	Visszaadja az összes értékesítési csatorna listáját.

Válasz mezők:

Mező	Típus	Leírás
id	integer	Egyedi azonosító
marketplace	string	Marketplace név

Termékek

Termékek listázása

Metódus	GET
URL	/api/products/{marketplace_id}
Leírás	Marketplace szerint szűrt termékeket ad vissza. Használja a marketplace azonosítót a marketplaces végpontból.

Válasz mezők:

Mező	Típus	Leírás
id	integer	Egyedi azonosító
item_sku	string	Termék SKU
created	datetime	Létrehozás dátuma
status	string	Termék állapota
images	array	Termékképek listája (id, image)
item_weight	decimal	Súly
item_height	decimal	Magasság
item_length	decimal	Hosszúság
item_width	decimal	Szélesség

Termékkép létrehozása

Metódus	POST
URL	/api/products/create/image/
Leírás	Termékkép feltöltése base64 kódolással. Ha a termék SKU még nem létezik, automatikusan létrejön egy új termék.

Kérés mezői:

Mező	Típus	Kötelező	Leírás
item_sku	string	Igen	Termék SKU, amelyhez a kép csatolva lesz
image	string (base64)	Igen	Base64 kódolású képadat

Eladás

Eladások listázása

Metódus	GET
URL	/api/sales/
Leírás	Visszaadja az összes értékesítési megrendelés listáját.

Válasz mezők:

Mező	Típus	Leírás
order_id	string	Egyedi megrendelésazonosító

Eladás létrehozása

Metódus	POST
URL	/api/sales/create/
Leírás	Új értékesítési megrendelést hoz létre.

Kapcsolatok

Metódus	GET
URL	/api/contacts/
Leírás	Visszaadja az összes kapcsolat listáját.

Válasz mezők:

Mező	Típus	Leírás
id	integer	Egyedi azonosító
complete_name	string	Teljes név
contact_type	string	Kapcsolat típusa
email	string	E-mail cím
phone	string	Telefonszám
language	string	Előnyben részesített nyelv

Javítások

Javítás létrehozása

Metódus	POST
URL	/api/repairs/create/
Leírás	Létrehoz egy új javítási megrendelést egy hozzárendelt javítási tétellel. Ha a verkooppunt vagy a részleg nincs megadva, az első elérhető kerül felhasználásra.

Kérés mezői:

Mező	Típus	Kötelező	Leírás
client_id	integer	Nem	Az ügyfél/kapcsolattartó azonosítója
marketplace	karakterlánc / egész szám	Nem	Verkooppunt azonosító vagy név
division_id	integer	Nem	Üzleti részleg azonosítója
title	string	Nem	A javítási tétel címe vagy leírása
repair_info_1	string	Nem	Kiegészítő javítási megjegyzés
repair_info_2	string	Nem	Kiegészítő javítási megjegyzés
repair_info_3	string	Nem	Kiegészítő javítási megjegyzés
quantity	decimal	Nem	Mennyiség (alapértelmezett: 1)
weight	decimal	Nem	Tétel súlya
weight_unit	string	Nem	Súlymérés mértékegysége
size	string	Nem	Tétel mérete
color	string	Nem	Tétel színe
engravement	string	Nem	Gravírozás szövege
client_reference | string		Nem	Ügyfél hivatkozási száma

Példa válasz:

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

Tétel hozzáadása javításhoz

Metódus	POST
URL	/api/repairs/add-item/
Leírás	Új tételt ad hozzá egy meglévő javítási megrendeléshez.

Kérés mezői:

Mező	Típus	Kötelező	Leírás
order_id	string	Igen	Annak a javításnak a megrendelésazonosítója, amelyhez a tételt hozzá kívánja adni
item_sku	string	Nem	A tételhez kapcsolandó termék SKU-ja
title	string	Nem	Cím vagy leírás
repair_info_1	string	Nem	Kiegészítő javítási megjegyzés
repair_info_2	string	Nem	Kiegészítő javítási megjegyzés
repair_info_3	string	Nem	Kiegészítő javítási megjegyzés
quantity	decimal	Nem	Mennyiség (alapértelmezett: 1)
weight	decimal	Nem	Tétel súlya
weight_unit	string	Nem	Súlymérés mértékegysége
size	string	Nem	Tétel mérete
color	string	Nem	Tétel színe
engravement	string	Nem	Gravírozás szövege
client_reference | string		Nem	Ügyfél hivatkozási száma
cost	decimal	Nem	A tétel költsége

Leltározások

Leltározás létrehozása

Metódus	POST
URL	/api/inventory-counts/
Leírás	Új leltározási munkamenetet hoz létre.

Válasz mezők:

Mező	Típus	Leírás
id	string	Leltározás azonosító
created_at	datetime	Létrehozás időbélyegzője
status	string	Mindig active
tag_count	integer	Megszámolt termékek száma

Leltározási termékek listázása

Metódus	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Leírás	Visszaadja az adott leltározásban megszámolt összes terméket.

Válasz mezők:

Mező	Típus	Leírás
id	string	Egyedi azonosító
created_at	datetime	Mikor került megszámlálásra a termék
product_sku	string	Termék SKU
product_name	string	Termék neve
quantity	integer	Számolt mennyiség

Nyomtatási feladatok

Metódus	POST
URL	/api/print-pdf/
Leírás	Töltsön fel egy PDF-fájlt a nyomtatási sorba egy adott nyomtatóhoz. A fájl formátuma és biztonsága ellenőrzésre kerül. Maximális fájlméret: 20 MB. Használja a multipart/form-data tartalomtípust.

Kérés mezői:

Mező	Típus	Kötelező	Leírás
pdf	fájl	Igen	Nyomtatandó PDF-fájl (max. 20 MB)
printer_uuid	UUID	Igen	A célnyomtató UUID-je
landscape	boolean	Nem	Nyomtatás álló módban (alapértelmezett: false)

Példa kérés:

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élda válasz:

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

Interaktív API böngésző

A Gem Logic beépített interaktív API böngészőt tartalmaz, amelyet a Swagger UI hajt meg. A API dokumentáció linkre kattintva érheti el a Beállítások ‣ API oldalon. A böngésző lehetővé teszi, hogy minden végpontot közvetlenül a böngészőjéből kipróbáljon.

Lásd még

• Integrációk