REST/JSON API Info

REST/JSON

A REST API szolgáltatások mindig hívhatóak JSON API-n és fordítva.

Autentikáció

A REST/JSON API használatakor a következő paraméterekre van szükség:

clientHashKey

Megadható:

• query paraméterként
• X-Client-Hash-Key header értékeként
• Authorization headerben megadott JWT tokennel. Ekkor a tokenhez tartozó felhasználóhoz rendelt clientHashKey lesz.

userName

Megadható:

• query paraméterként
• X-User-Name header értékeként
• Authorization header-ben megadott JWT tokennel. Ekkor a tokenhez tartozó felhasználó lesz.

JWT authorizáció

Amennyiben a JWT authorizáció be van kapcsolva (JWT_USAGE cg paraméter értéke REQUIRED), az Authorization header megadása kötelező!

Query paraméter/Body

A Paraméter nevű oszlopban lévő mezőket query paraméterként kell megadni, minden mást a body-ban.

REST/JSON API végpontok

Ha egy újabb verzióban egy funkció az előzőhöz képest nem változik, akkor a funkció az új verzió végpontjáról is hívható.

Formátum: hammy/json/{{api_név}}/v{{verzió_szám}}/{{funkció}}