API-dokumentasjon

Tilgang og nøkler

Hver butikk får sin egen nøkkel: ma- etterfulgt av 32 tegn. Send den i headeren X-Worker-Key (eller Authorization: Bearer). En nøkkel fungerer bare for butikkdomenene som tilhører den; send domenet i 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

Hver nøkkel har en månedlig grense for forespørsler. Svar fra hurtigbufferen teller ikke. Be om en nøkkel via kontaktsiden.

POST /lookup

Slår opp et produkt etter EAN og returnerer fakta og kontrollerte bilder. EAN-8, UPC-A, EAN-13 og GTIN-14 valideres inkludert kontrollsifferet; UPC-A blir EAN-13.

{"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"
}}

Høyst åtte bilder returneres, bilder av produktet i bruk først, og det er alltid plass til minst tre produktbilder når de finnes. En feil står i result.error; da lagres ingenting, så du kan prøve igjen senere.

POST /text

Skriver produkttekstene på ett språk: tittel, kort og lang beskrivelse, metatittel og metabeskrivelse.

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

language er en ISO-kode: nl, en, de, fr, es, it, pt, pl, da, sv, no, fi, cs, ro, zh, ja, ru eller ko. En annen kode gir engelsk som reservespråk, med en warning. format er html eller text.

Ved siden av den ferdige description får du beskrivelsen i deler: intro_html og sections (egenskaper, hvorfor velge det, fordeler, ulemper, innhold i esken, ofte stilte spørsmål, om merket), hver med en overskrift på tekstens språk. Sett sammen din egen beskrivelse med delene og rekkefølgen du ønsker. details har også alt som data: spesifikasjoner, egenskaper, nøkkelord, farger, materialer og størrelser.

POST /page-text

Tekster for en kategori- eller merkeside: en kort beskrivelse øverst, en lang beskrivelse i deler, en metatittel og en metabeskrivelse, med interne lenker til sider i din egen butikk.

{"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"}

Lenker går bare til URL-ene du sender, hver URL høyst én gang og høyst seks per tekst. For et merke ("type": "brand") sender du categories i stedet for subcategories og brands; API-et søker da også etter merket på nettet.

POST /jobs

Opptil tjue EAN-koder på én gang, fem slås opp samtidig. Du får en job_id tilbake med en gang.

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

Følg fremdriften med GET /jobs/{job_id}: status er queued, running eller done, og results beholder rekkefølgen fra forespørselen din.

GET /usage

Forbruket ditt og grensene dine i den gjeldende perioden: forespørsler, kreditter og AI-tokener.

Feil

Innholdsfeil, for eksempel et produkt som ikke kan finnes, returneres med status 200 og en error i resultatet.