Endpointuri REST API
Caution
Pagină demonstrativă - Aceasta este o pagină demonstrativă care prezintă funcționalitatea de documentație cu mai multe file. Conținutul are doar scop ilustrativ.
REST API-ul nostru pune la dispoziție endpointuri pentru accesarea și modificarea datelor. Toate endpointurile returnează datele în format JSON.
URL de bază
Trimite toate cererile către API la următorul URL de bază:
https://api.example.com/v1Endpointuri pentru utilizatori
Obține toți utilizatorii
GET /usersReturnează lista tuturor utilizatorilor. Acceptă parametri de paginare.
Parametri de interogare:
| Parametru | Tip | Descriere |
|---|---|---|
| page | integer | Numărul paginii (implicit: 1) |
| limit | integer | Numărul de înregistrări pe pagină (implicit: 50, maxim: 100) |
| sort | string | Câmpul după care se face sortarea (de exemplu, “name”, “created_at”) |
Răspuns:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Obține un utilizator după ID
GET /users/{id}Returnează un singur utilizator după ID.
Răspuns:
{ "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" } }}Endpointuri pentru produse
Obține toate produsele
GET /productsReturnează lista tuturor produselor. Acceptă filtrare și paginare.
Parametri de interogare:
| Parametru | Tip | Descriere |
|---|---|---|
| category | string | Filtrare după categorie |
| min_price | number | Filtrare după prețul minim |
| max_price | number | Filtrare după prețul maxim |
| page | integer | Numărul paginii (implicit: 1) |
| limit | integer | Numărul de înregistrări pe pagină (implicit: 50, maxim: 100) |
Răspuns:
{ "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 }}Tratarea erorilor
Toate endpointurile respectă codurile de stare HTTP standard și includ mesaje de eroare detaliate atunci când este cazul:
| Cod de stare | Descriere |
|---|---|
| 200 | OK - cererea a reușit |
| 400 | Bad Request - parametri invalizi |
| 401 | Unauthorized - este necesară autentificarea |
| 403 | Forbidden - permisiuni insuficiente |
| 404 | Not Found - resursa nu există |
| 429 | Too Many Requests - limita de cereri a fost depășită |
| 500 | Internal Server Error - a apărut o eroare pe server |
Răspunsurile de eroare includ un mesaj care explică ce a mers greșit:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}