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 Indstillinger ‣ API 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 Indstillinger ‣ API. 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

GET

URL

/api/marketplaces/

Beskrivelse

Returnerer en liste over alle salgskanaler.

Responsfelter:

Felt

Type

Beskrivelse

id

integer

Unik identifikator

marketplace

string

Marketplace-navn

Produkter

List produkter

Metode

GET

URL

/api/products/{marketplace_id}

Beskrivelse

Returnerer produkter filtreret efter marketplace. Brug marketplace-ID’et fra marketplaces-endepunktet.

Responsfelter:

Felt

Type

Beskrivelse

id

integer

Unik identifikator

item_sku

string

Produkt-SKU

created

datetime

Oprettelsesdato

status

string

Produktstatus

images

array

Liste over produktbilleder (id, image)

item_weight

decimal

Vægt

item_height

decimal

Højde

item_length

decimal

Længde

item_width

decimal

Bredde

Opret produktbillede

Metode

POST

URL

/api/products/create/image/

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

item_sku

string

Ja

Produkt-SKU som billedet skal tilknyttes

image

string (base64)

Ja

Base64-kodede billeddata

Salg

Vis salg

Metode

GET

URL

/api/sales/

Beskrivelse

Returnerer en liste over alle salgsordrer.

Responsfelter:

Felt

Type

Beskrivelse

order_id

string

Unik ordreidentifikator

Opret salg

Metode

POST

URL

/api/sales/create/

Beskrivelse

Opretter en ny salgsordre.

Kontakter

Metode

GET

URL

/api/contacts/

Beskrivelse

Returnerer en liste over alle kontakter.

Responsfelter:

Felt

Type

Beskrivelse

id

integer

Unik identifikator

complete_name

string

Fulde navn

contact_type

string

Kontakttype

email

string

E-mailadresse

phone

string

Telefonnummer

language

string

Foretrukket sprog

Reparationer

Opret reparation

Metode

POST

URL

/api/repairs/create/

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

client_id

integer

Nej

ID for kunden/kontaktpersonen

marketplace

string / integer

Nej

ID eller navn på verkooppunt

division_id

integer

Nej

ID for forretningsafdelingen

title

string

Nej

Titel eller beskrivelse af reparationsartiklen

repair_info_1

string

Nej

Yderligere reparationskommentar

repair_info_2

string

Nej

Yderligere reparationskommentar

repair_info_3

string

Nej

Yderligere reparationskommentar

quantity

decimal

Nej

Antal (standard: 1)

weight

decimal

Nej

Artikelvægt

weight_unit

string

Nej

Enhed for vægtmåling

size

string

Nej

Artikelstørrelse

color

string

Nej

Artikelfarve

engravement

string

Nej

Graveringstekst

client_reference | string

Nej

Kundens referencenummer

Eksempel på respons:

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

Tilføj artikel til reparation

Metode

POST

URL

/api/repairs/add-item/

Beskrivelse

Tilføjer en ny artikel til en eksisterende reparationsordre.

Anmodningsfelter:

Felt

Type

Påkrævet

Beskrivelse

order_id

string

Ja

Ordre-ID for reparationen som artiklen skal tilføjes til

item_sku

string

Nej

Produkt-SKU som skal linkes til artiklen

title

string

Nej

Titel eller beskrivelse

repair_info_1

string

Nej

Yderligere reparationskommentar

repair_info_2

string

Nej

Yderligere reparationskommentar

repair_info_3

string

Nej

Yderligere reparationskommentar

quantity

decimal

Nej

Antal (standard: 1)

weight

decimal

Nej

Artikelvægt

weight_unit

string

Nej

Enhed for vægtmåling

size

string

Nej

Artikelstørrelse

color

string

Nej

Artikelfarve

engravement

string

Nej

Graveringstekst

client_reference | string

Nej

Kundens referencenummer

cost

decimal

Nej

Artiklens omkostning

Lageroptællinger

Opret lageroptælling

Metode

POST

URL

/api/inventory-counts/

Beskrivelse

Opretter en ny lageroptællingssession.

Responsfelter:

Felt

Type

Beskrivelse

id

string

Lageroptællings-ID

created_at

datetime

Oprettelsestidsstempel

status

string

Altid active

tag_count

integer

Antal talte produkter

Vis lageroptællingsprodukter

Metode

GET

URL

/api/inventory-counts/{inventory_count_id}/products/

Beskrivelse

Returnerer alle produkter talt i en specifik lageroptælling.

Responsfelter:

Felt

Type

Beskrivelse

id

string

Unik identifikator

created_at

datetime

Hvornår produktet blev talt

product_sku

string

Produkt-SKU

product_name

string

Produktnavn

quantity

integer

Optalt antal

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 Indstillinger ‣ API. Udforskeren giver Dem mulighed for at afprøve hvert endpoint direkte fra Deres browser.

Se også