Wiederkehrende Zahlungen erweitert die bestehende RESTful API, die in Easy Digital Downloads integriert ist. Sie kann unter folgender Adresse aufgerufen werden:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN
Hinweis: Stellen Sie sicher, dass Sie example.com durch Ihre eigene Adresse und die Schlüssel- und Tokenwerte durch Ihre eigenen ersetzen.
Das obige Beispiel gibt eine Liste aller vorhandenen Abonnements im Shop zurück.
Eingabe
Die REST-API für wiederkehrende Zahlungen akzeptiert neben Schlüssel und Token 3 weitere Optionen: customer, number und paged.
Kunde
Die Eingabe für einen Kunden kann entweder eine Ganzzahl sein, die eine customer_id darstellt, oder eine E-Mail-Adresse. Die resultierende URL sieht dann etwa so aus:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&customer=2
oder
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&[email protected]
Anzahl
Die Option „number“ akzeptiert eine Ganzzahl und gibt so viele Ergebnisse zurück. Ein Beispiel würde so aussehen:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=5
Seitenweise
Die Option „paged“ ermöglicht es Ihnen, einen Ausschnitt aus einer größeren Anzahl zu wählen. Wenn Sie beispielsweise 100 Einträge haben und number=10 verwenden, könnten Sie paged=2 übergeben, um die Zeilen 11-20 zu erhalten. Das würde so aussehen:
https://example.com/edd-api/subscriptions/?key=YOUR_API_KEY&token=YOUR_API_TOKEN&number=10&paged=2
Ausgabe
Die Ausgabe für jedes Abonnement enthält alle Informationen zu diesem Abonnement sowie zum Kunden und zu jeder Verlängerung (Kind-)Zahlung. Zusätzlich gibt es einen Wert, der die Zeit angibt, die für die Abfrage aller Ergebnisse benötigt wurde. Beispiel:
{
"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
}
