Skip to content

Részletes keresés

Lapozhatóság

Bizonyos keresési típusok esetén előfordul, hogy sok találat van.
Ezekben az esetekben a választ oldalakra bontva adják vissza a végpontok.

Sok oldalas válaszok

Amennnyiben egy keresés eredményeként 2-3 oldalnál több találatot kapunk, érdemes megpróbálni szűkíteni a keresési feltételeket, vagy a keresés kulcsadatát pontosítani.
Ezt fontos szem előtt tartani, mert a havi fogyasztásba a végpontok felé indított összes kérés beleszámít.

A lapozás használata

Info

A funkció az API összes végpontjánál alkalmazható, hogy egységes legyen az API használata. Az egyértelmű keresések, például regisztrációs szám alapján történő keresés, esetén nem befolyásolja a találatokat.

Amennyiben a találatok egynél több oldalon jeleníthetők csak meg, azt a végpont a has_next mezőben igaz (true) értékkel jelzi. Ezekben az esetekben az összes találat úgy kérdezhető le, hogy a kérés addig ismételjük egyre növekvő page url paraméterrel, amíg a has_next mező értéke hamis (false) lesz.

Egyszerű példa hívás

Figyelem

A példában megadott TESZT-API-KULCS-ot át kell írni az hozzáférésben kapott X-Api-Key értékére.

Első hívás eredményének kerete (találatok levágásra kerültek, példa szempontjából nem fontosak)

{
    "current_page": 1,
    "has_next": true,
    "results": [ ... ]
}
A current_page értéke 1, tehát jelenleg a találatok első oldalát látjuk.
A has_next mező értéke igaz, azaz van (legalább) egy további oldal, amit lekérdezhetünk. Mikor következő oldal találatait szeretnénk lekérni módosítjuk a page paraméter értékét 2-re.

Második oldal lekérdezése
import requests

url = "https://search-dev.api.cegjelzo.com/v1/names?value=cégnév&page=2"

payload = {}
headers = {
  'X-Api-Key': 'TESZT-API-KULCS'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.json)

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://search-dev.api.cegjelzo.com/v1/names?value=cégnév&page=2',
  headers: { 
    'X-Api-Key': 'TESZT-API-KULCS'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

curl --location 'https://search-dev.api.cegjelzo.com/v1/names?value=cégnév&page=2' \
--header 'X-Api-Key: TESZT-API-KULCS'
Második oldal lekérdezés válaszának kerete (a találatok le lettek vágva, példa szempontjából nem fontosak)

{
    "current_page": 2,
    "has_next": false,
    "results": [ ... ]
}
A találatok második oldalának lekérdezését követően a fenti válasz alapján látszik, hogy a has_next értéke hamis lett, azaz nincs több lekérdezhető oldal.