DOKUPORTÁL - app - dokumentacio-api

Áttekintés

Base URL

https://api.dokuportal.hu/api/v1

Végpont

POST /dokumentum-feltoltes

Válasz

application/json; charset=utf-8

A végpont kizárólag POST metódussal hívható és JSON választ ad.

Hitelesítés (kötelező HTTP fejlécek)

Név	Típus	Leírás
`X-FIOK-KOD`	string	Fiók kódja
`X-FELHASZNALO-EMAIL`	string	API felhasználó e-mail címe
`X-FELHASZNALO-JELSZO`	string	API felhasználó jelszava

A hitelesítést az index.php és a validacio.php ellenőrzi.

Kérés – multipart/form-data

Mező	Típus	Kötelező	Leírás
`cimzett_vallalkozas_neve`	string	igen	Címzett vállalkozás neve
`cimzett_vallalkozas_adoszama`	string	nem	Címzett vállalkozás adószáma
`cimzett_kapcsolattarto_neve`	string	nem	Kapcsolattartó neve
`cimzett_kapcsolattarto_email`	string	igen	Kapcsolattartó e-mail címe
`cimzett_kapcsolattarto_mobil`	string	igen	Kapcsolattartó mobil
`cimzett_ugyfelkod`	string	nem	Belső ügyfélkód
`cimzett_megjegyzes`	string	nem	Megjegyzés
`dokumentumtipus_neve`	string	igen	Dokumentumtípus neve
`fajl[]`	file (tömb)	igen	Egy vagy több fájl feltöltése

A kötelezőség a kódban (validacio.php) lévő ellenőrzések alapján.

Példa – cURL

curl -X POST "https://api.dokuportal.hu/api/v1/dokumentum-feltoltes"   -H "X-FIOK-KOD: 837266"   -H "X-FELHASZNALO-EMAIL: api.user@ceg.hu"   -H "X-FELHASZNALO-JELSZO: ********"   -F "cimzett_vallalkozas_neve=Teszt Kft."   -F "cimzett_kapcsolattarto_email=peldacim@teszt.hu"   -F "cimzett_kapcsolattarto_mobil=+36 30 123 4567"   -F "dokumentumtipus_neve=Díjbekérő"   -F "fajl[]=@/útvonal/dokumentum1.pdf"   -F "fajl[]=@/útvonal/dokumentum2.pdf"

Válaszok

Példák a tényleges JSON sémákra.

Sikeres (200)

{
  "status": "ok",
  "uzenet": "A dokumentum sikeresen feltöltve.",
  "iktatoszam": "D000123",
  "fajlok_szama": 2
}

Hiba (példa)

{
  "status": "hiba",
  "uzenet": "Hiányzó mező: cimzett_kapcsolattarto_email"
}

Működési megjegyzések

Csak POST metódus támogatott.
Kimenet: application/json; charset=utf-8.
A fájlmezőt tömbként várja a rendszer: fajl[].

API dokumentáció