API

De Gem Logic API stelt u in staat om te integreren met externe systemen en workflows te automatiseren. U kunt het gebruiken om producten, verkopen, contacten, reparaties, inventarisaties en afdruktaken programmatisch te beheren.

Ga naar Instellingen ‣ API om uw API-sleutels aan te maken en te beheren.

Authenticatie

Alle API-verzoeken moeten een API-sleutel bevatten in de x-api-key HTTP-header. U kunt sleutels aanmaken vanaf de pagina Instellingen ‣ API. Sleutels kunnen op elk moment worden gedeactiveerd of verwijderd.

Voorbeeld van een verzoek:

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

Gevaar

Houd uw API-sleutels geheim. Deel ze nooit in openbare repositories of client-side code. Als een sleutel is gecompromitteerd, deactiveer deze dan onmiddellijk en maak een nieuwe aan.

Basis-URL

Alle endpoints zijn relatief ten opzichte van uw instantie-URL, onder het /api/-voorvoegsel:

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

Responsformaat

Alle responsen worden geretourneerd als JSON. Succesvolle verzoeken retourneren een 200 (voor GET) of 201 (voor POST) statuscode. Fouten retourneren de juiste statuscode met een bericht:

• 200 OK — succesvol GET-verzoek

• 201 Created — succesvol POST-verzoek

• 400 Bad Request — ongeldige of ontbrekende data

• 401 Unauthorized — ongeldige of ontbrekende API-sleutel

• 404 Not Found — de resource bestaat niet

Endpoints

Marktplaatsen

Methode	GET
URL	/api/marketplaces/
Beschrijving	Retourneert een lijst van alle verkoopkanalen.

Responsvelden:

Veld	Type	Beschrijving
id	integer	Unieke identificatie
marketplace	string	Marketplace naam

Producten

Lijst van producten

Methode	GET
URL	/api/products/{marketplace_id}
Beschrijving	Retourneert producten gefilterd op marketplace. Gebruik de marketplace-ID van het marketplaces-eindpunt.

Responsvelden:

Veld	Type	Beschrijving
id	integer	Unieke identificatie
item_sku	string	Product SKU
created	datetime	Aanmaakdatum
status	string	Productstatus
images	array	Lijst van productafbeeldingen (id, image)
item_weight	decimal	Gewicht
item_height	decimal	Hoogte
item_length	decimal	Lengte
item_width	decimal	Breedte

Productafbeelding aanmaken

Methode	POST
URL	/api/products/create/image/
Beschrijving	Upload een productafbeelding met base64-codering. Als de product-SKU nog niet bestaat, wordt automatisch een nieuw product aangemaakt.

Verzoeksvelden:

Veld	Type	Vereist	Beschrijving
item_sku	string	Ja	Product SKU waaraan de afbeelding moet worden gekoppeld
image	string (base64)	Ja	Base64-gecodeerde afbeeldingsgegevens

Verkopen

Verkopen weergeven

Methode	GET
URL	/api/sales/
Beschrijving	Geeft een lijst van alle verkooporders.

Responsvelden:

Veld	Type	Beschrijving
order_id	string	Unieke order-identificatie

Verkoop aanmaken

Methode	POST
URL	/api/sales/create/
Beschrijving	Maakt een nieuwe verkooporder aan.

Contacten

Methode	GET
URL	/api/contacts/
Beschrijving	Geeft een lijst van alle contacten.

Responsvelden:

Veld	Type	Beschrijving
id	integer	Unieke identificatie
complete_name	string	Volledige naam
contact_type	string	Type contact
email	string	E-mailadres
phone	string	Telefoonnummer
language	string	Voorkeurstaal

Reparaties

Reparatie aanmaken

Methode	POST
URL	/api/repairs/create/
Beschrijving	Maakt een nieuwe reparatieorder aan met een gekoppeld reparatie-artikel. Als het verkooppunt of de divisie niet wordt opgegeven, wordt de eerst beschikbare gebruikt.

