Points de terminaison de l’API REST

Notre API REST fournit des points de terminaison pour accéder aux données et les manipuler. Tous les points de terminaison renvoient les données au format JSON.

URL de base

Toutes les requêtes API doivent être envoyées à l’URL de base suivante :

https://api.example.com/v1

Points de terminaison des utilisateurs

Récupérer tous les utilisateurs

GET /users

Renvoie la liste de tous les utilisateurs. Prend en charge les paramètres de pagination.

Paramètres de requête :

Réponse :

{
  "data": [
    {
      "id": "user_123",
      "name": "John Doe",
      "email": "[email protected]",
      "created_at": "2023-01-15T08:30:00Z"
    },
    // More users...
  ],
  "meta": {
    "total": 250,
    "page": 1,
    "limit": 50
  }
}

Récupérer un utilisateur par ID

GET /users/{id}

Renvoie un utilisateur unique à partir de son ID.

Réponse :

{
  "data": {
    "id": "user_123",
    "name": "John Doe",
    "email": "[email protected]",
    "created_at": "2023-01-15T08:30:00Z",
    "profile": {
      "bio": "Software developer",
      "location": "New York",
      "avatar_url": "https://example.com/avatars/john.jpg"
    }
  }
}

Points de terminaison des produits

Récupérer tous les produits

GET /products

Renvoie la liste de tous les produits. Prend en charge le filtrage et la pagination.

Paramètres de requête :

Réponse :

{
  "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
  }
}

Gestion des erreurs

Tous les points de terminaison respectent les codes de statut HTTP standard et incluent des messages d’erreur détaillés lorsque cela est pertinent :

Les réponses d’erreur incluent un message expliquant la nature du problème :

{
  "error": {
    "code": "invalid_parameter",
    "message": "The parameter 'email' is not a valid email address",
    "request_id": "req_abc123"
  }
}