API¶
Gem Logic API’en giver dig mulighed for at integrere med eksterne systemer og automatisere arbejdsgange. Du kan bruge den til programmatisk at administrere produkter, salg, kontakter, reparationer, lagerbeholdninger og udskriftsjobs.
Naviger til for at oprette og administrere dine API-nøgler.
Autentificering¶
Alle API-anmodninger skal indeholde en API-nøgle i HTTP-headeren x-api-key. Du kan oprette nøgler fra siden . Nøgler kan deaktiveres eller slettes når som helst.
Eksempel på anmodning:
curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
-H "x-api-key: YOUR_API_KEY"
Fare
Hold dine API-nøgler hemmelige. Del dem aldrig i offentlige repositories eller i klient-side-kode. Hvis en nøgle er kompromitteret, deaktiver den øjeblikkeligt og opret en ny.
Basis-URL¶
Alle endpoints er relative til din instans-URL under præfikset /api/:
https://your-instance.gem-logic.com/api/
Responsformat¶
Alle responser returneres som JSON. Vellykkede anmodninger returnerer statuskoden 200 (for GET) eller 201 (for POST). Fejl returnerer den relevante statuskode med en besked:
200 OK — vellykket GET-anmodning
201 Created — vellykket POST-anmodning
400 Bad Request — ugyldige eller manglende data
401 Unauthorized — ugyldig eller manglende API-nøgle
404 Not Found — ressourcen findes ikke
Endpoints¶
Markedspladser¶
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Returnerer en liste over alle salgskanaler. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
integer |
Unik identifikator |
|
string |
Marketplace-navn |
Produkter¶
List produkter
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Returnerer produkter filtreret efter marketplace. Brug marketplace-ID’et fra marketplaces-endepunktet. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
integer |
Unik identifikator |
|
string |
Produkt-SKU |
|
datetime |
Oprettelsesdato |
|
string |
Produktstatus |
|
array |
Liste over produktbilleder ( |
|
decimal |
Vægt |
|
decimal |
Højde |
|
decimal |
Længde |
|
decimal |
Bredde |
Opret produktbillede
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Upload et produktbillede ved hjælp af base64-kodning. Hvis produktets SKU endnu ikke eksisterer, oprettes et nyt produkt automatisk. |
Anmodningsfelter:
Felt |
Type |
Påkrævet |
Beskrivelse |
|---|---|---|---|
|
string |
Ja |
Produkt-SKU som billedet skal tilknyttes |
|
string (base64) |
Ja |
Base64-kodede billeddata |
Salg¶
Vis salg
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Returnerer en liste over alle salgsordrer. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
string |
Unik ordreidentifikator |
Opret salg
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Opretter en ny salgsordre. |
Kontakter¶
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Returnerer en liste over alle kontakter. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
integer |
Unik identifikator |
|
string |
Fulde navn |
|
string |
Kontakttype |
|
string |
E-mailadresse |
|
string |
Telefonnummer |
|
string |
Foretrukket sprog |
Reparationer¶
Opret reparation
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Opretter en ny reparationsordre med tilknyttet reparationsartikel. Hvis verkooppunt eller afdeling ikke angives, anvendes den først tilgængelige. |
Anmodningsfelter:
Felt |
Type |
Påkrævet |
Beskrivelse |
|---|---|---|---|
|
integer |
Nej |
ID for kunden/kontaktpersonen |
|
string / integer |
Nej |
ID eller navn på verkooppunt |
|
integer |
Nej |
ID for forretningsafdelingen |
|
string |
Nej |
Titel eller beskrivelse af reparationsartiklen |
|
string |
Nej |
Yderligere reparationskommentar |
|
string |
Nej |
Yderligere reparationskommentar |
|
string |
Nej |
Yderligere reparationskommentar |
|
decimal |
Nej |
Antal (standard: 1) |
|
decimal |
Nej |
Artikelvægt |
|
string |
Nej |
Enhed for vægtmåling |
|
string |
Nej |
Artikelstørrelse |
|
string |
Nej |
Artikelfarve |
|
string |
Nej |
Graveringstekst |
|
Nej |
Kundens referencenummer |
|
Eksempel på respons:
{"message": "Repair created successfully.", "order_id": "R-0001"}
Tilføj artikel til reparation
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Tilføjer en ny artikel til en eksisterende reparationsordre. |
Anmodningsfelter:
Felt |
Type |
Påkrævet |
Beskrivelse |
|---|---|---|---|
|
string |
Ja |
Ordre-ID for reparationen som artiklen skal tilføjes til |
|
string |
Nej |
Produkt-SKU som skal linkes til artiklen |
|
string |
Nej |
Titel eller beskrivelse |
|
string |
Nej |
Yderligere reparationskommentar |
|
string |
Nej |
Yderligere reparationskommentar |
|
string |
Nej |
Yderligere reparationskommentar |
|
decimal |
Nej |
Antal (standard: 1) |
|
decimal |
Nej |
Artikelvægt |
|
string |
Nej |
Enhed for vægtmåling |
|
string |
Nej |
Artikelstørrelse |
|
string |
Nej |
Artikelfarve |
|
string |
Nej |
Graveringstekst |
|
Nej |
Kundens referencenummer |
|
|
decimal |
Nej |
Artiklens omkostning |
Lageroptællinger¶
Opret lageroptælling
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Opretter en ny lageroptællingssession. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
string |
Lageroptællings-ID |
|
datetime |
Oprettelsestidsstempel |
|
string |
Altid |
|
integer |
Antal talte produkter |
Vis lageroptællingsprodukter
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Returnerer alle produkter talt i en specifik lageroptælling. |
Responsfelter:
Felt |
Type |
Beskrivelse |
|---|---|---|
|
string |
Unik identifikator |
|
datetime |
Hvornår produktet blev talt |
|
string |
Produkt-SKU |
|
string |
Produktnavn |
|
integer |
Optalt antal |
Printjobs¶
Metode |
|
|---|---|
URL |
|
Beskrivelse |
Upload en PDF-fil til printkøen for en specifik printer. Filen valideres for format og sikkerhed. Maksimal filstørrelse er 20 MB. Brug indholdstypen |
Anmodningsfelter:
Felt |
Type |
Påkrævet |
Beskrivelse |
|---|---|---|---|
|
fil |
Ja |
PDF-fil, der skal printes (maks. 20 MB) |
|
UUID |
Ja |
UUID for målprinteren |
|
boolean |
Nej |
Print i liggende format (standard: false) |
Eksempel på anmodning:
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"
Eksempel på respons:
{"status": "queued", "print_job_id": 42}
Interaktiv API-udforsker¶
Gem Logic indeholder en indbygget interaktiv API-udforsker drevet af Swagger UI. De kan få adgang til den via linket API-dokumentation på siden . Udforskeren giver Dem mulighed for at afprøve hvert endpoint direkte fra Deres browser.
Se også