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 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 . 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ă |
|
|---|---|
URL |
|
Descriere |
Returnează o listă cu toate canalele de vânzări. |
Câmpuri de răspuns:
Câmp |
Tip |
Descriere |
|---|---|---|
|
integer |
Identificator unic |
|
string |
Nume marketplace |
Produse¶
Listează produsele
Metodă |
|
|---|---|
URL |
|
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 |
|---|---|---|
|
integer |
Identificator unic |
|
string |
SKU produs |
|
datetime |
Dată creare |
|
string |
Stare produs |
|
array |
Lista imaginilor produsului ( |
|
decimal |
Greutate |
|
decimal |
Înălțime |
|
decimal |
Lungime |
|
decimal |
Lățime |
Creare imagine produs
Metodă |
|
|---|---|
URL |
|
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 |
|---|---|---|---|
|
string |
Da |
SKU produs la care să se atașeze imaginea |
|
string (base64) |
Da |
Date imagine codificate în base64 |
Vânzări¶
Listare vânzări
Metodă |
|
|---|---|
URL |
|
Descriere |
Returnează o listă a tuturor comenzilor de vânzare. |
Câmpuri de răspuns:
Câmp |
Tip |
Descriere |
|---|---|---|
|
string |
Identificator unic comandă |
Creare vânzare
Metodă |
|
|---|---|
URL |
|
Descriere |
Creează o comandă de vânzare nouă. |
Contacte¶
Metodă |
|
|---|---|
URL |
|
Descriere |
Returnează o listă a tuturor contactelor. |
Câmpuri de răspuns:
Câmp |
Tip |
Descriere |
|---|---|---|
|
integer |
Identificator unic |
|
string |
Nume complet |
|
string |
Tip contact |
|
string |
Adresă email |
|
string |
Număr telefon |
|
string |
Limba preferată |
Reparații¶
Creează reparație
Metodă |
|
|---|---|
URL |
|
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 |
|---|---|---|---|
|
integer |
Nu |
ID-ul clientului/persoanei de contact |
|
șir / întreg |
Nu |
ID sau nume canal de vânzări |
|
integer |
Nu |
ID-ul diviziei de afaceri |
|
string |
Nu |
Titlu sau descriere a articolului de reparație |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
decimal |
Nu |
Cantitate (implicit: 1) |
|
decimal |
Nu |
Greutatea articolului |
|
string |
Nu |
Unitatea de măsură a greutății |
|
string |
Nu |
Mărimea articolului |
|
string |
Nu |
Culoarea articolului |
|
string |
Nu |
Text gravare |
|
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ă |
|
|---|---|
URL |
|
Descriere |
Adaugă un articol nou la o comandă de reparație existentă. |
Câmpuri cerere:
Câmp |
Tip |
Obligatoriu |
Descriere |
|---|---|---|---|
|
string |
Da |
ID-ul comenzii de reparație la care se adaugă articolul |
|
string |
Nu |
SKU-ul produsului de asociat cu articolul |
|
string |
Nu |
Titlu sau descriere |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
string |
Nu |
Comentariu suplimentar de reparație |
|
decimal |
Nu |
Cantitate (implicit: 1) |
|
decimal |
Nu |
Greutatea articolului |
|
string |
Nu |
Unitatea de măsură a greutății |
|
string |
Nu |
Mărimea articolului |
|
string |
Nu |
Culoarea articolului |
|
string |
Nu |
Text gravare |
|
Nu |
Numărul de referință al clientului |
|
|
decimal |
Nu |
Costul articolului |
Inventarieri¶
Creați inventariere
Metodă |
|
|---|---|
URL |
|
Descriere |
Creează o nouă sesiune de inventariere. |
Câmpuri de răspuns:
Câmp |
Tip |
Descriere |
|---|---|---|
|
string |
ID inventariere |
|
datetime |
Marcaj temporal de creare |
|
string |
Întotdeauna |
|
integer |
Numărul de produse inventariate |
Afișați produsele din inventariere
Metodă |
|
|---|---|
URL |
|
Descriere |
Returnează toate produsele inventariate într-o inventariere specifică. |
Câmpuri de răspuns:
Câmp |
Tip |
Descriere |
|---|---|---|
|
string |
Identificator unic |
|
datetime |
Când a fost inventariat produsul |
|
string |
SKU produs |
|
string |
Numele produsului |
|
integer |
Cantitate numărată |
Lucrări de imprimare¶
Metodă |
|
|---|---|
URL |
|
Descriere |
Încărcați un fișier PDF în coada de imprimare pentru o anumită imprimantă. Fișierul este validat pentru format și securitate. Dimensiunea maximă a fișierului este de 20 MB. Utilizați tipul de conținut |
Câmpuri cerere:
Câmp |
Tip |
Obligatoriu |
Descriere |
|---|---|---|---|
|
fișier |
Da |
Fișier PDF de imprimat (max 20 MB) |
|
UUID |
Da |
UUID-ul imprimantei țintă |
|
boolean |
Nu |
Imprimare în mod peisaj (implicit: false) |
Exemplu de solicitare:
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"
Exemplu de răspuns:
{"status": "queued", "print_job_id": 42}
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 . Exploratorul vă permite să testați fiecare punct de acces direct din browser.
Vezi și