Egyszerű keresés
Keresés regisztrációs szám alapján
A végpont segítségével vállalkozások nyilvántartási számára kereshetünk.
Elérhetőség
Teszt végpont: https://search-dev.api.cegjelzo.com/v1/reg-numbers
Éles végpont: https://search.api.cegjelzo.com/v1/reg-numbers
Teszt végpont
A teszt és az éles végpont felépítése megegyezik. A mögötte lévő infrastuktúra az éles környezet leskálázott (gyengébb) változata. Célja, hogy megkönnyítse az integrátorok munkáját.
Segítségével megvalósítható az integráció, az éles havi kvóta felhasználása nélkül.
A teszt hozzáférés havi 2000 lekérdezést biztosít.
A végpontot a Cégjelző Kft. is használja új funkiók tesztelésére.
Rendelkezésreállása nem reprezentálja az éles végpont elérhetőségét. A végpontot kiszolgáló adatbázis adatai régiek (5-6 évesek), ezért éles rendszerbe való bekötése nem javasolt.
Végpontok elérhetősége
A teszt és éles végpont hozzáférhetőségét külön-külön szabályozzuk.
Az éles végpontot csak szerződött partnereinknek nyitjuk meg. Amennyiben nincs még éles hozzáférése, kérjük keresse fel ügyfélszolgálati munkatársunkat.
Paraméterek
A végpont hívásához szükséges egy api kulcs, illetve a keresett vállalkozás nyilvántartási száma.
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.
Nyilvántartási szám
A nyilvántartási szám vállalkozási formától függ, például cégek esetén ez a cégjegyzékszám, viszont költségvetési szervek esetén ez a törzskönyvi azonosító szám.
A nyilvántartási szám formátuma vállalkozási típus szerint:
- Társas vállalkozásoknál a formátum a következő:
xx-yy-zzzzzz - Egyéni vállalkozó esetén a formátum a következő:
xxxxxxxx - Civil szervezet esetén a formátum a következő:
xx-yy-zzz - Költségvetési szerv esetén a formátum a következő (törzskönyvi azonosító szám):
xxxxx
Amenyeknél az x, y, z mind számjegyek.
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:
Példák pontossága
A dokumentációban feltűntetett példák tájékoztató jellegűek, a dokumentáció készítésekor kerültek kipróbálásra a teszt API végponton. A példákra adott válasz tartalma eltérhet a dokumentációban látottaktól.
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.
import requests
url = "https://search-dev.api.cegjelzo.com/v1/reg-numbers?value=01-09-305302"
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/reg-numbers?value=01-09-305302',
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/reg-numbers?value=01-09-305302' \
--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)
]
}
]
}
- 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.
- A paginácó mechanizmus használatához szükséges bool érték
- Találati lista. Amennyiben üres lista az eredmény, nincs találat.
- 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 - 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ő)
- A vállakozás teljes neve
- A vállalkozás rövid neve, csak társas vállalkozások illetve civil szervezetek esetén értelmezhető mező
- A vállalkozás székhelye
- A vállakozás adószáma
- A vállalkozás bankszámlaszáma listába foglalva
- A vállalkozás alapításának / bejegyzésének ideje
- A vállalkozás nyilvántartási száma, formátuma a vállalkozási formától függ
- A vállakozás közösségi adószáma
- A vállalkozás képviseletére jogosult(ak) listája, nem minden vállalkozás típusnál értelmezhető mező
- A vállalkozás főtevékenysége(i)
Találatok mennyisége
A keresés típusától függően változó mennyiségű találat lehetséges.
Kevésbé egyértelmű kereséseknél (pl. név/névrészlet, részleges bankszámlaszám), előfordulhat 1-nél több találat is.
Adóazonosító és nyilvántartási szám esetén általában 1 találat lehetséges. Előfordulhat azonban, hogy az adótörzsszám a múltban a vállalkozás egy másik típusához tartozott (pl. Egyéni cégből átalakult egyéni vállalkozóvá), ebben az esetben mindkét vállalkozást visszaadja az API.