Aller au contenu principal

API Clients

Gestion des clients via l'API.

Endpoints

Liste des clients

Récupère la liste de tous les clients.

GET /api/clients

Paramètres de requête :

ParamètreTypeDescription
pagenumberNuméro de page (défaut: 1)
limitnumberNombre de résultats (défaut: 20)
typestringFiltrer par type: individual ou company

Exemple de requête :

curl -X GET "https://api.appswite.dev/api/clients?page=1&limit=20" \
-H "Authorization: Bearer YOUR_TOKEN"

Réponse (200 OK) :

{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Jean Dupont",
"type": "individual",
"email": "jean@example.com",
"phone": "+33612345678",
"created_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 150
}
}

Créer un client

POST /api/clients

Body :

{
"name": "Marie Curie",
"type": "company",
"email": "marie@example.com",
"phone": "+33698765432",
"address": "12 Rue de Paris, 75001 Paris",
"country": "France"
}

Réponse (201 Created) :

{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Marie Curie",
"type": "company",
"email": "marie@example.com"
}
}

Codes d'erreur

CodeMessageDescription
400Bad RequestDonnées invalides
401UnauthorizedToken manquant ou invalide
404Not FoundClient introuvable
409ConflictEmail déjà utilisé