REST API-endepunkter
Caution
Demoside - Dette er en demoside, der viser funktionen med dokumentation i flere faneblade. Indholdet er udelukkende til illustration.
Vores REST API stiller endepunkter til rådighed, så du kan hente og ændre data. Alle endepunkter returnerer data i JSON-format.
Base-URL
Alle API-forespørgsler skal sendes til følgende base-URL:
https://api.example.com/v1Endepunkter til brugere
Hent alle brugere
GET /usersReturnerer en liste over alle brugere. Understøtter parametre til paginering.
Forespørgselsparametre:
| Parameter | Type | Beskrivelse |
|---|---|---|
| page | integer | Sidenummer (standard: 1) |
| limit | integer | Antal poster pr. side (standard: 50, maks.: 100) |
| sort | string | Felt der sorteres efter (f.eks. “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 bruger via ID
GET /users/{id}Returnerer en enkelt bruger ud fra 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 til produkter
Hent alle produkter
GET /productsReturnerer en liste over alle produkter. Understøtter filtrering og paginering.
Forespørgselsparametre:
| Parameter | Type | Beskrivelse |
|---|---|---|
| category | string | Filtrer efter kategori |
| min_price | number | Filtrer efter minimumspris |
| max_price | number | Filtrer efter maksimumpris |
| page | integer | Sidenummer (standard: 1) |
| limit | integer | Antal poster pr. 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 }}Fejlhåndtering
Alle endepunkter følger standard-HTTP-statuskoder og indeholder detaljerede fejlbeskeder, hvor det er relevant:
| Statuskode | Beskrivelse |
|---|---|
| 200 | OK - Forespørgslen lykkedes |
| 400 | Bad Request - Ugyldige parametre |
| 401 | Unauthorized - Godkendelse påkrævet |
| 403 | Forbidden - Utilstrækkelige rettigheder |
| 404 | Not Found - Ressourcen findes ikke |
| 429 | Too Many Requests - Rategrænsen er overskredet |
| 500 | Internal Server Error - Der opstod en serverfejl |
Fejlsvar indeholder en besked, der forklarer, hvad der gik galt:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}