L'API REST EDD comprend six points de terminaison pour accéder aux informations, chacun pour effectuer un type de requête spécifique :
- stats – Pour récupérer les statistiques de revenus/ventes pour des dates spécifiques, des plages de dates et des produits spécifiques.
- products – Pour récupérer des informations sur les produits du magasin.
- customers – Pour récupérer les statistiques des clients.
- sales – Pour récupérer les ventes récentes et des informations sur chaque vente (articles achetés, acheteur, montant, etc.).
- discounts – Pour récupérer des informations sur toutes les remises disponibles.
- download-logs – Pour récupérer les journaux des téléchargements de fichiers.
Les points de terminaison sont utilisés comme suit :
https://example.com/edd-api//
Par exemple :
https://example.com/edd-api/sales/
Combiné avec la clé API et le jeton, l'URL complète ressemble à ceci :
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Visibilité
Tous les points de terminaison nécessitent la clé API et le jeton, à l'exception du point de terminaison des produits. En effet, les produits sont destinés à être publics par défaut à tout moment.
Format de réponse
La réponse donnée par l'API EDD est disponible en deux formats :
Pour spécifier le format renvoyé (JSON sera utilisé si aucun n'est spécifié), ajoutez simplement l'argument
format à l'URL :
https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml
Un exemple de réponse JSON ressemble à ceci :
{
"sales": [
{
"ID": 611,
"subtotal": "20",
"tax": 0,
"fees": false,
"total": "20",
"gateway": "manual",
"email": "[email protected]",
"date": "2013-02-25 11:42:05",
"products": [
{
"name": "Simple Notices Pro",
"price": "20",
"price_name": "Price one"
}
]
}
]
}
Un exemple de réponse XML (pour la même requête) ressemble à ceci :
611
20
0
false
20
manual
[email protected]
2013-02-25 11:42:05
Simple Notices Pro
20
Price one
Variables d'URL facultatives
Vous pouvez ajouter des variables d'URL supplémentaires pour ajuster la sortie. Voici quelques exemples de la façon dont vous pouvez le faire.
- Nombre : Par défaut, l'API affichera 10 résultats par page, si c'est ce que vous avez défini dans vos paramètres de lecture dans WordPress. Mais si vous souhaitez modifier cela pour un appel API spécifique, vous pouvez ajouter «&number=11 » à l'URL pour obtenir un nombre différent de résultats par page. Dans cet exemple, vous obtiendriez 11 résultats.
- Page : Par défaut, l'API affichera la page numéro 1 des résultats. Si vous souhaitez modifier cela pour un appel API spécifique, vous pouvez ajouter «&page=2 » à l'URL pour obtenir une page de résultats différente.