Verzoeksvelden:

Veld	Type	Vereist	Beschrijving
client_id	integer	Nee	ID van de klant/contactpersoon
marketplace	string / integer	Nee	ID of naam van het verkooppunt
division_id	integer	Nee	ID van de bedrijfsdivisie
title	string	Nee	Titel of omschrijving van het reparatie-artikel
repair_info_1	string	Nee	Extra reparatie-opmerking
repair_info_2	string	Nee	Extra reparatie-opmerking
repair_info_3	string	Nee	Extra reparatie-opmerking
quantity	decimal	Nee	Hoeveelheid (standaard: 1)
weight	decimal	Nee	Gewicht van het artikel
weight_unit	string	Nee	Eenheid voor gewichtsmeting
size	string	Nee	Maat van het artikel
color	string	Nee	Kleur van het artikel
engravement	string	Nee	Gravatietekst
client_reference | string		Nee	Referentienummer van de klant

Voorbeeldreactie:

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

Artikel toevoegen aan reparatie

Methode	POST
URL	/api/repairs/add-item/
Beschrijving	Voegt een nieuw artikel toe aan een bestaande reparatieopdracht.

Verzoeksvelden:

Veld	Type	Vereist	Beschrijving
order_id	string	Ja	Order-ID van de reparatie waaraan het artikel moet worden toegevoegd
item_sku	string	Nee	Product-SKU om aan het artikel te koppelen
title	string	Nee	Titel of beschrijving
repair_info_1	string	Nee	Extra reparatie-opmerking
repair_info_2	string	Nee	Extra reparatie-opmerking
repair_info_3	string	Nee	Extra reparatie-opmerking
quantity	decimal	Nee	Hoeveelheid (standaard: 1)
weight	decimal	Nee	Gewicht van het artikel
weight_unit	string	Nee	Eenheid voor gewichtsmeting
size	string	Nee	Maat van het artikel
color	string	Nee	Kleur van het artikel
engravement	string	Nee	Gravatietekst
client_reference | string		Nee	Referentienummer van de klant
cost	decimal	Nee	Kost van het artikel

Inventaristellingen

Inventaristelling aanmaken

Methode	POST
URL	/api/inventory-counts/
Beschrijving	Maakt een nieuwe inventaristellingssessie aan.

Responsvelden:

Veld	Type	Beschrijving
id	string	Inventaristelling-ID
created_at	datetime	Aanmaaktijdstempel
status	string	Altijd active
tag_count	integer	Aantal getelde producten

Producten van inventaristelling weergeven

Methode	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Beschrijving	Geeft alle getelde producten in een specifieke inventaristelling terug.

Responsvelden:

Veld	Type	Beschrijving
id	string	Unieke identificatie
created_at	datetime	Wanneer het product werd geteld
product_sku	string	Product SKU
product_name	string	Productnaam
quantity	integer	Getelde hoeveelheid

Afdrukopdrachten

Methode	POST
URL	/api/print-pdf/
Beschrijving	Upload een PDF-bestand naar de afdrukwachtrij voor een specifieke printer. Het bestand wordt gevalideerd op formaat en veiligheid. Maximale bestandsgrootte is 20 MB. Gebruik het inhoudstype multipart/form-data.

Verzoeksvelden:

Veld	Type	Vereist	Beschrijving
pdf	bestand	Ja	PDF-bestand om af te drukken (max 20 MB)
printer_uuid	UUID	Ja	UUID van de doelprinter
landscape	boolean	Nee	Afdrukken in liggende modus (standaard: false)

Voorbeeld van een verzoek:

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"

Voorbeeldreactie:

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

Interactieve API-verkenner

Gem Logic bevat een ingebouwde interactieve API-verkenner op basis van Swagger UI. U kunt deze openen via de link API-documentatie op de pagina Instellingen ‣ API. De verkenner stelt u in staat elk eindpunt rechtstreeks vanuit uw browser uit te proberen.

Zie ook

• Integraties