API

API Gem Logic umożliwia integrację z systemami zewnętrznymi i automatyzację procesów. Może Pan/Pani używać go do programowego zarządzania produktami, sprzedażą, kontaktami, naprawami, inwentaryzacjami i zadaniami drukowania.

Przejdź do Ustawienia ‣ API, aby utworzyć i zarządzać kluczami API.

Uwierzytelnianie

Wszystkie żądania API muszą zawierać klucz API w nagłówku HTTP x-api-key. Może Pan/Pani tworzyć klucze na stronie Ustawienia ‣ API. Klucze można w każdej chwili dezaktywować lub usunąć.

Przykładowe żądanie:

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

Niebezpieczeństwo

Zachowaj klucze API w tajemnicy. Nigdy nie udostępniaj ich w publicznych repozytoriach ani w kodzie po stronie klienta. Jeśli klucz zostanie skompromitowany, natychmiast go dezaktywuj i utwórz nowy.

Podstawowy URL

Wszystkie endpointy są względne wobec adresu URL Pana/Pani instancji, pod prefiksem /api/:

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

Format odpowiedzi

Wszystkie odpowiedzi są zwracane w formacie JSON. Udane żądania zwracają kod statusu 200 (dla GET) lub 201 (dla POST). Błędy zwracają odpowiedni kod statusu z komunikatem:

• 200 OK — udane żądanie GET

• 201 Created — udane żądanie POST

• 400 Bad Request — nieprawidłowe lub brakujące dane

• 401 Unauthorized — nieprawidłowy lub brakujący klucz API

• 404 Not Found — zasób nie istnieje

Endpointy

Platformy sprzedażowe

Metoda	GET
URL	/api/marketplaces/
Opis	Zwraca listę wszystkich kanałów sprzedaży.

Pola odpowiedzi:

Pole	Typ	Opis
id	integer	Unikalny identyfikator
marketplace	string	Nazwa platformy handlowej

Produkty

Lista produktów

Metoda	GET
URL	/api/products/{marketplace_id}
Opis	Zwraca produkty przefiltrowane według platformy handlowej. Należy użyć ID platformy handlowej z punktu końcowego marketplaces.

Pola odpowiedzi:

Pole	Typ	Opis
id	integer	Unikalny identyfikator
item_sku	string	SKU produktu
created	datetime	Data utworzenia
status	string	Status produktu
images	array	Lista obrazów produktu (id, image)
item_weight	decimal	Waga
item_height	decimal	Wysokość
item_length	decimal	Długość
item_width	decimal	Szerokość

Utwórz obraz produktu

Metoda	POST
URL	/api/products/create/image/
Opis	Przesyła obraz produktu przy użyciu kodowania base64. Jeśli SKU produktu jeszcze nie istnieje, nowy produkt jest tworzony automatycznie.

Pola żądania:

Pole	Typ	Wymagane	Opis
item_sku	string	Tak	SKU produktu, do którego ma zostać dołączony obraz
image	string (base64)	Tak	Dane obrazu zakodowane w base64

Sprzedaż

Lista sprzedaży

Metoda	GET
URL	/api/sales/
Opis	Zwraca listę wszystkich zamówień sprzedaży.

Pola odpowiedzi:

Pole	Typ	Opis
order_id	string	Unikalny identyfikator zamówienia

Utwórz sprzedaż

Metoda	POST
URL	/api/sales/create/
Opis	Tworzy nowe zamówienie sprzedaży.

Kontakty

Metoda	GET
URL	/api/contacts/
Opis	Zwraca listę wszystkich kontaktów.

Pola odpowiedzi:

Pole	Typ	Opis
id	integer	Unikalny identyfikator
complete_name	string	Pełna nazwa
contact_type	string	Typ kontaktu
email	string	Adres e-mail
phone	string	Numer telefonu
language	string	Preferowany język

Naprawy

Utwórz naprawę

Metoda	POST
URL	/api/repairs/create/
Opis	Tworzy nowe zlecenie naprawy z powiązanym artykułem naprawy. Jeśli punkt sprzedaży lub dział nie zostanie podany, system użyje pierwszego dostępnego.

