API JSON v1

Measúnuithe bia do d'aip

Tá gach rud a thaispeánann an suíomh ar fáil mar JSON freisin. Teastaíonn eochair API an fhreastalaí ó gach iarratas – seol í mar cheanntásc X-API-Key (nó Authorization: Bearer <eochair>). Ní chuireann idirghabhálaithe na freagraí i dtaisce riamh (Cache-Control: no-store) agus ceadaíonn siad CORS ó aon bhunús.

Críochphointí

Samplaí

# táirge de réir barrachóid
curl -H "X-API-Key: $API_KEY" "https://maxing.fitness/api/v1/product/3017624010701"

# cuardach saorthéacs, téacsanna i nGaeilge
curl -G -H "X-API-Key: $API_KEY" --data-urlencode "q=porridge oats" \
  "https://maxing.fitness/api/v1/search?lang=ga"

Teangacha

Is i mBéarla a bhíonn achoimrí agus cúiseanna de réir réamhshocraithe. Cuir lang leis le ceann de na cóid seo chun iad a fháil i dteanga eile de chuid an AE: bg, es, cs, da, de, et, el, en, fr, ga, hr, it, lv, lt, hu, mt, nl, pl, pt, ro, sk, sl, fi, sv. Is ionann rátálacha, scóir, aitheantais rialacha agus eochracha missing i ngach teanga.

Clúdach an fhreagra

{
  "ok": true,
  "data": {
    "product":  { "gtin": "3017624010701", "name": "Nutella", "brand": "Ferrero", "ingredientsText": "…",
                  "nutrition": { "basis": "100g", "carbs": 57.5, "sugars": 56.3, … },
                  "novaGroup": 4, "images": { "front": "…" }, "sources": [ { "name": "off", … } ] },
    "verdicts": {
      "healthy":   { "rating": "red",    "summary": "Nutri-Score E, ultra-processed, high in sugar and saturated fat", … },
      "fodmap":    { "rating": "yellow", "summary": "…", "reasons": ["…"], "matches": [ … ] },
      "keto":      { "rating": "red",    … },
      "glycemic":  { "rating": "yellow", … },
      "processed": { "rating": "red",    … }
    },
    "ingredients": [ { "text": "socker", "depth": 0, "section": "main" }, … ],
    "traces": ["nötter"],
    "labels": [],
    "cache": { "status": "hit", "fetchedAt": "2026-08-26T18:00:00.000Z", "partial": false }
  },
  "meta": { "classifierVersion": 2, "cache": "hit", "sources": ["off"], "attribution": { … } }
}

Rátálacha

Tá rating ag gach measúnú (green, yellow, red nó unknown), summary aon líne, reasons atá so-léite ag daoine, agus matches a thaispeánann na comhábhair (de réir innéacs in ingredients) a spreag é. Liostaíonn missing na sonraí a d'fheabhsódh an measúnú. Is é healthy an freagra iomlán: glas do tháirgí a bhfuil an Poll Eochrach (Nyckelhålet) orthu, nó an Nutri-Score murab amhlaidh (ó Open Food Facts, nó measta leis an algartam 2023, agus sa chás sin tá a phointí in score), céim síos do bhia ultraphróiseáilte. Tá na rialacha cáipéisithe sa README; nuair a athraítear iad go suntasach, méadaítear meta.classifierVersion (seoltar é freisin mar an ceanntásc X-Classifier-Version).

Earráidí

{ "ok": false, "error": { "code": "unauthorized", "message": "…" } }

400 invalid_gtin · 401 unauthorized · 404 product_not_found / not_found
503 api_not_configured · 503 upstream_unavailable / rate_limited (with Retry-After)

Barrachóid ó fhón póca

Is féidir le haipeanna dúchasacha scanadh le haon leabharlann barrachód agus glaoch ar GET /api/v1/product/{gtin} leis na digití loma: déantar EAN-8, UPC-A (dhá dhigit déag), EAN-13 agus GTIN-14 le nialais tosaigh a normalú go dtí an táirge céanna. Ní mór UPC-E a leathnú go UPC-A ar dtús. Déanann scanóir an tsuímh féin é seo go díreach sa bhrabhsálaí.

Taisceadh agus teorainneacha ráta

Cuirtear táirgí i dtaisce ar feadh 30 lá in aghaidh an GTIN agus nuashonraítear iad ó na bunachair sonraí foinse ina dhiaidh sin; má bhíonn na bunachair sonraí as feidhm, seoltar seanchóip. Ceadaíonn Open Food Facts thart ar 15 léamh táirge agus thart ar 10 gcuardach sa nóiméad do gach seoladh IP, mar sin d'fhéadfadh 503 rate_limited teacht ar ais má dhéantar a lán cuardaigh nua i ndiaidh a chéile – cloígh le Retry-After. Sonraí: Open Food Facts (ODbL) agus Dabas.