REST API lekérdezés

A Listing Grid, a táblázat- és a diagramkészítő megjeleníti a REST API-végponton érkező elemeket, de szűrni nem tudja őket. A REST API lekérdezés típus ezt oldja meg: lekérdezést készíthetsz a végponton kapott elemekre. A típus csak bekapcsolt REST API-listázások modulnál jelenik meg.

A lekérdezés beállítása

1. Menj a JetEngine → Lekérdezéskészítő oldalra, és kattints az Új hozzáadása gombra.
2. Adj nevet a lekérdezésnek, és válaszd a REST API lekérdezés típust.
3. A REST API lekérdezés blokkban a Végpontról listában válaszd ki a weboldalon létrehozott végpontok egyikét.
4. A Lekérdezés blokkban az Új hozzáadása gombbal adj meg kulcs-érték párt: a Kulcs mezőbe az elem meta mezőjének nevét írd, az Érték mezőbe a keresett értéket. Az elem akkor kerül a listába, ha a kulcs értéke megegyezik a megadott értékkel.

https://minta-bolt.hu/wp-admin/admin.php?page=jet-engine-query&query_action=add

A képen a végpont kiválasztása és a lekérdezés kulcs-érték párjainak blokkja látszik.

Értéknek makrót is választhatsz a listából. Ha például a kulcs a szerző azonosítóját tároló meta mező, az érték pedig a „Current user ID” makró, a felhasználó az oldalon csak a saját elemeit látja.

Szűrés példa

Tegyük fel, hogy a végpont egy egyedi tartalomtípus filmeket tartalmazó elemeit adja vissza. Kulcs-érték párok nélkül a lekérdezés minden elemet visszaad, így a rá épített táblázat is mindet mutatja.

• Ha felveszed a contentRating kulcsot az R értékkel, a táblázat csak az R besorolású filmeket mutatja.
• Ha egy másodikat is megadsz, például a genres kulcsot a Horror értékkel, az eredmény tovább szűkül: csak a horror műfajú, R besorolású filmek maradnak.

A végpont tartalmát a böngészőben megnyitva (vagy kódszerkesztővel formázva) látod, melyek a kulcsok (a meta mezők) és melyek az értékek.

Külső API-k

A JetEngine egyedi tartalomtípusából kapott végpontot gond nélkül lekérdezheted. A REST API lekérdezés azonban nem működik minden külső API-val. A lekérdezésben megadott kulcs-érték párok a végpont címéhez kérdőjel után (query string paraméterként) kerülnek, ezért a Lekérdezéskészítő csak olyan API-val használható, amely query string paramétereket fogad. Ha az API az útvonalba (path paraméterként) építi a szűrőket, a lekérdezéssel nem szűrheted; ilyenkor az API saját felületén kell szűrni.

Kapcsolódó fejezetek: a REST API-elemek lekérdezése adattípusok szerint a _filters kulcsot és a haladó műveleteket mutatja be.