Přeskočit na hlavní obsah

API přehled

MujVykaz poskytuje REST API v1 pro programový přístup ke všem hlavním funkcím aplikace.

Základní informace

ParametrHodnota
Base URLhttps://app.mujvykaz.cz/api/v1
Verzev1
FormátJSON
AutentizaceAPI klíč (X-API-Key header)
Rate limit120 požadavků / min
OpenAPI spechttps://app.mujvykaz.cz/api/v1/openapi

Autentizace

Každý požadavek musí obsahovat API klíč v hlavičce:

curl -H "X-API-Key: vas_api_klic" \
https://app.mujvykaz.cz/api/v1/time-entries

API klíče vytvoříte v Nastavení → API klíče. Více v Autentizace.

Hlavní endpointy

EndpointPopis
GET /time-entriesSeznam záznamů práce
POST /time-entriesNový záznam práce
GET /projectsSeznam projektů
POST /projectsNový projekt
GET /clientsSeznam klientů
POST /clientsNový klient
GET /invoicesSeznam faktur
POST /invoicesNová faktura
GET /users/meProfil aktuálního uživatele
GET /users/statsStatistiky uživatele

Formát odpovědí

Všechny odpovědi jsou ve formátu JSON:

{
"data": [...],
"meta": {
"total": 42,
"page": 1,
"per_page": 25
}
}

Chybové odpovědi

{
"error": {
"code": "validation_error",
"message": "Pole 'hours' je povinné.",
"details": [...]
}
}

HTTP status kódy:

KódVýznam
200OK
201Vytvořeno
400Chyba validace
401Neautorizováno (chybí/neplatný API klíč)
403Nedostatečná oprávnění
404Nenalezeno
429Rate limit překročen

OpenAPI specifikace

Kompletní specifikace API je dostupná ve formátu OpenAPI 3.0:

https://app.mujvykaz.cz/api/v1/openapi

Můžete ji importovat do nástrojů jako Postman, Insomnia nebo Swagger UI.