Skip to content

Részletes keresés

Találat limit

Bizonyos keresési típusok esetén előfordul, hogy sok találat van. Ilyen esetekben a végpontok a találatokat oldalakra osztva adják vissza.
Egy oldal alap helyzetben 20 találatot ad vissza, ez az érték növelhető egyészen 50-ig.

Mikor érdemes használni?

  • Ha több oldalnyi találatra lehet számítani a keresés eredményeként a limit növelésével csökkenthető a kérések száma.
  • Ha a keresés eredményét találati javaslatok megjelenítésére szeretnénk használni, érdemes csökkenteni a limitet, ezzel gyorsabb válaszidőt lehet elérni.

Sok oldalas válaszok

Amennnyiben egy keresés után 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 limit 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 az alap 20 találatnál több vagy kevesebb találatot szeretnénk visszakapni (maximálisan 50-et), a keresés url paraméterében a limit kulcs értékét (1 és 50 közötti egész számra) módosíthatjuk.

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.

Az alábbi példákban 1 találatot kérünk le:

import requests

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

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&limit=1',
  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&limit=1' \
--header 'X-Api-Key: TESZT-API-KULCS'

Sikeres hívás esetén, a válaszban csak egy találat lesz látható (ha volt találat).
A has_next mező értéke tájékoztat arról, hogy van e további találat.
Erről bővebben a lapozhatóság résznél olvashat.