Endpointy REST API
Caution
Demo stránka - Toto je ukázková stránka, která předvádí funkci dokumentace s více záložkami. Její obsah slouží pouze pro ilustraci.
Naše REST API poskytuje endpointy pro přístup k datům a jejich úpravu. Všechny endpointy vracejí data ve formátu JSON.
Základní URL
Všechny požadavky na API směřujte na následující základní URL:
https://api.example.com/v1Endpointy pro uživatele
Získání všech uživatelů
GET /usersVrací seznam všech uživatelů. Podporuje parametry stránkování.
Parametry dotazu:
| Parametr | Typ | Popis |
|---|---|---|
| page | integer | Číslo stránky (výchozí: 1) |
| limit | integer | Počet záznamů na stránku (výchozí: 50, max: 100) |
| sort | string | Pole, podle kterého se řadí (např. „name”, „created_at”) |
Odpověď:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Získání uživatele podle ID
GET /users/{id}Vrací jednoho uživatele podle ID.
Odpověď:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Endpointy pro produkty
Získání všech produktů
GET /productsVrací seznam všech produktů. Podporuje filtrování a stránkování.
Parametry dotazu:
| Parametr | Typ | Popis |
|---|---|---|
| category | string | Filtrování podle kategorie |
| min_price | number | Filtrování podle minimální ceny |
| max_price | number | Filtrování podle maximální ceny |
| page | integer | Číslo stránky (výchozí: 1) |
| limit | integer | Počet záznamů na stránku (výchozí: 50, max: 100) |
Odpověď:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Zpracování chyb
Všechny endpointy dodržují standardní stavové kódy HTTP a v případě potřeby obsahují podrobné chybové zprávy:
| Stavový kód | Popis |
|---|---|
| 200 | OK - Požadavek proběhl úspěšně |
| 400 | Bad Request - Neplatné parametry |
| 401 | Unauthorized - Je vyžadováno ověření |
| 403 | Forbidden - Nedostatečná oprávnění |
| 404 | Not Found - Zdroj neexistuje |
| 429 | Too Many Requests - Překročen limit požadavků |
| 500 | Internal Server Error - Došlo k chybě serveru |
Chybové odpovědi obsahují zprávu vysvětlující, co se pokazilo:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}