API – Listen, Filterung und Paginierung
Einige API-Methoden geben eine Liste von Elementen zurück (z. B. Eingänge, Bestellungen, Bewegungen auf dem Provisionskonto).
Diese Methoden haben ein gemeinsames Verhalten – gleiche Eingabeparameter für Filterung und Paginierung sowie eine einheitliche Ausgabestruktur.
Ausgangsdaten
Die Antwort von Methoden, die eine Liste zurückgeben, enthält immer folgende Elemente:
- results – Feld mit Objekten, die einzelne Elemente der Liste enthalten
- page – Nummer der aktuellen Seite
- count – Anzahl der in der Antwort zurückgegebenen Elemente
- filteredCount – Anzahl der Elemente, die den aktuellen Filtern entsprechen
- totalCount – Gesamtzahl der Elemente ohne Filter
Beispielantwort
Die konkreten Einträge in den Ergebnissen sind hier nicht aufgeführt:
{ "results": [ ... ], "page": 1, "count": 10, "filteredCount": 18, "totalCount": 624, "requestId": "..." }
Insgesamt gibt es 624 Einträge (z. B. Bestellungen),
davon entsprechen 18 den aktuellen Filtern und die ersten
10 Einträge wurden zurückgegeben (Seite 1, Seitengröße 10).
Filtern
Du kannst einen oder mehrere Filter zur Anfrage hinzufügen. Die Filter werden als GET-Parameter übermittelt und anhand dieser werden die Elemente ausgewählt, die die API zurückgibt.
- ID – gibt nur den Eintrag mit der angegebenen ID zurück
- lastID – gibt nur Elemente zurück, deren ID höher als der angegebene Wert ist (geeignet zum Laden neuer Elemente)
lastID ist ideal, wenn Sie regelmäßig neue Einträge
ab der letzten bekannten ID hinzufügen und sich nicht um die Rückwärtssortierung kümmern möchten.
Beispiel – Bestellungen mit einer ID höher als 1234
https://api.wedos.as/partner/orders?lastID=1234
Seitenumbruch
Die Listen können paginiert werden, d. h. nur in bestimmten Mengen zurückgegeben werden. Die API ermöglicht die Rückgabe von maximal 1000 Einträgen pro Aufruf.
- Seite – Standard 1
- count – Standardwert 100
- Anzahl – maximal 1000
Wenn Sie nur eine kleine Vorschau (z. B. 10 Einträge) wünschen, geben Sie count=10 ein.
Wenn Sie größere Mengen herunterladen, bleiben Sie vernünftig (z. B. 100-300), um den Endpunkt nicht unnötig zu belasten.
Beispiel – 10 Einträge auf der zweiten Seite
Gibt die Elemente 11 bis 20 zurück:
https://api.wedos.as/partner/orders?Seite=2&count=10
Wenn du dir nicht sicher bist
Wenn du dir bezüglich der Filterung oder Paginierung in einer bestimmten Methode unsicher bist, kannst du das öffentliche Diskussionsforum nutzen oder uns direkt eine E-Mail schreiben:
affiliate@wedos.com.