Galerie
Endpointy pro práci s galerií.
Dostupnost
Galerie je dostupná pouze pro tarify Business a Enterprise.
Klientská galerie
Tato sekce popisuje práci s obecnou galerií klienta.
Výpis souborů v galerii klienta
GET /api/v1/Gallery/Client/{idClient}/Files
Vrátí stránkovaný seznam souborů v galerii klienta.
Query parametry
| Parametr | Typ | Povinný | Výchozí | Popis |
|---|---|---|---|---|
Page | int | ne | 1 | Číslo stránky |
PageSize | int | ne | 25 | Počet položek na stránku, max. 25 |
TagIds | uuid[] | ne | - | Filtr podle štítků |
RequireAllTagIds | bool | ne | false | false = stačí shoda s libovolným štítkem, true = soubor musí obsahovat všechny zadané štítky |
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
Odpověď
| Pole | Typ | Popis |
|---|---|---|
Page | int | Aktuální stránka |
PageSize | int | Velikost stránky |
Total | int | Celkový počet souborů vyhovujících filtrům |
Results | GalleryFileItem[] | Soubory v galerii klienta |
GalleryFileItem
| Pole | Typ | Popis |
|---|---|---|
IdFile | uuid | Identifikátor souboru |
Name | string | Název souboru |
Description | string | Popis souboru |
MimeType | string | MIME typ |
Extension | string | Přípona souboru |
Size | long | Velikost v bajtech |
DateCreated | datetime | Datum vytvoření |
Tags | GalleryTagItem[] | Štítky souboru |
GalleryTagItem
| Pole | Typ | Popis |
|---|---|---|
IdTag | uuid | Identifikátor štítku |
Tag | string | Název štítku |
Poznámky
- Biometricky podepsané soubory nejsou v seznamu vraceny.
Stažení souboru z galerie klienta
GET /api/v1/Gallery/Client/{idClient}/Files/{idFile}
Vrátí obsah souboru.
Query parametry
| Parametr | Typ | Povinný | Výchozí | Popis |
|---|---|---|---|---|
ImageAsType | enum | ne | Raw | Formát výstupu: Raw, ByteStream, Base64 |
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
idFile | uuid | ano | Identifikátor souboru |
Odpověď
| Režim | Typ odpovědi | Popis |
|---|---|---|
Raw | binární stream | Soubor v původním MIME typu |
ByteStream | binární stream | Soubor jako application/octet-stream |
Base64 | string | Base64 reprezentace obsahu souboru |
Poznámky
- Název souboru je uložen v hlavičce odpovědi
Content-Disposition(filename).
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
404 | CLIENT_NOT_FOUND | Klient neexistuje |
404 | FILE_NOT_FOUND | Soubor neexistuje |
Náhled souboru z galerie klienta
GET /api/v1/Gallery/Client/{idClient}/Files/{idFile}/Thumbnail
Vrátí náhled souboru.
Query parametry
| Parametr | Typ | Povinný | Výchozí | Popis |
|---|---|---|---|---|
SizeX | int | ne | 100 | Šířka náhledu v px (50 až 1000) |
SizeY | int | ne | 100 | Výška náhledu v px (50 až 1000) |
ThumbnailAsType | enum | ne | Raw | Formát výstupu: Raw, ByteStream, Base64 |
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
idFile | uuid | ano | Identifikátor souboru |
Odpověď
| Režim | Typ odpovědi | Popis |
|---|---|---|
Raw | binární stream | Soubor v původním MIME typu |
ByteStream | binární stream | Soubor jako application/octet-stream |
Base64 | string | Base64 reprezentace obsahu souboru |
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
400 | VALIDATION_FAILED | Neplatné rozměry náhledu |
404 | CLIENT_NOT_FOUND | Klient neexistuje |
404 | FILE_NOT_FOUND | Soubor neexistuje |
Nahrání souboru do galerie klienta
POST /api/v1/Gallery/Client/{idClient}/Files
Nahraje soubor do galerie klienta.
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
Tělo požadavku (multipart/form-data)
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
File | file | ano | Nahrávaný soubor |
FileName | string | ne | Přepis názvu souboru včetně přípony |
Odpověď
| Pole | Typ | Popis |
|---|---|---|
IdFile | uuid | Identifikátor souboru |
IdClient | uuid | Identifikátor klienta |
Name | string | Název souboru |
MimeType | string | MIME typ |
Extension | string | Přípona souboru |
Size | long | Velikost v bajtech |
DateCreated | datetime | Datum vytvoření |
Poznámky
- Maximální velikost souboru je
25 MB. - Pokud není uvedeno
FileName, použije se název nahrávaného souboru.
Limity
Galerie klienta má celkový limit podle tarifu.
- Business:
100 MB - Enterprise:
200 MB(nebo individuálně nastavený limit)
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
400 | MISSING_FILE | Chybí soubor |
400 | VALIDATION_FAILED | Neplatný název nebo přípona |
404 | CLIENT_NOT_FOUND | Klient neexistuje |
409 | GALLERY_LIMIT_EXCEEDED | Překročen limit galerie klienta |
Přidání štítků k souboru v galerii klienta
POST /api/v1/Gallery/Client/{idClient}/Files/{idFile}/Tags
Přidá štítky k souboru. Existující štítky zůstávají zachovány.
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
idFile | uuid | ano | Identifikátor souboru |
Tělo požadavku (application/json)
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
Tags | GalleryTagInput[] | ano | Seznam štítků k přidání |
Každá položka v Tags musí obsahovat alespoň IdTag nebo Tag.
GalleryTagInput
| Pole | Typ | Povinný | Popis |
|---|---|---|---|
IdTag | uuid | podmíněně | ID existujícího štítku |
Tag | string | podmíněně | Název štítku, pokud není uvedeno IdTag |
Odpověď
Odpověď je pole GalleryTagItem[].
GalleryTagItem
| Pole | Typ | Popis |
|---|---|---|
IdTag | uuid | Identifikátor štítku |
Tag | string | Název štítku |
Poznámky
- Název štítku je case-insensitive.
- Pokud štítek podle názvu neexistuje, API vytvoří nový štítek a přiřadí ho k souboru.
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
400 | VALIDATION_FAILED | Neplatná struktura požadavku nebo duplicitní štítek |
404 | CLIENT_NOT_FOUND | Klient neexistuje |
404 | FILE_NOT_FOUND | Soubor neexistuje |
Štítky souborů
Přehled štítků souborů
GET /api/v1/Gallery/Tags
Vrátí všechny dostupné štítky pro soubory galerie.
Parametry
Endpoint nemá žádné parametry.
Odpověď
Odpověď je pole GalleryTagItem[].
GalleryTagItem
| Pole | Typ | Popis |
|---|---|---|
IdTag | uuid | Identifikátor štítku |
Tag | string | Název štítku |