EDD REST API V2 – Clients

Ce document concerne spécifiquement la version 2 de l'API EDD.
La documentation de la version 1 est ici.

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/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&number=25

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

• customer_id – L'ID unique du client. Correspond à id dans ce résultat d'API.
• user_id – L'ID de l'utilisateur WordPress. Si le client a acheté en tant qu'invité, cela retournera vide.
• 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.
• date_created – La date à laquelle ce client a été créé dans EDD.
• 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.
• date – The date to retrieve cutomers for. This has three accepted values:
  • today – Récupérera les clients créés le jour même.
  • yesterday – Récupérera les clients créés la veille.
  • range – Will retrieve customers created within a date range.
    • startdate – Format : YYYYMMDD. Exemple : 20120224 = 24/02/2012
    • enddate – Format : YYYYMMDD. Exemple : 20120531 = 31/05/2012

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": "3",
                "user_id": "",
                "username": "",
                "display_name": "",
                "customer_id": "3",
                "first_name": "Matthew",
                "last_name": "Dixon",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-28 00:09:40"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "20.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "2",
                "user_id": "2",
                "username": "bob",
                "display_name": "bob",
                "customer_id": "2",
                "first_name": "",
                "last_name": "",
                "email": "[email protected]",
                "additional_emails": [
                    "[email protected]"
                ],
                "date_created": "2016-05-17 14:17:15"
            },
            "stats": {
                "total_purchases": "1",
                "total_spent": "0.000000",
                "total_downloads": 0
            }
        },
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ],
    "request_speed": 0.0081720352172852
}

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/v2/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&customer=1

ou

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

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

{
    "customers": [
        {
            "info": {
                "id": "1",
                "user_id": "1",
                "username": "jose",
                "display_name": "Jose",
                "customer_id": "1",
                "first_name": "Jose",
                "last_name": "Espinoza",
                "email": "[email protected]",
		"additional_emails": [],
                "date_created": "2016-05-17 14:08:57"
            },
            "stats": {
                "total_purchases": "6",
                "total_spent": "70.000000",
                "total_downloads": 2
            }
        }
    ]
}

Une requête recherchant les clients créés aujourd'hui ressemblerait à ceci :

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

Une plage de dates ressemblerait à ceci :

https://yoursite.com/edd-api/customers/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&date=range&startdate=20130201&enddate=20130210