L'appel API getMember est utilisé pour récupérer des informations sur le compte d'un membre existant.
Exemple d'URL de demande
http://{Votre_URL_API}?q=/getMember
Paramètres d'entrée
Paramètres | Description | Exigée |
apikey | Clé API de Références de l'API MemberMouse | Oui |
apisecret | Secret de l'API de Références de l'API MemberMouse | Oui |
numéro de membre | ID du membre à récupérer | Oui, si l'adresse électronique n'est pas fournie |
courriel | Adresse électronique du membre à récupérer | Oui, si le numéro d'identification de l'adhérent n'est pas fourni |
Codes de réponse
- 200 - Succès
- 409 - Impossible de trouver un membre avec l'identifiant ou l'adresse électronique transmis.
Données de réponse
Paramètres | Description |
numéro de membre | L'identifiant du membre dans MemberMouse |
prénom | Le prénom du membre |
nom de famille | Nom de famille du membre |
enregistré | La date d'inscription du membre |
date_d'annulation | Date à laquelle le compte du membre sera annulé. Cette date ne sera définie que si le statut du compte du membre est annulation en cours. |
dernier_congé | Date de la dernière connexion du membre |
dernière_mise_à_jour | Date de la dernière mise à jour du compte du membre |
jours_comme_me_membre | Le nombre de jours depuis lesquels le membre est membre. |
statut | Le statut du compte du membre. 1 (Actif), 2 (Annulé), 3 (Verrouillé), 4 (En pause), 5 (En retard), 6 (En attente d'activation), 7 (Erreur), 8 (Expiré), 9 (En attente d'annulation) |
nom_du_statut | Le nom du statut sur le compte du membre. |
est_complémentaire | Cette valeur indique si le compte du membre est gratuit ou non. Elle prendra la valeur true si le compte est gratuit et false si ce n'est pas le cas. |
niveau d'adhésion | L'identifiant du niveau d'adhésion du membre |
nom_du_niveau_d'appartenance | Le nom du niveau d'adhésion du membre |
Nom d'utilisateur | Le nom d'utilisateur du membre |
courriel | L'adresse électronique du membre |
téléphone | Le numéro de téléphone du membre |
adresse_de_facturation | L'adresse de facturation de l'adhérent |
ville_de_facturation | Ville de facturation du membre |
état de la facturation | Etat de facturation du membre |
code postal de facturation | Code postal de facturation du membre |
pays de facturation | Pays de facturation du membre |
adresse_d'expédition | L'adresse de livraison du membre |
ville_d'expédition | Ville d'expédition du membre |
état_de_livraison | L'état d'expédition du membre |
code postal d'expédition | Code postal du membre |
pays d'expédition | Pays d'expédition du membre |
liasses | Un tableau d'offres groupées appliquées au compte du membre. Voir le tableau ci-dessous pour les paramètres disponibles pour chaque offre. |
champs_personnalisés | Un tableau de champs personnalisés associés au compte du membre. Voir le tableau ci-dessous pour les paramètres disponibles pour chaque champ personnalisé. |
Données de l'offre groupée
Les données relatives aux offres groupées sont stockées sous la forme d'un tableau d'éléments dans l'attribut bundles, qui fait partie des données de la réponse. Les données ne sont renvoyées que pour les offres actives sur le compte du membre. Le tableau ci-dessous présente les paramètres renvoyés pour chaque élément du tableau des offres groupées.
Paramètres | Description |
id | L'ID de l'offre groupée appliquée au compte du membre |
nom | Nom de l'offre groupée appliquée au compte du membre |
jours_avec_forfait | Le nombre de jours pendant lesquels l'offre groupée a été appliquée au compte du membre. |
statut | Statut numérique de l'offre groupée appliquée au compte du membre. La valeur peut être l'une des suivantes 1 (Actif), 4 (En pause), 9 (Annulation en cours) |
nom_du_statut | Le nom ou le statut de l'offre groupée appliquée au compte du membre. |
est_complémentaire | Indique si l'offre est gratuite ou non. Elle prendra la valeur "true" si l'offre est gratuite et "false" si elle ne l'est pas. |
date_added | La date à laquelle l'offre groupée a été appliquée pour la première fois au compte du membre. |
dernière_mise_à_jour | Date de la dernière mise à jour de l'offre groupée sur le compte du membre |
Données des champs personnalisés
Les données des champs personnalisés sont stockées sous forme de tableau d'éléments dans l'attribut custom_field, dans le cadre des données de la réponse. Le tableau ci-dessous présente les paramètres disponibles pour chaque élément du tableau des champs personnalisés.
Paramètres | Description |
id | L'ID du champ personnalisé |
nom | Le nom du champ personnalisé |
valeur | La valeur stockée dans le champ personnalisé sur le compte du membre |