Terugkerende Betalingen breidt de bestaande RESTful API uit die is ingebouwd in Easy Digital Downloads. Het is toegankelijk op
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN
Let op: zorg ervoor dat u example.com vervangt door uw eigen adres en de sleutel- en tokenwaarden door uw eigen waarden.
Het bovenstaande voorbeeld retourneert een lijst van alle bestaande abonnementen in de winkel.
Invoer
De REST API voor Terugkerende Betalingen accepteert naast sleutel en token 3 opties: customer, number en paged.
Klant
De invoer voor een klant kan een geheel getal zijn dat een customer_id vertegenwoordigt of een e-mailadres. De resulterende URL zal er ongeveer zo uitzien:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2
of
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]
Aantal
De optie aantal accepteert een geheel getal en retourneert zoveel resultaten. Een voorbeeld zou er zo uit kunnen zien:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5
Gepagineerd
De optie gepagineerd stelt u in staat om een deel van een groter aantal te kiezen. Als u bijvoorbeeld 100 vermeldingen heeft en u gebruikt number=10, dan kunt u paged=2 doorgeven en krijgt u rijen 11-20. Dat zou er zo uit kunnen zien:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2
Uitvoer
De uitvoer voor elk abonnement bevat alle informatie over dat abonnement, evenals over de klant en elke verlengingsbetaling (kindbetaling). Bovendien is er een waarde die de tijd aangeeft die is besteed aan het verkrijgen van de informatie voor alle resultaten. Voorbeeld:
{
"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
}
