REST API-ändpunkter
Caution
Demosida - Det här är en demosida som visar upp dokumentationsfunktionen med flera flikar. Innehållet är enbart ett exempel.
Vårt REST API har ändpunkter för att hämta och bearbeta data. Alla ändpunkter returnerar data i JSON-format.
Bas-URL
Alla API-anrop ska skickas till följande bas-URL:
https://api.example.com/v1Ändpunkter för användare
Hämta alla användare
GET /usersReturnerar en lista över alla användare. Stöder parametrar för paginering.
Frågeparametrar:
| Parameter | Typ | Beskrivning |
|---|---|---|
| page | integer | Sidnummer (standard: 1) |
| limit | integer | Antal poster per sida (standard: 50, max: 100) |
| sort | string | Fält att sortera på (till exempel “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 }}Hämta användare via ID
GET /users/{id}Returnerar en enskild användare via 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" } }}Ändpunkter för produkter
Hämta alla produkter
GET /productsReturnerar en lista över alla produkter. Stöder filtrering och paginering.
Frågeparametrar:
| Parameter | Typ | Beskrivning |
|---|---|---|
| category | string | Filtrera på kategori |
| min_price | number | Filtrera på lägsta pris |
| max_price | number | Filtrera på högsta pris |
| page | integer | Sidnummer (standard: 1) |
| limit | integer | Antal poster per sida (standard: 50, max: 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 }}Felhantering
Alla ändpunkter följer vanliga HTTP-statuskoder och innehåller detaljerade felmeddelanden där det är relevant:
| Statuskod | Beskrivning |
|---|---|
| 200 | OK - Anropet lyckades |
| 400 | Bad Request - Ogiltiga parametrar |
| 401 | Unauthorized - Autentisering krävs |
| 403 | Forbidden - Otillräckliga behörigheter |
| 404 | Not Found - Resursen finns inte |
| 429 | Too Many Requests - Anropsgränsen är överskriden |
| 500 | Internal Server Error - Ett serverfel inträffade |
Felsvar innehåller ett meddelande som förklarar vad som gick fel:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}