API přehled
MujVykaz poskytuje REST API v1 pro programový přístup ke všem hlavním funkcím aplikace.
Základní informace
| Parametr | Hodnota |
|---|---|
| Base URL | https://app.mujvykaz.cz/api/v1 |
| Verze | v1 |
| Formát | JSON |
| Autentizace | API klíč (X-API-Key header) |
| Rate limit | 120 požadavků / min |
| OpenAPI spec | https://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
| Endpoint | Popis |
|---|---|
GET /time-entries | Seznam záznamů práce |
POST /time-entries | Nový záznam práce |
GET /projects | Seznam projektů |
POST /projects | Nový projekt |
GET /clients | Seznam klientů |
POST /clients | Nový klient |
GET /invoices | Seznam faktur |
POST /invoices | Nová faktura |
GET /users/me | Profil aktuálního uživatele |
GET /users/stats | Statistiky 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ód | Význam |
|---|---|
| 200 | OK |
| 201 | Vytvořeno |
| 400 | Chyba validace |
| 401 | Neautorizováno (chybí/neplatný API klíč) |
| 403 | Nedostatečná oprávnění |
| 404 | Nenalezeno |
| 429 | Rate 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.