API-dokumentaatio

Käyttöoikeus ja avaimet

Jokainen kauppa saa oman avaimensa: ma- ja sen perässä 32 merkkiä. Lähetä se otsakkeessa X-Worker-Key (tai Authorization: Bearer). Avain toimii vain siihen kuuluvilla kaupan verkkotunnuksilla; lähetä verkkotunnus otsakkeessa X-Shop-Domain.

POST /lookup HTTP/1.1
Host: api.data-enricher.com
X-Worker-Key: ma-…
X-Shop-Domain: yourstore.com
Content-Type: application/json

Jokaisella avaimella on kuukausittainen pyyntöraja. Välimuistin vastauksia ei lasketa. Pyydä avainta yhteydenottosivulta.

POST /lookup

Hakee tuotteen EAN-koodin perusteella ja palauttaa tuotetiedot ja tarkistetut kuvat. EAN-8, UPC-A, EAN-13 ja GTIN-14 tarkistetaan tarkistusnumero mukaan lukien; UPC-A muunnetaan EAN-13:ksi.

{"ean": "7333377653917", "name": "Husqvarna 550i XP", "refresh": false}

{"result": {
  "ean": "7333377653917", "identified": true, "name": "Husqvarna 550i XP",
  "description": "…", "specs": {"Battery voltage": "36 V"},
  "images": {"in_use": ["https://…"], "product": ["https://…"]},
  "sources": ["https://…"], "cached": false, "credits_used": 0, "search": "free"
}}

Palautetaan enintään kahdeksan kuvaa, ensin kuvat tuotteesta käytössä. Vähintään kolmelle tuotekuvalle jätetään aina tilaa, jos niitä on saatavilla. Virhe on kentässä result.error; silloin mitään ei tallenneta, joten voit yrittää myöhemmin uudelleen.

POST /text

Kirjoittaa tuotetekstit yhdellä kielellä: otsikon, lyhyen ja pitkän kuvauksen, metaotsikon ja metakuvauksen.

{"ean": "7333377653917", "name": "Husqvarna 550i XP", "language": "en", "format": "html"}

language on ISO-koodi: nl, en, de, fr, es, it, pt, pl, da, sv, no, fi, cs, ro, zh, ja, ru tai ko. Muulla koodilla käytetään englantia ja palautetaan warning. format on html tai text.

Valmiin kuvauksen ( description ) lisäksi saat kuvauksen osina: intro_html ja sections (ominaisuudet, miksi valita tuote, edut, haitat, pakkauksen sisältö, usein kysytyt kysymykset, tietoa tuotemerkistä), joista jokaisella on otsikko tekstin kielellä. Kokoa oma kuvauksesi haluamistasi osioista haluamassasi järjestyksessä. details sisältää kaiken myös datana: tekniset tiedot, ominaisuudet, avainsanat, värit, materiaalit ja koot.

POST /page-text

Tekstit kategoria- tai tuotemerkkisivulle: lyhyt kuvaus yläosaan, pitkä kuvaus osioina, metaotsikko ja metakuvaus sekä sisäiset linkit oman kauppasi sivuille.

{"type": "category", "entity_id": 12, "name": "Chainsaws", "language": "en",
 "path": "Garden > Chainsaws", "subcategories": ["Cordless chainsaws"],
 "brands": ["Husqvarna"], "products": ["Husqvarna 550i XP"],
 "links": [{"type": "subcategory", "title": "Cordless chainsaws", "url": "https://yourstore.com/cordless-chainsaws"}],
 "shop_name": "Your Store"}

Linkit johtavat vain lähettämiisi URL-osoitteisiin, kuhunkin enintään kerran ja enintään kuusi linkkiä tekstiä kohti. Tuotemerkille ("type": "brand") lähetä categories kenttien subcategories ja brandssijaan; API etsii silloin myös tietoa tuotemerkistä verkosta.

POST /jobs

Enintään kaksikymmentä EAN-koodia kerralla, viisi haetaan samanaikaisesti. Saat tunnisteen job_id heti takaisin.

{"items": [{"ean": "7333377653917", "name": "Husqvarna 550i XP"}, {"ean": "8716637053167"}]}

Seuraa edistymistä pyynnöllä GET /jobs/{job_id}: status on queued, running tai done, ja results säilyttää pyyntösi järjestyksen.

GET /usage

Käyttösi ja rajasi nykyisellä jaksolla: pyynnöt, krediitit ja tekoälytokenit.

Virheet

Sisältövirheet, kuten tuote, jota ei löydy, palautetaan tilakoodilla 200 ja kentällä error tuloksessa.