API

Gem Logic API mahdollistaa integroinnin ulkoisiin järjestelmiin ja työnkulkujen automatisoinnin. Voitte käyttää sitä tuotteiden, myyntien, kontaktien, korjausten, inventaarioiden ja tulostustehtävien hallintaan ohjelmallisesti.

Siirtykää kohtaan Asetukset ‣ API luodaksenne ja hallitaksenne API-avaimianne.

Todennus

Kaikkien API-pyyntöjen on sisällettävä API-avain x-api-key HTTP-otsakkeessa. Voitte luoda avaimia sivulta Asetukset ‣ API. Avaimet voidaan poistaa käytöstä tai poistaa milloin tahansa.

Esimerkkipyyntö:

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

Vaara

Pitäkää API-avaimenne salaisina. Älä koskaan jakakaa niitä julkisissa tietovarastoissa tai asiakaspuolen koodissa. Jos avain vaarantuu, poistakaa se välittömästi käytöstä ja luokaa uusi.

Perus-URL

Kaikki päätepisteet ovat suhteessa instanssienne URL-osoitteeseen /api/-etuliitteen alla:

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

Vastausmuoto

Kaikki vastaukset palautetaan JSON-muodossa. Onnistuneet pyynnöt palauttavat 200 (GET) tai 201 (POST) tilakoodin. Virheet palauttavat asianmukaisen tilakoodin ja viestin:

• 200 OK — onnistunut GET-pyyntö

• 201 Created — onnistunut POST-pyyntö

• 400 Bad Request — virheelliset tai puuttuvat tiedot

• 401 Unauthorized — virheellinen tai puuttuva API-avain

• 404 Not Found — resurssia ei ole olemassa

Päätepisteet

Markkinapaikat

Menetelmä	GET
URL	/api/marketplaces/
Kuvaus	Palauttaa luettelon kaikista myyntikanavista.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
id	integer	Yksilöllinen tunniste
marketplace	string	Marketplacen nimi

Tuotteet

Listaa tuotteet

Menetelmä	GET
URL	/api/products/{marketplace_id}
Kuvaus	Palauttaa marketplacen mukaan suodatetut tuotteet. Käyttäkää marketplace-ID:tä marketplaces-päätepisteestä.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
id	integer	Yksilöllinen tunniste
item_sku	string	Tuotteen SKU
created	datetime	Luontipäivä
status	string	Tuotteen tila
images	array	Luettelo tuotekuvista (id, image)
item_weight	decimal	Paino
item_height	decimal	Korkeus
item_length	decimal	Pituus
item_width	decimal	Leveys

Luo tuotekuva

Menetelmä	POST
URL	/api/products/create/image/
Kuvaus	Lataa tuotekuva base64-koodauksella. Jos tuotteen SKU:ta ei vielä ole olemassa, uusi tuote luodaan automaattisesti.

Pyynnön kentät:

Kenttä	Tyyppi	Vaaditaan	Kuvaus
item_sku	string	Kyllä	Tuotteen SKU, johon kuva liitetään
image	string (base64)	Kyllä	Base64-koodattu kuva-aineisto

Myynti

Listaa myynnit

Menetelmä	GET
URL	/api/sales/
Kuvaus	Palauttaa listan kaikista myyntitilauksista.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
order_id	string	Yksilöllinen tilaustunniste

Luo myynti

Menetelmä	POST
URL	/api/sales/create/
Kuvaus	Luo uuden myyntitilauksen.

Yhteystiedot

Menetelmä	GET
URL	/api/contacts/
Kuvaus	Palauttaa listan kaikista yhteyshenkilöistä.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
id	integer	Yksilöllinen tunniste
complete_name	string	Koko nimi
contact_type	string	Yhteyshenkilön tyyppi
email	string	Sähköpostiosoite
phone	string	Puhelinnumero
language	string	Ensisijainen kieli

Korjaukset

Luo korjaus

Menetelmä	POST
URL	/api/repairs/create/
Kuvaus	Luo uuden korjaustilauksen, johon liitetään korjausartikkeli. Jos myyntipistettä tai osastoa ei ole määritetty, käytetään ensimmäistä saatavilla olevaa.

Pyynnön kentät:

