API REST EDD – Clients

L'API REST EDD fournit un point de terminaison appelé /customers/. Le point de terminaison des clients vous permet d'interroger la base de données et de récupérer une liste de clients qui ont acheté des articles dans votre boutique. Une requête client de base ressemble à ceci :

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

Pour chaque client retourné, les informations suivantes sont retournées pour chaque client :

• id – L’ID de l’utilisateur WordPress. Si le client a acheté en tant qu’invité, cela renverra -1.
• username – Le nom de connexion de l'utilisateur WordPress. Si le client a acheté en tant qu'invité, cela retournera vide.
• display_name – Le nom d'affichage de l'utilisateur WordPress. Si le client a acheté en tant qu'invité, cela retournera vide.
• first_name – Le prénom du client.
• last_name – Le nom de famille du client.
• email – L'adresse e-mail du client.
• total_purchases – Le nombre total d'achats effectués par le client.
• total_spent – Le montant total dépensé par le client.
• total_downloads – Le nombre total de fichiers téléchargés par le client.

Avec les données retournées pour chaque client se trouve un objet
stats qui montre le nombre total de clients dans la base de données.

Une réponse de requête client ressemble à ceci :

{
    "customers": [
        {
            "info": {
                "id": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 2,
                "total_spent": "20",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": -1,
                "username": "Guest",
                "display_name": "Guest",
                "first_name": "Guest",
                "last_name": "Guest",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 0,
                "total_spent": "0",
                "total_downloads": 0
            }
        }
    ]
}

Si vous souhaitez récupérer les informations d'un client spécifique, vous pouvez ajouter le
paramètre &customer={identifier}, comme ceci :

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1

ou

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&[email protected]

La réponse pour un seul client sera comme ceci :

{
    "customers": [
        {
            "info": {
                "id": 1,
                "username": "pippin",
                "display_name": "Pippin Williamson",
                "first_name": "Pippin",
                "last_name": "Williamson",
                "email": "[email protected]"
            },
            "stats": {
                "total_purchases": 61,
                "total_spent": 1139.68,
                "total_downloads": 31
            }
        }
    ]
}