Končne točke REST API
Caution
Predstavitvena stran, to je predstavitvena stran, ki prikazuje funkcijo dokumentacije z več zavihki. Vsebina je zgolj ponazoritvena.
Naš REST API ponuja končne točke za dostop do podatkov in njihovo spreminjanje. Vse končne točke vračajo podatke v obliki JSON.
Osnovni URL
Vse zahteve API pošljite na naslednji osnovni URL:
https://api.example.com/v1Končne točke za uporabnike
Pridobitev vseh uporabnikov
GET /usersVrne seznam vseh uporabnikov. Podpira parametre za razdelitev na strani.
Parametri poizvedbe:
| Parameter | Tip | Opis |
|---|---|---|
| page | integer | Številka strani (privzeto: 1) |
| limit | integer | Število zapisov na stran (privzeto: 50, največ: 100) |
| sort | string | Polje za razvrščanje (na primer “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 }}Pridobitev uporabnika po ID-ju
GET /users/{id}Vrne enega uporabnika glede na ID.
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" } }}Končne točke za izdelke
Pridobitev vseh izdelkov
GET /productsVrne seznam vseh izdelkov. Podpira filtriranje in razdelitev na strani.
Parametri poizvedbe:
| Parameter | Tip | Opis |
|---|---|---|
| category | string | Filtriranje po kategoriji |
| min_price | number | Filtriranje po najnižji ceni |
| max_price | number | Filtriranje po najvišji ceni |
| page | integer | Številka strani (privzeto: 1) |
| limit | integer | Število zapisov na stran (privzeto: 50, največ: 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 }}Obravnava napak
Vse končne točke upoštevajo standardne statusne kode HTTP in po potrebi vključijo podrobno sporočilo o napaki:
| Statusna koda | Opis |
|---|---|
| 200 | OK, zahteva je uspela |
| 400 | Bad Request, neveljavni parametri |
| 401 | Unauthorized, potrebno je preverjanje pristnosti |
| 403 | Forbidden, nezadostna dovoljenja |
| 404 | Not Found, vir ne obstaja |
| 429 | Too Many Requests, presežena je omejitev števila zahtev |
| 500 | Internal Server Error, prišlo je do napake na strežniku |
Odgovori z napako vsebujejo sporočilo, ki pojasni, kaj je šlo narobe:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}