API¶

Die Gem Logic API ermöglicht die Integration externer Systeme und die Automatisierung von Arbeitsabläufen. Sie können damit Produkte, Verkäufe, Kontakte, Reparaturen, Inventurzählungen und Druckaufträge programmatisch verwalten.

Navigieren Sie zu Einstellungen ‣ API, um Ihre API-Schlüssel zu erstellen und zu verwalten.

Authentifizierung¶

Alle API-Anfragen müssen einen API-Schlüssel im HTTP-Header x-api-key enthalten. Sie können Schlüssel auf der Seite Einstellungen ‣ API erstellen. Schlüssel können jederzeit deaktiviert oder gelöscht werden.

Beispielanfrage:

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

Gefahr

Halten Sie Ihre API-Schlüssel geheim. Teilen Sie sie niemals in öffentlichen Repositories oder clientseitigem Code. Wenn ein Schlüssel kompromittiert wurde, deaktivieren Sie ihn sofort und erstellen Sie einen neuen.

Basis-URL¶

Alle Endpunkte sind relativ zu Ihrer Instanz-URL unter dem Präfix /api/:

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

Antwortformat¶

Alle Antworten werden als JSON zurückgegeben. Erfolgreiche Anfragen geben den Statuscode 200 (für GET) oder 201 (für POST) zurück. Fehler geben den entsprechenden Statuscode mit einer Nachricht zurück:

200 OK — erfolgreiche GET-Anfrage
201 Created — erfolgreiche POST-Anfrage
400 Bad Request — ungültige oder fehlende Daten
401 Unauthorized — ungültiger oder fehlender API-Schlüssel
404 Not Found — Ressource existiert nicht

Endpunkte¶

Marktplätze¶

Methode	`GET`
URL	`/api/marketplaces/`
Beschreibung	Gibt eine Liste aller Vertriebskanäle zurück.

Antwortfelder:

Feld	Typ	Beschreibung
`id`	integer	Eindeutiger Identifikator
`marketplace`	string	Marktplatzname

Produkte¶

Produkte auflisten

Methode	`GET`
URL	`/api/products/{marketplace_id}`
Beschreibung	Gibt nach Marktplatz gefilterte Produkte zurück. Verwenden Sie die Marktplatz-ID vom marketplaces-Endpunkt.

Antwortfelder:

Feld	Typ	Beschreibung
`id`	integer	Eindeutiger Identifikator
`item_sku`	string	Produkt-Artikelnr.
`created`	datetime	Erstellungsdatum
`status`	string	Produktstatus
`images`	array	Liste der Produktbilder (`id`, `image`)
`item_weight`	decimal	Gewicht
`item_height`	decimal	Höhe
`item_length`	decimal	Länge
`item_width`	decimal	Breite

Produktbild erstellen

Methode	`POST`
URL	`/api/products/create/image/`
Beschreibung	Lädt ein Produktbild mittels Base64-Codierung hoch. Wenn die Produkt-Artikelnr. noch nicht existiert, wird automatisch ein neues Produkt angelegt.

Anforderungsfelder:

Feld	Typ	Erforderlich	Beschreibung
`item_sku`	string	Ja	Artikelnr. des Produkts, dem das Bild angehängt werden soll
`image`	string (base64)	Ja	Base64-codierte Bilddaten

Verkäufe¶

Verkäufe auflisten

Methode	`GET`
URL	`/api/sales/`
Beschreibung	Gibt eine Liste aller Verkaufsaufträge zurück.

Antwortfelder:

Feld	Typ	Beschreibung
`order_id`	string	Eindeutige Auftragskennung

Verkauf erstellen

Methode	`POST`
URL	`/api/sales/create/`
Beschreibung	Erstellt einen neuen Verkaufsauftrag.

Kontakte¶

Methode	`GET`
URL	`/api/contacts/`
Beschreibung	Gibt eine Liste aller Kontakte zurück.

Antwortfelder:

Feld	Typ	Beschreibung
`id`	integer	Eindeutiger Identifikator
`complete_name`	string	Vollständiger Name
`contact_type`	string	Kontakttyp
`email`	string	E-Mail-Adresse
`phone`	string	Telefonnummer
`language`	string	Bevorzugte Sprache

Reparaturen¶

Reparatur erstellen

Methode	`POST`
URL	`/api/repairs/create/`
Beschreibung	Erstellt einen neuen Reparaturauftrag mit einem zugehörigen Reparaturartikel. Falls kein Vertriebskanal oder keine Abteilung angegeben wird, wird der erste verfügbare verwendet.

