Clients (CustomerApi)

Le module CustomerApi permet de gérer les clients de votre application : authentification, listing, mise à jour et blocage.

Accès : client.customer

Méthodes

`auth`

Authentifie ou crée un client.

Exemple


const response = await client.customer.auth({
  appId: "app_id",
  apiKey: "user_api_key",
  fullname: "Jean Dupont",
  telephone: "+2250700000000",
  plateform: "STORE"
});
 
if (response.success) {
  console.log("Client:", response.data);
}

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API de l’utilisateur
`fullname`	string	Oui	Nom complet
`telephone`	string	Oui	Numéro de téléphone
`email`	string	Non	Adresse email
`plateform`	string	Non	Type de plateforme

Réponse


{
  "success": true,
  "data": {
    "id": "customer_id",
    "fullname": "Jean Dupont",
    "telephone": "+2250700000000",
    "email": null,
    "photoUrl": null,
    "isBlocked": false,
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
}

`check`

Vérifie si un client existe.

Exemple


const response = await client.customer.check({
  appId: "app_id",
  apiKey: "user_api_key",
  telephone: "+2250700000000",
  plateform: "STORE"
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API
`telephone`	string	Non	Numéro de téléphone
`email`	string	Non	Adresse email
`plateform`	string	Non	Type de plateforme

Réponse


{
  "success": true,
  "data": {
    "id": "customer_id",
    "fullname": "Jean Dupont"
  }
}

`list`

Liste les clients avec filtres.

Exemple


const response = await client.customer.list({
  appId: "app_id",
  apiKey: "user_api_key",
  plateformType: ["STORE"]
});
 
response.data.forEach(c => {
  console.log(c.fullname, c.telephone);
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API
`plateformType`	string[]	Non	Filtrer par plateformes

Réponse


{
  "success": true,
  "data": [
    {
      "id": "c1",
      "fullname": "Jean Dupont",
      "telephone": "+2250700000000",
      "isBlocked": false,
      "viewed": true,
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

`listFew`

Liste minimale des clients (id, nom, photo).

Exemple


const response = await client.customer.listFew({
  appId: "app_id",
  apiKey: "user_api_key"
});

`get`

Récupère les détails d’un client avec ses commandes, rendez-vous, avis et statistiques.

Exemple


const response = await client.customer.get({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "customer_id"
});

Paramètres

Champ	Type	Requis	Description
`appId`	string	Oui	ID de l’application
`apiKey`	string	Oui	Clé API
`id`	string	Oui	ID du client

Réponse


{
  "success": true,
  "data": {
    "id": "customer_id",
    "fullname": "Jean Dupont",
    "addresses": [...],
    "transactions": [...],
    "storeOrders": [...],
    "multiServiceAppointments": [...],
    "reviews": [...],
    "testimonies": [...],
    "stats": {
      "totalOrders": 5,
      "totalTransactionsAmount": 25000,
      "totalAppointments": 2,
      "totalReviews": 3
    }
  }
}

`update`

Met à jour les informations d’un client.

Exemple


const response = await client.customer.update({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "customer_id",
  fullname: "Jean Dupont Jr",
  email: "jean@example.com"
});

`block`

Bloque ou débloque un client.

Exemple


const response = await client.customer.block({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "customer_id",
  isBlocked: true
});

`delete`

Supprime un client (admin).

Exemple


const response = await client.customer.delete({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "customer_id"
});

`deleteAccount`

Permet à un client de supprimer son propre compte.

Exemple


const response = await client.customer.deleteAccount({
  appId: "app_id",
  apiKey: "user_api_key",
  customerId: "customer_id",
  telephone: "+2250700000000"
});

`markViewed`

Marque un client comme vu (supprime le badge “Nouveau”).

Exemple


const response = await client.customer.markViewed({
  appId: "app_id",
  apiKey: "user_api_key",
  id: "customer_id"
});