Részletes keresés

Állapot szerinti szűrés

Bizonyos keresési feltételek mellett fontos tényező lehet, hogy csak az aktív vállalkozás típusokat adja vissza az API, erre az esetre nyújt segítséget az állapot szerinti szűrés.

Mikor érdemes használni?

Mikor a felhasználás módja csak a működő cégek esetén értelmezhető (pl. számlázási űrlap automatikus kitöltése)
Olyan keresés esetén, ahol több találat is valószínű (pl. névrészletre keresünk), ezzel szűkíthetjük a találati listát

Szűrő használata

Info

Ez a szűrő az API összes végpontjánál alkalmazható.

A meglévő keresési feltételek után hozzáfűzzük a híváshoz a only-active=1 url paramétert.

Info

Az only-active mező egy két értékes mező, melynek értéke lehet 0 vagy 1.

0 esetén nem történik státusz szerinti szűrés, ez az alapértelmezett működés.
1 esetén kizárólag aktív státusszal rendelkező vállalkozásokat fogunk találatként visszaadni.

Példa hívás

Az alábbi példákon, melyek kizárólag demonstrálásra szolgálnak, egy bővített, szűrővel ellátott API hívást láthatunk:

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.

PythonNodeJscURL

import requests

# A limit mező elhagyható, csak a példa válasz átláthatósága miatt került alkalmazásra
url = "https://search-dev.api.cegjelzo.com/v1/names?value=aktív cég&only-active=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,
  // A limit mező elhagyható, csak a példa válasz átláthatósága miatt került alkalmazásra
  url: 'https://search-dev.api.cegjelzo.com/v1/names?value=aktív cég&only-active=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=akt%C3%ADv%20c%C3%A9g&only-active=1' \
--header 'X-Api-Key: TESZT-API-KULCS'

Válasz

Sikeres hívás esetén, a válasz results listáján csak olyan vállalkozások fognak szerepelni, melyek status mezőjének értéke 1 (azaz működő vállalkozás)