Ce document concerne spécifiquement la version 2 de l'API EDD.
La documentation de la version 1 est ici.
L'
API REST EDD donne accès aux informations sur les produits via le point de terminaison /products/. Vous pouvez accéder à plusieurs produits ou à un seul produit.
NOTE : Le point de terminaison des produits n'a pas besoin de clé ou de jeton pour afficher les produits publiquement disponibles. Si votre produit est publiquement disponible sur la page d'accueil de votre site, il est disponible via l'API sans clé ni jeton.
Une requête de base pour les produits ressemble à ceci :
https://example.com/edd-api/v2/products/
Un exemple de réponse des produits ressemble à ceci,
notes ci-dessous :
{
"products": [
{
"info": {
"id": 45,
"slug": "pdf-test",
"title": "PDF Test",
"create_date": "2016-05-23 18:44:51",
"modified_date": "2016-06-08 17:30:54",
"status": "publish",
"link": "https://example.com/?post_type=download&p=45",
"content": "",
"excerpt": "",
"thumbnail": false,
"category": [
{
"term_id": 3,
"name": "ebooks",
"slug": "ebooks",
"term_group": 0,
"term_taxonomy_id": 3,
"taxonomy": "download_category",
"description": "",
"parent": 0,
"count": 2,
"filter": "raw",
"object_id": 45
}
],
"tags": [
{
"term_id": 7,
"name": "pdf",
"slug": "pdf",
"term_group": 0,
"term_taxonomy_id": 7,
"taxonomy": "download_tag",
"description": "",
"parent": 0,
"count": 1,
"filter": "raw",
"object_id": 45
}
],
"sku": "AAMAM2016"
},
"stats": {
"total": {
"sales": "0",
"earnings": "0.00"
},
"monthly_average": {
"sales": "0",
"earnings": "0.00"
}
},
"pricing": {
"amount": "1.00"
},
"files": [
{
"index": "0",
"attachment_id": "18",
"name": "WCCHI_2014_page_speed",
"file": "https://example.com/wp-content/uploads/edd/2016/05/WCCHI_2014_page_speed.pdf",
"condition": "all"
}
],
"notes": "",
"licensing": {
"enabled": false,
"version": "",
"exp_unit": "days",
"exp_length": ""
}
},
{
"info": {
"id": 42,
"slug": "variable-license",
"title": "Variable license",
"create_date": "2016-05-20 22:21:38",
"modified_date": "2016-05-23 17:32:47",
"status": "publish",
"link": "https://example.com/?post_type=download&p=42",
"content": "",
"excerpt": "",
"thumbnail": false,
"category": false,
"tags": false,
"sku": "-"
},
"stats": {
"total": {
"sales": "0",
"earnings": "0.00"
},
"monthly_average": {
"sales": "0",
"earnings": "0.00"
}
},
"pricing": {
"monthly": "10.00",
"yearly": "120.00"
},
"files": [
{
"index": "0",
"attachment_id": "18",
"name": "WCCHI_2014_page_speed",
"file": "https://example.com/wp-content/uploads/edd/2016/05/WCCHI_2014_page_speed.pdf",
"condition": "all"
}
],
"notes": "",
"licensing": {
"enabled": true,
"version": "",
"exp_unit": "days",
"exp_length": ""
}
},
{
"info": {
"id": 17,
"slug": "i-am-pippin-williamson-and-so-can-you",
"title": "I am Pippin Williamson, and so can YOU",
"create_date": "2016-05-17 14:03:50",
"modified_date": "2016-06-02 19:51:17",
"status": "publish",
"link": "https://example.com/?post_type=download&p=17",
"content": "This is a test",
"excerpt": "",
"thumbnail": false,
"category": [
{
"term_id": 3,
"name": "ebooks",
"slug": "ebooks",
"term_group": 0,
"term_taxonomy_id": 3,
"taxonomy": "download_category",
"description": "",
"parent": 0,
"count": 2,
"filter": "raw",
"object_id": 17
}
],
"tags": false,
"sku": "-"
},
"stats": {
"total": {
"sales": "4",
"earnings": "78.000000"
},
"monthly_average": {
"sales": "4",
"earnings": "78.000000"
}
},
"pricing": {
"amount": "20.00"
},
"files": [
{
"index": "0",
"attachment_id": "18",
"name": "WCCHI_2014_page_speed",
"file": "https://example.com/wp-content/uploads/edd/2016/05/WCCHI_2014_page_speed.pdf",
"condition": "all"
}
],
"notes": "This is my download note!",
"licensing": {
"enabled": false,
"version": "",
"exp_unit": "",
"exp_length": ""
}
},
],
"request_speed": 0.0075628757476807
}
Si les SKU sont activés, mais que le champ est vide, il affichera un trait d'union, comme pour le deuxième produit dans l'exemple ci-dessus.
Filtrage des produits
Produits spécifiques
Si vous souhaitez récupérer des informations pour un seul produit spécifique, vous pouvez passer un ID de produit via le
paramètre product :
https://example.com/edd-api/v2/products/?product=55
Recherche
Si vous souhaitez rechercher un produit, vous pouvez passer une phrase de recherche via le
paramètre s :
https://example.com/edd-api/v2/products/?s=PDF
Tags et catégories
Vous pouvez affiner votre recherche en utilisant les mots-clés category et tag, suivis d'un slug ou d'un ID. Quelques exemples :
https://example.com/edd-api/v2/products/?category=ebooks
https://example.com/edd-api/v2/products/?category=3
https://example.com/edd-api/v2/products/?tag=pdf
https://example.com/edd-api/v2/products/?tag=42
Exemple combiné :
https://example.com/edd-api/v2/products/?category=ebooks&tag=pdf
