Receptkereső API dokumentáció

Az Edamam B2B API-t úgy lehet elérni, hogy HTTPS-kérelmeket küldünk meghatározott URL-ekre az alábbiakban leírtak szerint. Az alap URL a https://api.edamam.com, és a teljes URL-t úgy kapja meg, hogy a kérelem elérési útját hozzáfűzi az alap URL-hez, például https://api.edamam.com/search

Siker esetén az API 200 HTTP-kódot ad vissza, és a törzs tartalmazza a lekérdezés eredményét JSON formátumban. Hibák esetén az API hibakódot ad vissza (pl. 404 NOT FOUND). A törzs hasznos információkat tartalmazhat HTML formátumban. Az ügyfélprogramoknak csak a válaszkódokat kell használniuk, mivel a törzseket az ügyfél fejlesztők kényelme érdekében biztosítják.

Az Edamam szerverek támogatják a szokásos HTTP tömörítést a gzip használatával. A tömörítés használata csökkentheti a válasz méretét, és ezáltal növelheti az átviteli sebességet.

Az ügyfél a következő fejlécet tartalmazhatja, hogy jelezze, milyen tömörítési módszereket támogat:

Elfogadás-kódolás: gzip

A kiszolgáló ezután a következő fejlécet tartalmazza a tömörített válasz jelzésére

Tartalomkódolás: gzip

vagy kihagyja, ha a válasz nincs tömörítve.

További információ itt található: http://en.wikipedia.org/wiki/Http_compression.

Keresés

Pálya: https://api.edamam.com/search

Spanyol receptekért be kell érnie a bétát a következő címen: Pálya: https://test-es.edamam.com/search

Keresse meg a megadott lekérdezésnek megfelelő recepteket. Győződjön meg arról, hogy a lekérdezések a megfelelő nyelven vannak-e az egyes hozzáférési pontokon!

A következő paraméterek a GET kérés URL részei:

Keresés tápanyagtartomány szerint

A tápanyagtartományokat paraméterek hozzáadásával a következő formában adhatja meg:

tápanyagok [NTR] = RANGE ahol

Az NTR a következők egyike: CA, CHOCDF, CHOLE, FAMS, FAPU, FASAT, FAT, FATRN, FE, FIBTG, FOLDFE, K, MG, NA, NIA, P, PROCNT, RIBF, SUGAR, THIA, TOCPHA, VITA_RAE, VITB12, VITB6A, VITC, VITD, VITK1 vagy ZN;

A RANGE a MIN +, MIN - MAX vagy MAX egyikében van, ahol a MIN és MAX nem negatív egész számok.

Például:
tápanyagok [CA] = 50 + legalább 50 mg kalciumot jelent, ahol az „50 +” értéket megfelelően „50% 2B” -ként kell kódolni
tápanyagok [FAT] = 30 legfeljebb 30 g zsírt és
a tápanyagok [FE] = 5-10 jelentése 5 mg és 10 mg közötti vas
megjegyzés: mindig kódolja az URL-t, azaz a tápanyagok [FE] tápanyagok% 5BFE% 5D

A keresési kérelmekben több tápanyagtartományt is kombinálhat

NTR kódnév egység NTR kódnév egység

CA	Kalcium	mg	ENERC_KCAL	Energia	kcal
CHOCDF	Szénhidrát	g	NIA	Niacin (B3)	mg
CHOLE	Koleszterin	mg	P	Foszfor	mg
FAMS	Egyszeresen telítetlen	g	PROCNT	Fehérje	g
FAPU	Többszörösen telítetlen	g	RIBF	Riboflavin (B2)	mg
FASAT	Telített	g	CUKOR	Cukrok	g
ZSÍR	Zsír	g	THIA	Tiamin (B1)	mg
FATRN	Ford	g	TOCPHA	E-vitamin	mg
FE	Vas	mg	VITA_RAE	A-vitamin	æg
FIBTG	Rost	g	VITB12	B12-vitamin	æg
FOLDFE	Folát (egyenértékű)	æg	VITB6A	B6-vitamin	mg
K	Kálium	mg	VITC	C vitamin	mg
MG	Magnézium	mg	VITD	D-vitamin	æg
NA	Nátrium	mg	VITK1	K-vitamin	æg

Negatív keresés (kizárt összetevők)

Megadhatja azokat az ételeket, amelyek nem kívánnak jelen lenni a keresési kérelem által visszaadott eredményekben.

Ezt a módszert az étrend/egészség/allergén címkékkel kell kombinálni, és nem azok helyettesítésére szolgál.

Példa: Csak olyan recepteket szeretne visszakapni, amelyek nem tartalmaznak glutént, sertéshúst vagy joghurtot. Ekkor a következő kizárásokat használja:

Ez a kérés a megfelelő „q =” kifejezéssel kombinálva olyan recepteket eredményez, amelyek nem tartalmaznak sima joghurtot vagy sima görög joghurtot, és amelyek szintén glutén- és sertéshús-mentesek.

Ha azonban olyan recepteket szeretne kapni, amelyek egyáltalán nem tartalmaznak tejet vagy naplót, akkor jobb, ha a „tejmentes” vagy a „tejmentes” címkéket használja, ahelyett, hogy az összes lehetséges laktózt tartalmazó ételt felsorolná a kizárt összetevőben