Kenttä	Tyyppi	Vaaditaan	Kuvaus
client_id	integer	Ei	Asiakkaan/yhteyshenkilön tunnus
marketplace	merkkijono / kokonaisluku	Ei	Myyntipisteen tunnus tai nimi
division_id	integer	Ei	Osaston tunnus
title	string	Ei	Korjausartikkelin otsikko tai kuvaus
repair_info_1	string	Ei	Lisätietoja korjauksesta
repair_info_2	string	Ei	Lisätietoja korjauksesta
repair_info_3	string	Ei	Lisätietoja korjauksesta
quantity	decimal	Ei	Määrä (oletus: 1)
weight	decimal	Ei	Artikkelin paino
weight_unit	string	Ei	Painon mittayksikkö
size	string	Ei	Artikkelin koko
color	string	Ei	Artikkelin väri
engravement	string	Ei	Kaiverrusteksti
client_reference | string		Ei	Asiakkaan viitenumero

Esimerkkivastaus:

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

Lisää tuote korjaukseen

Menetelmä	POST
URL	/api/repairs/add-item/
Kuvaus	Lisää uuden tuotteen olemassa olevaan korjaustilaukseen.

Pyynnön kentät:

Kenttä	Tyyppi	Vaaditaan	Kuvaus
order_id	string	Kyllä	Korjauksen tilaus-ID, johon tuote lisätään
item_sku	string	Ei	Tuotteen SKU, joka linkitetään tuotteeseen
title	string	Ei	Otsikko tai kuvaus
repair_info_1	string	Ei	Lisätietoja korjauksesta
repair_info_2	string	Ei	Lisätietoja korjauksesta
repair_info_3	string	Ei	Lisätietoja korjauksesta
quantity	decimal	Ei	Määrä (oletus: 1)
weight	decimal	Ei	Artikkelin paino
weight_unit	string	Ei	Painon mittayksikkö
size	string	Ei	Artikkelin koko
color	string	Ei	Artikkelin väri
engravement	string	Ei	Kaiverrusteksti
client_reference | string		Ei	Asiakkaan viitenumero
cost	decimal	Ei	Tuotteen kustannus

Inventaariolaskennat

Luo inventaariolaskenta

Menetelmä	POST
URL	/api/inventory-counts/
Kuvaus	Luo uuden inventaariolaskentaistunnon.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
id	string	Inventaariolaskennan ID
created_at	datetime	Luomisen aikaleima
status	string	Aina active
tag_count	integer	Laskettujen tuotteiden määrä

Listaa inventaariolaskennan tuotteet

Menetelmä	GET
URL	/api/inventory-counts/{inventory_count_id}/products/
Kuvaus	Palauttaa kaikki tietyssä inventaariolaskennassa lasketut tuotteet.

Vastauskentät:

Kenttä	Tyyppi	Kuvaus
id	string	Yksilöllinen tunniste
created_at	datetime	Milloin tuote laskettiin
product_sku	string	Tuotteen SKU
product_name	string	Tuotteen nimi
quantity	integer	Laskettu määrä

Tulostustyöt

Menetelmä	POST
URL	/api/print-pdf/
Kuvaus	Lataa PDF-tiedosto tulostusjononolle tietylle tulostimelle. Tiedosto tarkistetaan muodon ja turvallisuuden osalta. Tiedoston enimmäiskoko on 20 Mt. Käytä sisältötyyppiä multipart/form-data.

Pyynnön kentät:

Kenttä	Tyyppi	Vaaditaan	Kuvaus
pdf	tiedosto	Kyllä	Tulostettava PDF-tiedosto (enintään 20 Mt)
printer_uuid	UUID	Kyllä	Kohdetulostimen UUID
landscape	totuusarvo	Ei	Tulosta vaaka-asennossa (oletus: false)

Esimerkkipyyntö:

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"

Esimerkkivastaus:

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

Interaktiivinen API-selain

Gem Logic sisältää sisäänrakennetun interaktiivisen API-selaimen, joka perustuu Swagger UI:hin. Pääsette siihen API-dokumentaatio-linkin kautta sivulla Asetukset ‣ API. Selain mahdollistaa kunkin päätepisteen kokeilun suoraan selaimestanne.

Katso myös

• Integraatiot