EDD REST API V2 – Clienți

Acest document se referă specific la Versiunea 2 a API-ului EDD.
Documentația pentru Versiunea 1 este aici.

The
EDD REST API oferă un endpoint numit /customers/. Endpointul pentru clienți vă permite să interogați baza de date și să preluați o listă de clienți care au achiziționat articole din magazinul dvs. O interogare de bază pentru clienți arată astfel:

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

Pentru fiecare client returnat, următoarele informații sunt returnate pentru fiecare client:

• customer_id – ID-ul unic al clientului. Corespunde cu id în acest rezultat al API-ului.
• user_id – ID-ul utilizatorului WordPress. Dacă clientul a achiziționat ca invitat, acesta va returna nimic.
• username – Numele de utilizator WordPress. Dacă clientul a achiziționat ca invitat, acesta nu va returna nimic.
• display_name – Numele afișat al utilizatorului WordPress. Dacă clientul a achiziționat ca invitat, acesta nu va returna nimic.
• first_name – Prenumele clientului.
• last_name – Numele de familie al clientului.
• email – Adresa de e-mail a clientului.
• date_created – Data la care a fost creat acest client în EDD.
• total_purchases – Numărul total de achiziții efectuate de client.
• total_spent – Suma totală cheltuită de client.
• total_downloads – Numărul total de fișiere descărcate de client.
• date – Data pentru care se vor prelua clienții. Aceasta are trei valori acceptate:
  • today – Va prelua clienții creați în ziua curentă.
  • yesterday – Va prelua clienții creați în ziua precedentă.
  • range – Va prelua clienții creați într-un interval de date.
    • startdate – Format: YYYYMMDD. Exemplu: 20120224 = 2012/02/24
    • enddate – Format: YYYYMMDD. Exemplu: 20120531 = 2012/02/24

Pe lângă datele returnate pentru fiecare client, există un obiect
stats care arată numărul total de clienți din baza de date.

Un răspuns la o interogare de clienți arată astfel:

{
    "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
}

Dacă doriți să preluați informațiile pentru un client specific, puteți adăuga
parametrul &customer={identifier}, astfel:

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

sau

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

Răspunsul pentru un singur client va fi acesta:

{
    "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
            }
        }
    ]
}

O interogare care caută clienții creați astăzi ar arăta astfel:

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

Un interval de date ar arăta astfel:

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