A Magyar Posta által publikált API-okat a Fejlesztői Portál (Developer Portal) API-k menüpontja alatt lehet megtekinteni.
Hibát kaptam az API hívásakor, hol találom hibakódok jelentését?
A Fejlesztői Portál API-k menüpontja alatt az API dokumentációban a válaszok szekcióban található a hibakódok leírása.
Hol érhető el az API-k dokumentációja?
Az API-ok dokumentációja a Fejlesztői Portál (Developer Portal) API-k menüpontja alatt érhető el, innen letölthető az API-k dokumentációja OpenAPI YAML formátumban, vagy az oldalakon közvetlenül böngészhető is a dokumentáció Swagger UI-jal.
Hogyan történik az azonosítás az API-ok hívásakor?
Az API-k eléréséhez a hívó alkalmazásnak azonosítania kell magát. Az azonosítás (authentikáció) minden esetben a hívó alkalmazásban megadott API Key (Client ID) és API Secret (Client Secret) segítségével történik, amelyet a céget képviselő fejlesztő a Fejlesztői Portálon (Developer Portal) az Alkalmazások menüpont alatt tud elérni.
Az API Key és API Secret eléréséhez bejelentkezés szükséges. A bejelentkezéshez használt felhasználói fióknak rendelkeznie kell a képviselt cégre vonatkozó felhatalmazással, valamint a cégnek API használati jogosultsággal.
Miért van két hozzáférésem, két API Key / API Secret párom?
Az API-okat hívó webalkalmazás, mobil alkalmazás fejlesztése és tesztelése során a sandbox environment-hez "homokozó környezethez" tartozó API Key / API Secret párt kell használni, ebben a környezetben az API hívások nem eredményeznek éles tranzakciókat.
A webalkalmazás, mobil alkalmazás éles, produkciós használata során a prod environment-hez "éles környezethez" tartozó API Key / API Secret párt kell használni.
Használhatom az API-okat hozzáférési engedély nélkül?
Nem, a publikált API-k használatához hozzáférésre - API Key és API Secret - van szükség, a hívó alkalmazás ezekkel azonosítja magát az API hívás során.
Hogyan tudom ellenőrizni, hogy milyen API-k használatára van hozzáférésem?
A Fejlesztői Portál Alkalmazások menüpontja alatt megtekinthető, hogy a cég milyen API Termékek (API Product) és azokhoz kapcsolódóan milyen API-k használatára kapott hozzáférést.
Van lehetőség az API-k kipróbálásra?
Igen, a Fejlesztői Portál (Developer Portal) API-k menüpontja alatt a dokumentációt megtekintve, a Swagger UI felületről lehet API teszthívásokat kezdeményezni. Ehhez API hozzáférésre van szükség - API Key, API Secret -, amit a Fejlesztői Portál Alkalmazások menüpontja alatt tud a céget képviselő fejlesztő elérni.