Die EDD REST API umfasst sechs Endpunkte für den Zugriff auf Informationen, von denen jeder für eine bestimmte Art von Anfrage verwendet wird:
- stats – Zum Abrufen von Einnahmen-/Verkaufsstatistiken für bestimmte Daten, Datumsbereiche und Produkte.
- products – Zum Abrufen von Informationen über Store-Produkte.
- customers – Zum Abrufen von Kundenstatistiken.
- sales – Zum Abrufen aktueller Verkäufe und Informationen zu jedem Verkauf (gekaufte Artikel, Käufer, Betrag usw.).
- discounts – Zum Abrufen von Informationen über alle verfügbaren Rabatte.
- download-logs – Zum Abrufen von Protokollen für Dateidownloads.
Die Endpunkte werden wie folgt verwendet:
https://example.com/edd-api//
Zum Beispiel:
https://example.com/edd-api/sales/
In Kombination mit dem API-Schlüssel und Token sieht die vollständige URL wie folgt aus:
https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70
Sichtbarkeit
Alle Endpunkte erfordern den API-Schlüssel und das Token, mit Ausnahme des Produkte-Endpunkts. Dies liegt daran, dass Produkte standardmäßig immer öffentlich sein sollen.
Antwortformat
Die vom EDD API gegebene Antwort ist in zwei Formaten verfügbar:
Um das zurückgegebene Format anzugeben (JSON wird verwendet, wenn keines angegeben ist), fügen Sie einfach das Argument
format zur URL hinzu:
https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml
Eine Beispiel-JSON-Antwort sieht wie folgt aus:
{
"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"
}
]
}
]
}
Eine Beispiel-XML-Antwort (für dieselbe Abfrage) sieht wie folgt aus:
611
20
0
false
20
manual
[email protected]
2013-02-25 11:42:05
Simple Notices Pro
20
Price one
Optionale URL-Variablen
Sie können zusätzliche URL-Variablen hinzufügen, um die ausgegebenen Ergebnisse anzupassen. Hier sind einige Beispiele, wie Sie das tun können.
- Anzahl: Standardmäßig zeigt die API 10 Ergebnisse pro Seite an, wenn dies unter Ihren Leseeinstellungen in WordPress festgelegt ist. Wenn Sie dies für einen bestimmten API-Aufruf ändern möchten, können Sie „&number=11“ zur URL hinzufügen, um eine andere Anzahl von Ergebnissen pro Seite zu erhalten. In diesem Beispiel würden Sie 11 Ergebnisse erhalten.
- Seite: Standardmäßig zeigt die API die Seite 1 der Ergebnisse an. Wenn Sie dies für einen bestimmten API-Aufruf ändern möchten, können Sie „&page=2“ zur URL hinzufügen, um eine andere Seite mit Ergebnissen zu erhalten.