Íme néhány példa az összetevők kizárásának működésére:
• A „padlizsán” kizárja mind a padlizsánt, mind a padlizsánt, mivel ezek szinonimák
• A „csirkemell” csak a bőrrel rendelkező csirkemellet zárja ki, a „csirkemellet” vagy a „bőr nélküli csirkemellet” azonban nem, mivel táplálkozásilag különböző
• A „spagetti” kizár mindenfajta normál tésztát, mint például a makaróni vagy a linguini, mivel mind táplálkozásilag ugyanaz az étel, csak más formátumban. Nem zárja ki azonban a főtt tésztát vagy a teljes kiőrlésű tésztát, mivel azok különböznek a szokásos tésztától.

A negatív keresés a kifejezés címét is megkeresi a recept címében szereplő „kizárt =” paraméterből. Tehát a „kizárt = joghurt” nem csak azokat a recepteket zárja ki, amelyek az összetevő sima joghurtot tartalmazzák az összetevők listáján, hanem azokat a recepteket is, amelyek címükben tartalmazzák a joghurt kifejezést - például „görög joghurt öntettel”

Példa GET kérésre

Íme egy példa a curl használatára:

MEGJEGYZÉS: Kérjük, győződjön meg arról, hogy a pontos API-hoz készített hitelesítő adatokat használta, mivel azok alkalmazás- és tervspecifikusak. A $ < >a jelölés a bemenet típusát jelenti, és NEM szerepelhet magában a kérésben.

Típusok

Az összetett típusokat a JSON reprezentációjuk alapján írják le.

A leírások során a következő jelöléseket használják:
logikai érték, egész szám, úszó, és húr állítsa a JavaScript primitív típusokat Logikai, egész szám, úszó, és húr, illetőleg enum olyan karakterlánc mezőt jelöl, amely csak egy előre meghatározott tartomány értékeit veszi fel (a tartomány adott esetben meg van adva) T [] típusú objektumok tömbjét jelenti T
T [] olyan objektumot jelöl (asszociatív térkép), amelynek minden mezője (elem) típusú T.

A mező típusának leírása

q	húr	Lekérdezés szövege, benyújtva
tól től	egész szám	Első eredmény index, benyújtva
nak nek	egész szám	Utolsó eredmény index, beküldve
számol	egész szám	Talált találatok száma
több	logikai érték	Több, mint a találatok maximálisan megengedett száma
slágerek	Találat[]	Egyező eredmények (Találat tárgyak)

A mező típusának leírása

recept	Recept	Egyező recept (Recept tárgy)
könyvjelzővel	logikai érték	Ezt a receptet a kereső felhasználó könyvjelzővel látta el?
vásárolt	logikai érték	Ezt a receptet a kereső felhasználó vásárolta meg?

Recept

Megjegyzés: A mezőknek csak egy részhalmaza lehet jelen, attól az interfésztől függően, amelyen keresztül a recept elkészült. A részletekért lásd az adott felület leírását

A mező típusának leírása

uri	húr	Ontológia azonosító
címke	húr	Recept címe
kép	húr	Kép URL-je
forrás	húr	Forrás helyazonosító
url	húr	Eredeti recept URL
hozam	egész szám	Adagok száma
kalória	úszó	Teljes energia, kcal
teljes súly	úszó	Teljes tömeg, g
összetevők	Hozzávaló[]	Összetevők listája
összesenTápanyagok		Összes tápanyag a teljes recepthez. Az összes tápanyag/hozam megegyezik a tápanyagok adagonként
totalDaily		% a napi érték a teljes receptnél. összes/napi/hozam megegyezik a tápanyagok adagonként
diétaCímkék	enum []	Diétás címkék: „kiegyensúlyozott”, „magas fehérjetartalmú”, „magas rosttartalmú”, „alacsony zsírtartalmú”, „alacsony szénhidráttartalmú”, „alacsony nátriumtartalmú” (a címkék adagonként vannak feltüntetve)
egészségcímkék	enum []	Egészségügyi címkék: „vegán”, „vegetáriánus”, „paleo”, „tejmentes”, „gluténmentes”, „búzamentes”, „zsírmentes”, „alacsony cukortartalmú”, „tojásmentes”, „Földimogyoró-mentes”, „fa-dió-mentes”, „szója-mentes”, „hal-mentes”, „kagyló-mentes” (a címkék adagonként vannak feltüntetve)

Hozzávaló

A mező típusának leírása

foodId	húr	Élelmiszer-azonosító
Mennyiség	úszó	A meghatározott intézkedés mennyisége
intézkedés	Intézkedés	Intézkedés
súly	úszó	Teljes tömeg, g
étel	Étel	Étel
foodCategory	húr	Bevásárló folyosó kategória

Felhívjuk figyelmét, hogy egyes tervek nem feltétlenül tartalmazzák az összetevő objektum összes mezőjét. A részletekért keresse fel az API oldalt, és fontolja meg egy másik tervre történő frissítést, ha az összes mezőre szüksége van.