HRSzoftver API v2

Aktuális verzió: 2.0.0

Fontos: A HRSzoftver nem kompatibilis a régi API-val!

API URL

Az API használatával lehetőséged van a HRSzoftver és a weboldalad vagy más alkalmazás összekötésére.

Az API az licenszed alapján a következő címen érhető el: https://cegnev.hrszoftver.hu/api

JSON leírás

A POST és a PUT parancsoknál JSON Schema szerint várjuk az adatokat. Ezeket a leírásokat mindig a megfelelő helyen linkeljük is.

Sikeres válaszok

Minden sikeres kérés eredménye egy JSON objektum. Minden válaszban található egy success mező, mely true vagy false értéket vehet fel.

• GET POST PUT kérések:
  • type: A válasz tipusa, pl /person hívás esetén person
  • data: A választ tartalmazó tömb
• DELETE csak success mezőt tartalmaz

Hibák

A szabványos HTTP kódokon felül egy JSON objektumot is visszaküldünk, mely információt tartalmaz a hibáról.

• success: mindig false hiba esetén
• errorMessage: a konkrét szöveges hibaüzenet

Ha nem sikerült beszúrni vagy felülírni valamilyen adatot, akkor az errors mező taralmazhat még egyéb információt is.