Dokumentáció

v 1.0 - 2024.06.26

Ismertető

A Cégadat API egy RESTful API, amely valós idejű hozzáférést biztosít Magyarország összes bejegyzett társas vállalkozásának naprakész adataihoz. Az API könnyedén integrálható bármilyen programozási nyelvvel, és a válaszok strukturált JSON formátumban érhetőek el.
Az API használatához előfizetés szükséges, és a sikeres integrációhoz alapvető fejlesztői ismeretek szükségesek.

Hitelesítés

Az API használatához API kulcs szükséges, amelyet a cegadatapi.hu/regisztracio oldalon igényelhet. Az API kulcsot a kérések X-Api-Key fejlécében kell megadni.
Az API kommunikáció HTTPS protokollt használ a biztonság érdekében.

Végpontok

Az API a következő végpontokat biztosítja:
  • Cégek keresése:
    - név alapján: /v1/search?name={cég neve}
    - adószám alapján: /v1/search?vatNumber={adószám}
    - cégjegyzékszám alapján: /v1/search?regNumber={cégjegyzékszám}
  • Cégadatok lekérdezése:
    - adószám alapján: /v1/detail?id={adószám}

Keresés

GET  api.cegadatapi.hu/v1/search

A cégek keresése API lehetővé teszi a keresést cégnév alapján. Ez hasznos lehet például, amikor egy cég név alapján szeretne cégeket keresni és gyorsan megkapni az alapvető információkat róluk.
Paraméterek:
Paraméter Típus Leírás Példa
HEADER
X-Api-Key string Kötelező. Header-ben küldött API kulcs.
GET
name string Cégnév alapján történő kereséshez.
Minimum 4 karakter.
name=Welldata
vatNumber number Keresés adószám alapján. Pontos egyezés szükséges. vatNumber=32305964243
registryNumber number Keresés cégjegyzékszám alapján. Pontos egyezés szükséges. registryNumber=0109417185
sensitivity number Érzékenység cégnév keresés esetén.

0 - elírásbarát (alapértelmezett)
  Támogatja az elgépeléseket, a találatokat relevancia sorrendjében jeleníti meg.
1 - részleges egyezés
  A találatok részben vagy egészében, elírás nélkül tartalmazzák a keresési kifejezést.
2 - pontos egyezés
  Pontos rövid vagy teljes cégnév megadás esetén ad vissza találatot.
sensitivity=1
limit number Találatok száma legfeljebb. 1-100 közötti érték,
Alapértelmezett: 50
limit=100
page number Lapozás, amennyiben több oldalnyi találat van page=2
status enum A cég állapota.
Lehetséges értékek: "Aktív", "Eljárás alatt"
status=Aktív
Lekérdezés minta:
                 curl -G "https://api.cegadatapi.hu/v1/search" -H "X-Api-Key: 12345678" --data-urlencode "name=WellData"
            
                {
    "status": true,
    "response": {
        "meta": {
            "current": 1,
            "total_pages": 1,
            "total_results": 1,
            "size": 50
        },
        "results": [
            {
                "id": "32305964243",
                "vatNumber": "32305964243",
                "fullName": "WellData Korlátolt Felelősségű Társaság",
                "shortName": "WellData Kft.",
                "status": "Aktív"
            }
        ]
    }
}
            
Adatlap lekérés

GET  api.cegadatapi.hu/v1/detail

A cégadat lekérdező API lehetővé teszi részletes cégadatok lekérését adószám megadása segítségével. Ez az API végpont különösen hasznos, ha pontos és részletes információra van szükség egy konkrét cégről, például pénzügyi adatok vagy a cég teljes neve és címe.
Paraméterek:
Paraméter Típus Leírás Példa
HEADER
X-Api-Key string Kötelező. Header-ben küldött API kulcs.
GET
id number A cég azonosítója, ami az adószáma is egyben. id=32305964243
Lekérdezés minta:
                 curl -G "https://api.cegadatapi.hu/v1/detail" -H "X-Api-Key: 12345678" --data-urlencode "id=32305964243"
            
                {
    "status": true,
    "response": {
        "results": {
            "fullName": "WellData Korlátolt Felelősségű Társaság",
            "shortName": "WellData Kft.",
            "legalForm": "Korlátolt felelősségű társaság",
            "fullAddress": "1193 Budapest, Derkovits Gyula utca 53.",
            "addressCounty": "Budapest",
            "addressPostalCode": "1193",
            "addressCity": "Budapest",
            "addressStreet": "Derkovits Gyula utca 53.",
            "vatNumber": "32305964243",
            "registryNumber": "0109417185",
            "dateFounded": "2023-06-12",
            "statisticalCode": "32305964639911301",
            "reportDate": "2023-12-31",
            "netRevenue": 28869000,
            "operatingProfit": "12499000",
            "earningsBeforeTaxes": "12422000",
            "netSalesRevenues": "11304000",
            "totalAssets": "15863000",
            "employeeDate": "2023-12-31",
            "employeeCount": 2,
            "ownerCount": 1,
            "owners": [
                "Smidhoffer Vanessza Míra"
            ],
            "managerCount": 1,
            "managers": [
                "Smidhoffer Vanessza Míra"
            ],
            "principalActivity": "6399. M.n.s. egyéb információs szolgáltatás",
            "activities": [
                "6399. M.n.s. egyéb információs szolgáltatás",
                "6311. Adatfeldolgozás, web-hoszting szolgáltatás",
                "7311. Reklámügynöki tevékenység",
                "6312. Világháló-portál szolgáltatás",
                "6201. Számítógépes programozás",
                "6202. Információ-technológiai szaktanácsadás",
                "7022. Üzletviteli, egyéb vezetési tanácsadás",
                "5812. Címtárak, levelezőjegyzékek kiadása",
                "5829. Egyéb szoftverkiadás"
            ],
            "bankAccounts": [
                {
                    "bankName": "OTP Fiók Tapolca",
                    "accountNumber": "11748052-24863069-00000000"
                },
                {
                    "bankName": "OTP Veszprém m. Belföldiek Devizái",
                    "accountNumber": "11763488-58524886-00000000"
                }
            ],
            "status": "Aktív"
        }
    }
}
            

Hibaüzenetek

Az API hagyományos HTTP állapotkódokat használ a lekérési állapot jelzésére.
Sikertelen kérés esetén JSON válaszban érhető el további információ a hiba okáról.

Hibakód Státuszkód Üzenet
1 400 A megadott API kulcs nem érvényes
2 400 Érvénytelen API hívás
3 500 Belső szerver hiba történt
4 400 A megadott kulcsszó túl rövid
5 401 Érvénytelen, vagy lejárt előfizetés
6 401 Érvénytelen, vagy megszűnt csomag
7 429 A csomagban foglalt limit elérve
404 404 Ismeretlen végpont
Hibaüzenet minta:
                {
    "status": false,
    "error": "Invalid API Key",
    "errorCode": 1,
    "statusCode": 400
}
            

Teszteléshez használható API kulcs

A teszt API kulcs lehetőséget biztosít a rendszer integrációs tesztelésére. Felhívjuk figyelmét, hogy kizárólag a működés szimulálására alkalmas, és nem tartalmaz valódi adatokat.

29.ea35adea153cbc8896913d744548dafc   

Próbálja ki most! Csatlakozást követően azonnal használható az API.

Ügyfeleink, akik bíztak bennünk.

mobile-logo