Krajnje točke REST API-ja
Caution
Demo stranica - Ovo je demo stranica koja prikazuje značajku dokumentacije s više kartica. Sadržaj služi isključivo kao ilustracija.
Naš REST API nudi krajnje točke za pristup podacima i njihovu obradu. Sve krajnje točke vraćaju podatke u formatu JSON.
Osnovni URL
Sve API zahtjeve šaljite na sljedeći osnovni URL:
https://api.example.com/v1Krajnje točke za korisnike
Dohvat svih korisnika
GET /usersVraća popis svih korisnika. Podržava parametre za straničenje.
Parametri upita:
| Parametar | Tip | Opis |
|---|---|---|
| page | integer | Broj stranice (zadano: 1) |
| limit | integer | Broj zapisa po stranici (zadano: 50, najviše: 100) |
| sort | string | Polje po kojem se sortira (npr. „name”, „created_at”) |
Odgovor:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Dohvat korisnika prema ID-u
GET /users/{id}Vraća jednog korisnika prema ID-u.
Odgovor:
{ "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" } }}Krajnje točke za proizvode
Dohvat svih proizvoda
GET /productsVraća popis svih proizvoda. Podržava filtriranje i straničenje.
Parametri upita:
| Parametar | Tip | Opis |
|---|---|---|
| category | string | Filtriranje prema kategoriji |
| min_price | number | Filtriranje prema najnižoj cijeni |
| max_price | number | Filtriranje prema najvišoj cijeni |
| page | integer | Broj stranice (zadano: 1) |
| limit | integer | Broj zapisa po stranici (zadano: 50, najviše: 100) |
Odgovor:
{ "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 }}Rukovanje pogreškama
Sve krajnje točke koriste standardne HTTP statusne kodove i, kada je to primjereno, uključuju detaljne poruke o pogrešci:
| Statusni kod | Opis |
|---|---|
| 200 | OK - zahtjev je uspio |
| 400 | Bad Request - neispravni parametri |
| 401 | Unauthorized - potrebna je autentifikacija |
| 403 | Forbidden - nedostatna dopuštenja |
| 404 | Not Found - resurs ne postoji |
| 429 | Too Many Requests - premašeno ograničenje broja zahtjeva |
| 500 | Internal Server Error - došlo je do pogreške na poslužitelju |
Odgovori s pogreškom sadrže poruku koja objašnjava što je pošlo po zlu:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}