Pola żądania:

Pole	Typ	Wymagane	Opis
client_id	integer	Nie	ID klienta/kontaktu
marketplace	string / integer	Nie	ID lub nazwa punktu sprzedaży
division_id	integer	Nie	ID działu biznesowego
title	string	Nie	Tytuł lub opis artykułu naprawy
repair_info_1	string	Nie	Dodatkowy komentarz naprawy
repair_info_2	string	Nie	Dodatkowy komentarz naprawy
repair_info_3	string	Nie	Dodatkowy komentarz naprawy
quantity	decimal	Nie	Ilość (domyślnie: 1)
weight	decimal	Nie	Waga artykułu
weight_unit	string	Nie	Jednostka miary wagi
size	string	Nie	Rozmiar artykułu
color	string	Nie	Kolor artykułu
engravement	string	Nie	Tekst grawerunku
client_reference | string		Nie	Numer referencyjny klienta

Przykładowa odpowiedź:

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

Dodaj przedmiot do naprawy

Metoda	POST
URL	/api/repairs/add-item/
Opis	Dodaje nowy przedmiot do istniejącego zlecenia naprawy.

Pola żądania:

Pole	Typ	Wymagane	Opis
order_id	string	Tak	ID zlecenia naprawy, do którego ma zostać dodany przedmiot
item_sku	string	Nie	SKU produktu do powiązania z przedmiotem
title	string	Nie	Tytuł lub opis
repair_info_1	string	Nie	Dodatkowy komentarz naprawy
repair_info_2	string	Nie	Dodatkowy komentarz naprawy
repair_info_3	string	Nie	Dodatkowy komentarz naprawy
quantity	decimal	Nie	Ilość (domyślnie: 1)
weight	decimal	Nie	Waga artykułu
weight_unit	string	Nie	Jednostka miary wagi
size	string	Nie	Rozmiar artykułu
color	string	Nie	Kolor artykułu
engravement	string	Nie	Tekst grawerunku
client_reference | string		Nie	Numer referencyjny klienta
cost	decimal	Nie	Koszt przedmiotu

Inwentaryzacje

Utwórz inwentaryzację

Metoda	POST
URL	/api/inventory-counts/
Opis	Tworzy nową sesję inwentaryzacji.

Pola odpowiedzi:

Pole	Typ	Opis
id	string	ID inwentaryzacji
created_at	datetime	Znacznik czasu utworzenia
status	string	Zawsze active
tag_count	integer	Liczba zliczonych produktów

Wyświetl produkty inwentaryzacji

Metoda	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Opis	Zwraca wszystkie produkty zliczone w określonej inwentaryzacji.

Pola odpowiedzi:

Pole	Typ	Opis
id	string	Unikalny identyfikator
created_at	datetime	Kiedy produkt został zliczony
product_sku	string	SKU produktu
product_name	string	Nazwa produktu
quantity	integer	Policzono ilość

Zadania drukowania

Metoda	POST
URL	/api/print-pdf/
Opis	Przesyła plik PDF do kolejki drukowania dla określonej drukarki. Plik jest sprawdzany pod względem formatu i bezpieczeństwa. Maksymalny rozmiar pliku to 20 MB. Należy użyć typu zawartości multipart/form-data.

Pola żądania:

Pole	Typ	Wymagane	Opis
pdf	plik	Tak	Plik PDF do wydrukowania (maks. 20 MB)
printer_uuid	UUID	Tak	UUID drukarki docelowej
landscape	boolean	Nie	Drukuj w trybie poziomym (domyślnie: false)

Przykładowe żądanie:

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"

Przykładowa odpowiedź:

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

Interaktywny eksplorator API

Gem Logic zawiera wbudowany interaktywny eksplorator API oparty na Swagger UI. Można uzyskać do niego dostęp za pomocą linku Dokumentacja API na stronie Ustawienia ‣ API. Eksplorator umożliwia wypróbowanie każdego punktu końcowego bezpośrednio z przeglądarki.

Zobacz także

• Integracje