API

API-ul Gem Logic vă permite să integrați sisteme externe și să automatizați fluxurile de lucru. Îl puteți folosi pentru a gestiona produse, vânzări, contacte, reparații, inventare și sarcini de tipărire în mod programatic.

Navigați la Setări ‣ API pentru a crea și gestiona cheile dumneavoastră API.

Autentificare

Toate solicitările API trebuie să includă o cheie API în antetul HTTP x-api-key. Puteți crea chei din pagina Setări ‣ API. Cheile pot fi dezactivate sau șterse oricând.

Exemplu de solicitare:

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

Pericol

Păstrați-vă cheile API secrete. Nu le distribuiți niciodată în depozite publice sau în cod client-side. Dacă o cheie este compromisă, dezactivați-o imediat și creați una nouă.

URL de bază

Toate punctele finale sunt relative la URL-ul instanței dumneavoastră, sub prefixul /api/:

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

Format de răspuns

Toate răspunsurile sunt returnate în format JSON. Solicitările reușite returnează un cod de stare 200 (pentru GET) sau 201 (pentru POST). Erorile returnează codul de stare corespunzător cu un mesaj:

  • 200 OK — solicitare GET reușită

  • 201 Created — solicitare POST reușită

  • 400 Bad Request — date invalide sau lipsă

  • 401 Unauthorized — cheie API invalidă sau lipsă

  • 404 Not Found — resursa nu există

Puncte finale

Marketplace-uri

Metodă

GET

URL

/api/marketplaces/

Descriere

Returnează o listă cu toate canalele de vânzări.

Câmpuri de răspuns:

Câmp

Tip

Descriere

id

integer

Identificator unic

marketplace

string

Nume marketplace

Produse

Listează produsele

Metodă

GET

URL

/api/products/{marketplace_id}

Descriere

Returnează produsele filtrate după marketplace. Utilizați ID-ul marketplace-ului din punctul final marketplaces.

Câmpuri de răspuns:

Câmp

Tip

Descriere

id

integer

Identificator unic

item_sku

string

SKU produs

created

datetime

Dată creare

status

string

Stare produs

images

array

Lista imaginilor produsului (id, image)

item_weight

decimal

Greutate

item_height

decimal

Înălțime

item_length

decimal

Lungime

item_width

decimal

Lățime

Creare imagine produs

Metodă

POST

URL

/api/products/create/image/

Descriere

Încarcă o imagine de produs utilizând codificarea base64. Dacă SKU-ul produsului nu există încă, un produs nou este creat automat.

Câmpuri cerere:

Câmp

Tip

Obligatoriu

Descriere

item_sku

string

Da

SKU produs la care să se atașeze imaginea

image

string (base64)

Da

Date imagine codificate în base64

Vânzări

Listare vânzări

Metodă

GET

URL

/api/sales/

Descriere

Returnează o listă a tuturor comenzilor de vânzare.

Câmpuri de răspuns:

Câmp

Tip

Descriere

order_id

string

Identificator unic comandă

Creare vânzare

Metodă

POST

URL

/api/sales/create/

Descriere

Creează o comandă de vânzare nouă.

Contacte

Metodă

GET

URL

/api/contacts/

Descriere

Returnează o listă a tuturor contactelor.

Câmpuri de răspuns:

Câmp

Tip

Descriere

id

integer

Identificator unic

complete_name

string

Nume complet

contact_type

string

Tip contact

email

string

Adresă email

phone

string

Număr telefon

language

string

Limba preferată

Reparații

Creează reparație

Metodă

POST

URL

/api/repairs/create/

Descriere

Creează o nouă comandă de reparație cu un articol de reparație asociat. Dacă canalul de vânzări sau divizia nu sunt furnizate, se utilizează primul disponibil.

Câmpuri cerere:

Câmp

Tip

Obligatoriu

Descriere

client_id

integer

Nu

ID-ul clientului/persoanei de contact

marketplace

șir / întreg

Nu

ID sau nume canal de vânzări

division_id

integer

Nu

ID-ul diviziei de afaceri

title

string

Nu

Titlu sau descriere a articolului de reparație

repair_info_1

string

Nu

Comentariu suplimentar de reparație

repair_info_2

string

Nu

Comentariu suplimentar de reparație

repair_info_3

string

Nu

Comentariu suplimentar de reparație

quantity

decimal

Nu

Cantitate (implicit: 1)

weight

decimal

Nu

Greutatea articolului

weight_unit

string

Nu

Unitatea de măsură a greutății

size

string

Nu

Mărimea articolului

color

string

Nu

Culoarea articolului

engravement

string

Nu

Text gravare

client_reference | string

Nu

Numărul de referință al clientului

Exemplu de răspuns:

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

Adăugați articol la reparație

Metodă

POST

URL

/api/repairs/add-item/

Descriere

Adaugă un articol nou la o comandă de reparație existentă.

Câmpuri cerere:

Câmp

Tip

Obligatoriu

Descriere

order_id

string

Da

ID-ul comenzii de reparație la care se adaugă articolul

item_sku

string

Nu

SKU-ul produsului de asociat cu articolul

title

string

Nu

Titlu sau descriere

repair_info_1

string

Nu

Comentariu suplimentar de reparație

repair_info_2

string

Nu

Comentariu suplimentar de reparație

repair_info_3

string

Nu

Comentariu suplimentar de reparație

quantity

decimal

Nu

Cantitate (implicit: 1)

weight

decimal

Nu

Greutatea articolului

weight_unit

string

Nu

Unitatea de măsură a greutății

size

string

Nu

Mărimea articolului

color

string

Nu

Culoarea articolului

engravement

string

Nu

Text gravare

client_reference | string

Nu

Numărul de referință al clientului

cost

decimal

Nu

Costul articolului

Inventarieri

Creați inventariere

Metodă

POST

URL

/api/inventory-counts/

Descriere

Creează o nouă sesiune de inventariere.

Câmpuri de răspuns:

Câmp

Tip

Descriere

id

string

ID inventariere

created_at

datetime

Marcaj temporal de creare

status

string

Întotdeauna active

tag_count

integer

Numărul de produse inventariate

Afișați produsele din inventariere

Metodă

GET

URL

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

Descriere

Returnează toate produsele inventariate într-o inventariere specifică.

Câmpuri de răspuns:

Câmp

Tip

Descriere

id

string

Identificator unic

created_at

datetime

Când a fost inventariat produsul

product_sku

string

SKU produs

product_name

string

Numele produsului

quantity

integer

Cantitate numărată

Explorator API interactiv

Gem Logic include un explorator API interactiv integrat bazat pe Swagger UI. Puteți accesa această funcție prin linkul Documentație API de pe pagina Setări ‣ API. Exploratorul vă permite să testați fiecare punct de acces direct din browser.

Vezi și