Endpoint dell’API REST
Caution
Pagina dimostrativa - Questa è una pagina di esempio che mostra la funzionalità di documentazione a più schede. Il contenuto ha solo scopo illustrativo.
La nostra API REST offre endpoint per accedere ai dati e manipolarli. Tutti gli endpoint restituiscono i dati in formato JSON.
URL di base
Tutte le richieste API vanno inviate al seguente URL di base:
https://api.example.com/v1Endpoint Users
Ottenere tutti gli utenti
GET /usersRestituisce l’elenco di tutti gli utenti. Supporta i parametri di paginazione.
Parametri della query:
| Parametro | Tipo | Descrizione |
|---|---|---|
| page | integer | Numero di pagina (predefinito: 1) |
| limit | integer | Numero di record per pagina (predefinito: 50, massimo: 100) |
| sort | string | Campo su cui ordinare (ad esempio “name”, “created_at”) |
Risposta:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Ottenere un utente tramite ID
GET /users/{id}Restituisce un singolo utente in base all’ID.
Risposta:
{ "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" } }}Endpoint Products
Ottenere tutti i prodotti
GET /productsRestituisce l’elenco di tutti i prodotti. Supporta filtri e paginazione.
Parametri della query:
| Parametro | Tipo | Descrizione |
|---|---|---|
| category | string | Filtra per categoria |
| min_price | number | Filtra per prezzo minimo |
| max_price | number | Filtra per prezzo massimo |
| page | integer | Numero di pagina (predefinito: 1) |
| limit | integer | Numero di record per pagina (predefinito: 50, massimo: 100) |
Risposta:
{ "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 }}Gestione degli errori
Tutti gli endpoint seguono i codici di stato HTTP standard e includono messaggi di errore dettagliati quando è opportuno:
| Codice di stato | Descrizione |
|---|---|
| 200 | OK - Richiesta riuscita |
| 400 | Bad Request - Parametri non validi |
| 401 | Unauthorized - Autenticazione richiesta |
| 403 | Forbidden - Permessi insufficienti |
| 404 | Not Found - La risorsa non esiste |
| 429 | Too Many Requests - Limite di frequenza superato |
| 500 | Internal Server Error - Si è verificato un errore del server |
Le risposte di errore includono un messaggio che spiega cosa non ha funzionato:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}