Passer au contenu principal
Les clients sont créés automatiquement lorsqu’ils effectuent un achat dans votre boutique. Chaque client est spécifique à votre boutique et possède son propre profil avec des informations de contact, un historique d’achats et un accès aux produits.

Objet Client

Un objet client contient les informations suivantes :
{
  "id": "cus_abc123xyz",
  "name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
  "phone": {
    "number": "+1 234 567 890",
    "country": {
      "name": "United States",
      "code": "US",
      "alpha_3_code": "USA",
      "dial_code": "+1",
      "currency": "USD",
      "flag": "🇺🇸"
    }
  },
  "store": {
    "id": "str_xyz789",
    "name": "My Digital Store",
    "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
    "url": "https://mystore.chariow.link"
  },
  "created_at": "2025-01-15T10:30:00+00:00",
  "updated_at": "2025-01-20T14:45:00+00:00"
}

Propriétés du Client

PropriétéTypeDescription
idstringIdentifiant unique du client avec le préfixe cus_
namestringNom complet (combinaison du prénom et du nom)
first_namestringPrénom du client
last_namestringNom de famille du client
emailstringAdresse e-mail du client
avatar_urlstringURL de l’image d’avatar du client
phoneobjectNuméro de téléphone avec les informations du pays
storeobjectBoutique à laquelle appartient le client
created_atstringHorodatage ISO 8601 de la date de création du client
updated_atstringHorodatage ISO 8601 de la dernière mise à jour du client

Liste des Clients

Récupérez tous les clients de votre boutique :
curl -X GET "https://api.chariow.com/v1/customers" \
  -H "Authorization: Bearer sk_live_your_api_key"

Paramètres de Requête

ParamètreTypeDescription
per_pageintegerNombre de clients par page (par défaut : 15, max : 100)
cursorstringCurseur pour la pagination (utilisez next_cursor de la réponse précédente)
searchstringRecherche par nom, e-mail ou numéro de téléphone
start_datestringFiltre les clients créés à partir de cette date (format Y-m-d)
end_datestringFiltre les clients créés jusqu’à cette date (format Y-m-d)

Recherche de Clients

Recherchez des clients par nom, e-mail ou numéro de téléphone :
curl -X GET "https://api.chariow.com/v1/customers?search=john" \
  -H "Authorization: Bearer sk_live_your_api_key"

Filtrage par Plage de Dates

Récupérez les clients créés dans une plage de dates spécifique :
curl -X GET "https://api.chariow.com/v1/customers?start_date=2025-01-01&end_date=2025-01-31" \
  -H "Authorization: Bearer sk_live_your_api_key"

Exemple de Réponse

{
  "data": [
    {
      "id": "cus_abc123xyz",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
      "phone": {
        "number": "+1 234 567 890",
        "country": {
          "name": "United States",
          "code": "US",
          "alpha_3_code": "USA",
          "dial_code": "+1",
          "currency": "USD",
          "flag": "🇺🇸"
        }
      },
      "store": {
        "id": "str_xyz789",
        "name": "My Digital Store",
        "logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
        "url": "https://mystore.chariow.link"
      },
      "created_at": "2025-01-15T10:30:00+00:00",
      "updated_at": "2025-01-20T14:45:00+00:00"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6NTB9",
    "prev_cursor": null,
    "has_more": true
  }
}

Récupération d’un Client Unique

Récupérez un client spécifique par son ID public :
curl -X GET "https://api.chariow.com/v1/customers/cus_abc123" \
  -H "Authorization: Bearer sk_live_your_api_key"

Cycle de Vie du Client

1

Client Créé

Un nouveau dossier client est créé lorsqu’il effectue son premier achat.
2

Achat Enregistré

Chaque achat est lié au profil du client.
3

Accès Accordé

Le client reçoit l’accès à ses produits achetés (téléchargements, cours, licences).
4

Accès au Portail

Les clients peuvent accéder au portail client pour consulter leurs achats et téléchargements.

Cas d’Usage Courants

Synchronisez les clients avec votre CRM en récupérant les nouveaux clients à l’aide de filtres de date :
// Récupérer les clients créés au cours des dernières 24 heures
const today = new Date().toISOString().split('T')[0];
const yesterday = new Date(Date.now() - 86400000).toISOString().split('T')[0];

const response = await fetch(
  `https://api.chariow.com/v1/customers?start_date=${yesterday}&end_date=${today}`,
  { headers: { 'Authorization': 'Bearer sk_live_your_api_key' }}
);

const result = await response.json();
// Synchroniser result.data avec votre CRM
Ajoutez des clients à vos listes de diffusion en fonction de leurs achats :
// Obtenir les détails du client pour la liste de diffusion
const response = await fetch(
  'https://api.chariow.com/v1/customers/cus_abc123xyz',
  { headers: { 'Authorization': 'Bearer sk_live_your_api_key' }}
);

const result = await response.json();

await addToMailingList({
  email: result.data.email,
  firstName: result.data.first_name,
  lastName: result.data.last_name,
  tags: ['customer', 'purchased']
});
Recherchez un client par e-mail lorsqu’il contacte le support :
curl -X GET "https://api.chariow.com/v1/[email protected]" \
  -H "Authorization: Bearer sk_live_your_api_key"
Le paramètre de recherche correspond aux champs nom, e-mail et numéro de téléphone.
Générez des rapports mensuels d’acquisition de clients à l’aide de filtres de date :
curl -X GET "https://api.chariow.com/v1/customers?start_date=2025-01-01&end_date=2025-01-31&per_page=100" \
  -H "Authorization: Bearer sk_live_your_api_key"
Cela récupère tous les clients qui ont effectué leur premier achat en janvier 2025.

Ressources Associées