Hlavičky HTTP requestů

Pro autentizaci a identifikaci klientské aplikace či requestu jsou využívány následující HTTP hlavičky, které se posílají při každém requestu na API:

Název hlavičky
Význam
X-Api-Key

API klíč pro autentizaci. pouze systémové funkce
X-Api-AppId

Identifikátor klientské aplikace:

  • WebApp
  • MobileApp
  • ....
pouze systémové funkce
X-Api-RequestId

Jedinečný identifikátor requestu (slouží pro jednodušší procházení logů mezi API a klientskou aplikací)
Authorization: Bearer [JWT token]

JWT token pro identifikaci uživatele klientské aplikace. Použito pouze pro funkce u koncových přihlášených uživatelů

Návratové a chybové kódy

Níže uvedené návratové HTTP kódy jsou obecné, může být navrácenz každé funkce.

Status   Název Poznámka Response (test)
2XX OK Jakýkoliv kód 2XX bereme jako OK, tzn. během requestu nedošlo k chybě / validační chybě Záleží na metodě
400 BadRequest Validační chyba

{
"Message": "Validation failed",
"Status": 400,
"ValidationErrors": [{"Property": "model.Email", "Errors": ["blah flah"]}, ... ]
}
401 Unauthorized Špatný nebo neexistující api klíč / token -
404 NotFound Daná REST metoda / controller nebyla nalezena. Vráceno i v případě, že nebyl nalezen daný objekt (například klient v CIS3)

{
"Message": "No HTTP resource was found that matches the request URI 'xxx'."
}
405 MethodNotAllowed Není podporovaná daná HTTP metoa (GET, POST, PUT, ...)

{
"Message": "The requested resource does not support http method 'PUT'."
}
500 InternalServerError Neočekávaná chyba ve WS
{
"Message": "Ve webové službě aplikace...",
"Status": 500,
"ExceptionType": "System.ApplicationException",
ExceptionMessage": "Something went very wrong!",
"ExceptionStackTrace": " at ...."
}