Identifier un client à partir d'informations personnelles

  • Customers
  • Compte client
  • 2 routes
Comment identifier un client à partir de filtres personnels puis ouvrir son profil détaillé ?

Ce scénario décrit comment retrouver un client à partir d'informations personnelles puis récupérer son profil détaillé. Il est utile pour un service client, un outil conseiller ou un parcours authentifié qui doit identifier un compte avant de lire les données de profil.

Le parcours commence par une recherche dans la liste des clients à l'aide de filtres personnels comme le nom, l'email, le téléphone ou la date de naissance, puis réutilise le customer_id retourné pour ouvrir le profil détaillé.

Vue d'ensemble

Ce scénario aide une application à retrouver un compte client existant avant de récupérer le profil détaillé lié au customer_id sélectionné.

Prérequis

  • Un bearer token valide et un x-api-key.
  • Au moins un filtre personnel pertinent pour réduire le périmètre de recherche.
  • L'étape de détail nécessite aussi un header accept-language et le customer_id retourné par la recherche.

Résultat attendu

L'application peut identifier un client correspondant, récupérer le customer_id retourné et afficher le profil détaillé avec les informations de contact, de fidélité et de locale.

Process workflow

Legend:
Obligatoire
Optionnel
1

Rechercher un client avec des filtres personnels

Obligatoire

Utilisez cette route pour rechercher dans la base client à partir d'informations personnelles avant de sélectionner un compte à inspecter en détail.

Prerequis

  • Envoyez authorization et x-api-key.
  • Préparez au moins un filtre personnel pertinent comme last_name, email, phones.number ou birthdate.
  • Ajoutez si besoin limit, page ou offer_code pour affiner le jeu de résultats.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v1/customers?filter=last_name==Smith&limit=10&page=1' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  {
    "id": "123456789",
    "gm_number": "123456789",
    "first_name": "John",
    "last_name": "Smith",
    "birthdate": "19800117",
    "email": "john@h.fr",
    "phones": [
      {
        "number": "0623456789",
        "type": "MOBILE"
      }
    ],
    "loyalty_program": {
      "status": "EXCLUDED",
      "points": 1200
    }
  }
]

info: Combinez si possible deux filtres personnels pour réduire les ambiguïtés avant d'ouvrir le profil détaillé.

Codes de reponse

  • OK Response (200): retourne la liste des clients qui correspondent aux filtres personnels fournis.
  • Error (400): la syntaxe du filtre ou une autre valeur d'entrée est invalide.
  • Error (401): l'authentification est absente, invalide ou expirée.
  • Error (404): non documente dans le Swagger.
GET/v1/customers
Voir plus
2

Consulter le profil détaillé du client

Obligatoire

Utilisez GET/v2/customers/{customer_id}/profile pour récupérer le profil détaillé du client sélectionné à l'étape de recherche.

Prerequis

  • Réutilisez le customer_id retourné par l'étape de recherche.
  • Envoyez accept-language, authorization et x-api-key.
  • Appelez cette étape après avoir confirmé que le client sélectionné est bien le bon.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v2/customers/123456789/profile' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "email": "tom@example.com",
  "gm_number": "123456789",
  "first_name": "Tom",
  "second_name": "James",
  "third_name": "Edward",
  "last_name": "Smith",
  "birth_city": "Paris",
  "phones": [
    {
      "number": "0623456789",
      "type": "MOBILE"
    }
  ],
  "loyalty_program": {
    "status": "GOLD",
    "previous_status": "SILVER",
    "is_platinum_for_life": false,
    "points": 1200
  },
  "address": {
    "city": "Aix-en-Provence",
    "zip_code": "75000",
    "country_code": "FR"
  },
  "locale": "fr-FR"
}

info: v2 reste la meilleure source pour confirmer l'identité, les coordonnées et la fidélité après la recherche du client.

Codes de reponse

  • OK Response (200): retourne le profil détaillé du client pour le compte sélectionné.
  • Error (400): la validation de la requête a échoué ou une valeur d'entrée est mal formée.
  • Error (401): l'authentification est absente, invalide ou expirée.
  • Error (403): l'accès à ce profil client est interdit dans le contexte courant.
  • Error (404): le profil client est introuvable.
GET/v2/customers/{customer_id}/profile
Voir plus