Egyszerű keresés

Keresés név alapján

Ezen végpont segítségével vállalkozások nevére kereshetünk.

Elérhetőség

Teszt végpont: https://search-dev.api.cegjelzo.com/v1/names
Éles végpont: https://search.api.cegjelzo.com/v1/names

Paraméterek

A végpont hívásához szükséges egy api kulcs, illetve a keresett vállalkozás neve, vagy annak részlete. Ennyi adat alapján elindítható egy egyszerű keresés.
Lehetőség van azonban további szűrésekre is, melyekről bővebben az állapot szűrők oldalon olvashat.

Egyszerű példa hívás

Az alábbi példákon, melyek kizárólag demonstrálásra szolgálnak, egy egyszerű api hívást láthatunk:

import requests

url = "https://search-dev.api.cegjelzo.com/v1/names?value=cégjelző"

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égjelző',
  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%C3%A9gjelz%C5%91' \
--header 'X-Api-Key: TESZT-API-KULCS'

Sikeres hívás esetén, a szerződésben foglalt / kért teszt mezőktől függően az alábbihoz hasonló válasz érkezik:

{
    "current_page": 1, //(1)
    "has_next": false, //(2)
    "results": [ //(3)
        {
            "type": "companies", //(4)
            "status_code": 1, //(5)
            "full_name": "Cégjelző Céginformációs Korlátolt Felelősségű Társaság", //(6)
            "short_name": "Cégjelző Kft.", //(7)
            "address": "1124 Budapest, Kempelen Farkas Utca 1. Fszt. 3.", //(8)
            "tax_number": "26163190-2-43", //(9)
            "bank_accounts": [
                {
                    "bank_account": "10404072-50526871-56691003" //(10)
                }
            ],
            "founded_at": "2017-10-25", //(11)
            "registration_number": "01-09-305302", //(12)
            "social_tax_number": "HU26163190", //(13)
            "representatives": [
                {
                    "name": "Farkas Dezső" //(14)
                }
            ],
            "main_activities": [
                "6311 '08 Adatfeldolgozás, web-hoszting szolgáltatás" //(15)
            ]
        }
    ]
}

1. Jelenleg megjelenített oldal száma, pl. név keresésnél, vagy bankszámla szám részletnél történő keresésnél előfordulhat, hogy több találat keletkezik, mint amennyit az API egyben vissza tudna adni, részletesen erről a mechanizmusról a "Pagináció" fejezetben lehet többet olvasni.
2. A paginácó mechanizmus használatához szükséges bool érték
3. Találati lista. Amennyiben üres lista az eredmény, nincs találat.
4. A vállalkozás típusa, jelenleg a companies - társas vállalkozás, self_employed - egyéni vállalkozó, budget_orgs - költségvetési szerv, civil_orgs - civil szervezet értékek közül vehet fel egyet
5. A vállalkozás állapota - 0 érték esetén a vállalkozás megszűnt, 1 érték esetén működik, 2 érték esetén szünetelteti tevékenységét (csak egyéni vállalkozóknál fordulhat elő)
6. A vállakozás teljes neve
7. A vállalkozás rövid neve, csak társas vállalkozások illetve civil szervezetek esetén értelmezhető mező
8. A vállalkozás székhelye
9. A vállakozás adószáma
10. A vállalkozás bankszámlaszáma listába foglalva
11. A vállalkozás alapításának / bejegyzésének ideje
12. A vállalkozás nyilvántartási száma, formátuma a vállalkozási formától függ
13. A vállakozás közösségi adószáma
14. A vállalkozás képviseletére jogosult(ak) listája, nem minden vállalkozás típusnál értelmezhető mező
15. A vállalkozás főtevékenysége(i)