Paiements récurrents étend l'API RESTful existante intégrée à Easy Digital Downloads. Elle est accessible à
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN
Note : assurez-vous de remplacer example.com par votre propre adresse et les valeurs de clé et de jeton par les vôtres.
L'exemple ci-dessus renverra une liste de tous les abonnements existants dans la boutique.
Entrée
L'API REST des paiements récurrents accepte 3 options en plus de la clé et du jeton : customer, number et paged.
Client
L'entrée pour un client peut être soit un entier représentant un customer_id, soit une adresse e-mail. L'URL résultante ressemblera à ceci :
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2
ou
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]
Nombre
L'option number accepte un entier et renvoie ce nombre de résultats. Un exemple ressemblerait à ceci :
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5
Paginé
L'option paged vous permet de choisir une tranche d'un plus grand nombre. Par exemple, si vous avez 100 entrées et que vous utilisez number=10, vous pourriez passer paged=2 et obtenir les lignes 11-20. Cela ressemblerait à ceci :
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2
Sortie
La sortie pour chaque abonnement contient toutes les informations sur cet abonnement ainsi que sur le client et chaque paiement de renouvellement (enfant). De plus, il y a une valeur indiquant le temps passé à obtenir les informations pour tous les résultats. Exemple :
{
"subscriptions": [
{
"info": {
"u0000EDD_Subscriptionu0000subs_db": {
"table_name": "wp_edd_subscriptions",
"version": "1.0",
"primary_key": "id"
},
"id": "1",
"customer_id": "2",
"period": "month",
"initial_amount": "50.00",
"recurring_amount": "50.00",
"bill_times": "0",
"parent_payment_id": "87",
"product_id": "85",
"created": "2016-03-15 15:36:30",
"expiration": "2016-04-15 23:59:59",
"status": "active",
"profile_id": "paypal-363e3cc178dab152bb59b958024bce75",
"gateway": "paypal",
"customer": {
"id": "2",
"purchase_count": "2",
"purchase_value": "20.000000",
"email": "[email protected]",
"name": "Jane Doe",
"date_created": "2016-03-07 22:33:44",
"payment_ids": "16",
"user_id": "3",
"notes": [
]
}
},
"payments": [
{
"id": 106,
"amount": 10.36,
"date": "March 21, 2016",
"status": "Renewal"
},
{
"id": 105,
"amount": 10,
"date": "March 21, 2016",
"status": "Renewal"
},
{
"id": 104,
"amount": 10,
"date": "March 21, 2016",
"status": "Renewal"
}
]
}
],
"request_speed": 0.076335906982422
}
