Punkty końcowe REST API
Caution
Strona demonstracyjna, to strona pokazowa prezentująca funkcję dokumentacji z wieloma zakładkami. Ta treść ma charakter wyłącznie poglądowy.
Nasze REST API udostępnia punkty końcowe do odczytu i modyfikacji danych. Wszystkie punkty końcowe zwracają dane w formacie JSON.
Bazowy URL
Wszystkie żądania do API kieruj na następujący bazowy URL:
https://api.example.com/v1Punkty końcowe użytkowników
Pobierz wszystkich użytkowników
GET /usersZwraca listę wszystkich użytkowników. Obsługuje parametry paginacji.
Parametry zapytania:
| Parametr | Typ | Opis |
|---|---|---|
| page | integer | Numer strony (domyślnie: 1) |
| limit | integer | Liczba rekordów na stronę (domyślnie: 50, maksymalnie: 100) |
| sort | string | Pole, według którego sortować (np. “name”, “created_at”) |
Odpowiedź:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Pobierz użytkownika po identyfikatorze
GET /users/{id}Zwraca pojedynczego użytkownika na podstawie identyfikatora.
Odpowiedź:
{ "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" } }}Punkty końcowe produktów
Pobierz wszystkie produkty
GET /productsZwraca listę wszystkich produktów. Obsługuje filtrowanie i paginację.
Parametry zapytania:
| Parametr | Typ | Opis |
|---|---|---|
| category | string | Filtruj według kategorii |
| min_price | number | Filtruj według ceny minimalnej |
| max_price | number | Filtruj według ceny maksymalnej |
| page | integer | Numer strony (domyślnie: 1) |
| limit | integer | Liczba rekordów na stronę (domyślnie: 50, maksymalnie: 100) |
Odpowiedź:
{ "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 }}Obsługa błędów
Wszystkie punkty końcowe stosują standardowe kody statusu HTTP i tam, gdzie to zasadne, zawierają szczegółowe komunikaty o błędach:
| Kod statusu | Opis |
|---|---|
| 200 | OK, żądanie zakończone powodzeniem |
| 400 | Bad Request, nieprawidłowe parametry |
| 401 | Unauthorized, wymagane uwierzytelnienie |
| 403 | Forbidden, niewystarczające uprawnienia |
| 404 | Not Found, zasób nie istnieje |
| 429 | Too Many Requests, przekroczony limit zapytań |
| 500 | Internal Server Error, błąd po stronie serwera |
Odpowiedzi z błędem zawierają komunikat wyjaśniający, co poszło nie tak:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}