REST API-endepunkter
Caution
Demoside - Dette er en demoside som viser frem dokumentasjonsfunksjonen med flere faner. Innholdet er kun ment som illustrasjon.
REST API-et vårt tilbyr endepunkter for å hente og endre data. Alle endepunkter returnerer data i JSON-format.
Basis-URL
Alle API-forespørsler skal sendes til denne basis-URL-en:
https://api.example.com/v1Endepunkter for brukere
Hent alle brukere
GET /usersReturnerer en liste over alle brukere. Støtter parametere for paginering.
Spørringsparametere:
| Parameter | Type | Beskrivelse |
|---|---|---|
| page | integer | Sidenummer (standard: 1) |
| limit | integer | Antall poster per side (standard: 50, maks: 100) |
| sort | string | Feltet det skal sorteres etter (for eksempel “name”, “created_at”) |
Svar:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Hent bruker etter ID
GET /users/{id}Returnerer én enkelt bruker basert på ID.
Svar:
{ "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" } }}Endepunkter for produkter
Hent alle produkter
GET /productsReturnerer en liste over alle produkter. Støtter filtrering og paginering.
Spørringsparametere:
| Parameter | Type | Beskrivelse |
|---|---|---|
| category | string | Filtrer på kategori |
| min_price | number | Filtrer på laveste pris |
| max_price | number | Filtrer på høyeste pris |
| page | integer | Sidenummer (standard: 1) |
| limit | integer | Antall poster per side (standard: 50, maks: 100) |
Svar:
{ "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 }}Feilhåndtering
Alle endepunkter følger vanlige HTTP-statuskoder og inkluderer detaljerte feilmeldinger der det er relevant:
| Statuskode | Beskrivelse |
|---|---|
| 200 | OK, forespørselen lyktes |
| 400 | Bad Request, ugyldige parametere |
| 401 | Unauthorized, autentisering kreves |
| 403 | Forbidden, utilstrekkelige tillatelser |
| 404 | Not Found, ressursen finnes ikke |
| 429 | Too Many Requests, hastighetsgrensen er overskredet |
| 500 | Internal Server Error, det oppsto en serverfeil |
Feilsvar inneholder en melding som forklarer hva som gikk galt:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}