Anforderungsfelder:

Feld	Typ	Erforderlich	Beschreibung
`client_id`	integer	Nein	ID des Kunden/Kontakts
`marketplace`	Zeichenkette / Ganzzahl	Nein	ID oder Name des Vertriebskanals
`division_id`	integer	Nein	ID der Abteilung
`title`	string	Nein	Titel oder Beschreibung des Reparaturartikels
`repair_info_1`	string	Nein	Zusätzlicher Reparaturkommentar
`repair_info_2`	string	Nein	Zusätzlicher Reparaturkommentar
`repair_info_3`	string	Nein	Zusätzlicher Reparaturkommentar
`quantity`	decimal	Nein	Menge (Standard: 1)
`weight`	decimal	Nein	Gewicht des Artikels
`weight_unit`	string	Nein	Maßeinheit des Gewichts
`size`	string	Nein	Größe des Artikels
`color`	string	Nein	Farbe des Artikels
`engravement`	string	Nein	Gravurtext
`client_reference` \| string		Nein	Referenznummer des Kunden

Beispielantwort:

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

Artikel zu Reparatur hinzufügen

Methode	`POST`
URL	`/api/repairs/add-item/`
Beschreibung	Fügt einen neuen Artikel zu einer bestehenden Reparaturauftrag hinzu.

Anforderungsfelder:

Feld	Typ	Erforderlich	Beschreibung
`order_id`	string	Ja	Auftrags-ID der Reparatur, zu der der Artikel hinzugefügt werden soll
`item_sku`	string	Nein	Artikelnr. des Produkts, das mit dem Artikel verknüpft werden soll
`title`	string	Nein	Titel oder Beschreibung
`repair_info_1`	string	Nein	Zusätzlicher Reparaturkommentar
`repair_info_2`	string	Nein	Zusätzlicher Reparaturkommentar
`repair_info_3`	string	Nein	Zusätzlicher Reparaturkommentar
`quantity`	decimal	Nein	Menge (Standard: 1)
`weight`	decimal	Nein	Gewicht des Artikels
`weight_unit`	string	Nein	Maßeinheit des Gewichts
`size`	string	Nein	Größe des Artikels
`color`	string	Nein	Farbe des Artikels
`engravement`	string	Nein	Gravurtext
`client_reference` \| string		Nein	Referenznummer des Kunden
`cost`	decimal	Nein	Kosten des Artikels

Inventarzählungen¶

Inventarzählung erstellen

Methode	`POST`
URL	`/api/inventory-counts/`
Beschreibung	Erstellt eine neue Inventarzählungssitzung.

Antwortfelder:

Feld	Typ	Beschreibung
`id`	string	Inventarzählungs-ID
`created_at`	datetime	Erstellungszeitstempel
`status`	string	Immer `active`
`tag_count`	integer	Anzahl gezählter Produkte

Produkte der Inventarzählung auflisten

Methode	`GET`
URL	`/api/inventory-counts/{inventory_count_id}/products/`
Beschreibung	Gibt alle in einer bestimmten Inventarzählung gezählten Produkte zurück.

Antwortfelder:

Feld	Typ	Beschreibung
`id`	string	Eindeutiger Identifikator
`created_at`	datetime	Zeitpunkt der Produktzählung
`product_sku`	string	Produkt-Artikelnr.
`product_name`	string	Produktname
`quantity`	integer	Gezählte Menge

Druckaufträge¶

Methode	`POST`
URL	`/api/print-pdf/`
Beschreibung	Lädt eine PDF-Datei in die Druckwarteschlange für einen bestimmten Drucker hoch. Die Datei wird auf Format und Sicherheit geprüft. Maximale Dateigröße: 20 MB. Verwenden Sie den Inhaltstyp `multipart/form-data`.

Anforderungsfelder:

Feld	Typ	Erforderlich	Beschreibung
`pdf`	Datei	Ja	PDF-Datei zum Drucken (max. 20 MB)
`printer_uuid`	UUID	Ja	UUID des Zieldruckers
`landscape`	boolean	Nein	Im Querformat drucken (Standard: false)

Beispielanfrage:

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"

Beispielantwort:

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

Interaktiver API-Explorer¶

Gem Logic enthält einen integrierten interaktiven API-Explorer auf Basis von Swagger UI. Sie können darauf über den Link API-Dokumentation auf der Seite Einstellungen ‣ API zugreifen. Der Explorer ermöglicht es Ihnen, jeden Endpunkt direkt in Ihrem Browser auszuprobieren.

Siehe auch

Integrationen