Addrevenue API-Referenz
Addrevenue API-Referenz
Unsere REST-API wurde entwickelt, um die Anforderungen von Partnern und Werbetreibenden zu unterstützen. Es verwendet OAuth 2.0 und Sie generieren manuell ein lebenslanges API-Token in unserer Benutzeroberfläche. Dieses Bearer-Token wird dann als Autorisierungsheader gesendet.
API-Basis-URL
Alle Endpunkte beginnen mit der Basis-URL:
https://addrevenue.io/api/v2
Stellen Sie sicher, dass Sie immer das HTTPS-Protokoll verwenden.
Authentifizierung
Um eine API zu generieren, melden Sie sich bei Addrevenue an, klicken Sie auf „API-Token“ und dann auf „Neues API-Token generieren“. Dadurch wird ein einmaliges, lebenslanges API-Token für den angemeldeten Benutzer erstellt, das den Client autorisiert, im Namen dieses Benutzers zu handeln.
Das Token sollte dann als Bearer-Token in allen Anfragen an alle API-Endpunkte gesendet werden.
Beispiel einer Überschrift:
Autorisierung: Inhaber 1892cd44-c59c-42bf-9f1d-a5316ea695cc
Inhaltstyp: application/json
Fehler
Das Senden eines leeren oder ungültigen Bearer-Tokens führt zu einem der folgenden HTTP-Fehler:
403 Autorisierungsheader nicht gefunden
Dies weist darauf hin, dass der Autorisierungsheader fehlt oder in irgendeiner Weise fehlerhaft ist, beispielsweise dass die Zeichenfolge „Bearer“ fehlt.
403 Ungültiges Token
Der Header ist korrekt formatiert, aber das bereitgestellte API-Token existiert nicht.
403 Inaktives Konto
Der Header ist korrekt formatiert und das bereitgestellte API-Token ist vorhanden, gehört jedoch zu einem Konto, das nicht aktiv ist.
Antworten
Alle Antworten liegen im JSON-Format vor und enthalten http_code (dasselbe wie im Antwortheader), count (Anzahl der Ergebniselemente) und results (ein Array von Ergebniselementen).
Beispiel (gekürzt):
{
"http_code": 200,
"Anzahl": 2,
"Ergebnisse": [
{
"id": 1000,
"description": "Beispielkampagne A"
},
{
"id": 1001,
"description": "Beispielkampagne B"
}
]
API-Endpunkte
Da es sich bei dieser API noch um eine Beta-Version in der Entwicklung handelt, haben wir die genaue Dokumentation des Antworttextes aller Endpunkte verschoben.
- Werbetreibende
- Banner
- Kampagnen
- Kanäle
- Veranstaltungen
- Auszahlungen
- Produkte
- Produkt-Feeds
- Beziehungen
- Statistiken
- Transaktionen
Anforderungsparameter
Im Allgemeinen können Sie Anforderungsparameter in der Abfragezeichenfolge mit denselben Namen wie in der Antwort senden, um die Anforderung zu filtern. Wenn Sie beispielsweise nur die Klicks für die Klick-ID 6230fe5f0fc866.4851567a abrufen möchten, würde die Anfrage folgendermaßen aussehen: /events?type=Click&clickId=6230fe5f0fc866.4851567a.
Datumsintervalle
Bei einigen Endpunkten wird es angewendet, um Anforderungsparameter für Datumsintervalle bereitzustellen, beispielsweise für Transaktionen und Ereignisse. Diese werden durch die Verwendung von fromDate und/oder toDate bereitgestellt. Sie können zusammen verwendet werden, um ein Intervall festzulegen, oder nur einer von ihnen.
Werbetreibende gewinnen
GET /advertisers
Bei der Authentifizierung als Affiliate-Konto enthält die Antwort eine Reihe aller aktiven Werbetreibenden. Wenn eine Kanal-ID angegeben wird, enthält die Antwort nur Werbetreibende mit beliebiger Art von Beziehung (aktiv, ausstehend oder abgelehnt). Der Beziehungsstatus wird als relationStatus zurückgegeben.
Bei der Authentifizierung als Werbetreibendenkonto enthält die Antwort nur das authentifizierte Werbetreibendenkonto selbst.
Anforderungsparameter:
| Parameter | Beschreibung |
|---|---|
|
Kanal-ID |
Optional. Wenn eine Kanal-ID angegeben wird, enthält die Antwort nur Werbetreibende mit irgendeiner Art von Beziehung zum angegebenen Kanal. |
| Parameter | Beschreibung |
|---|---|
|
Kanal-ID |
Optional. Wenn eine Kanal-ID angegeben wird, werden Tracking-Codes für alle Banner in die Antwort aufgenommen. |
| Parameter | Beschreibung |
|---|---|
|
Kanal-ID |
Optional. Wenn eine Kanal-ID angegeben wird, werden nur Kampagnen für Werbetreibende mit genehmigten Beziehungen zum Kanal einbezogen. Kanalspezifische Tracking-Links für alle Kampagnen werden in die Antwort aufgenommen. |
| Parameter | Beschreibung |
|---|---|
|
Grenze |
Optional. Anzahl der Produkte in der Antwort. Der Standardwert ist 100. Das Maximum ist 1000. |
|
Versatz |
Optional. Der Offset der Seitennummerierung. Der Standardwert ist 0, wodurch das Limit der ersten Produkte erreicht wird. Wenn Sie 1 übergeben, werden die nächsten Limit-Ergebnisse zurückgegeben. |
| Parameter | Beschreibung |
|---|---|
|
Kanal-ID |
Erforderlich. Die Kanal-ID ist erforderlich, da sie in die generierten Produkt-Feed-URLs aufgenommen wird. |
| Parameter | Beschreibung |
|---|---|
|
groupBy |
Optional. Falls enthalten, wird die Antwort auf der GroupBy-Ebene aggregiert. Akzeptierte Optionen für GroupBy sind Datum, Werbetreibender, Kanal und Programm. Wenn nicht angegeben, wird die Antwort zu einem einzigen Block zusammengefasst. Um nach mehreren Dimensionen zu gruppieren, können Sie ein Komma als Trennzeichen verwenden. |
| Parameter | Beschreibung |
|---|---|
|
Clicks einschließen |
Optional. Wenn es eingeschlossen und auf 1 gesetzt ist, enthält die Antwort auch ein Array aller Klicks, die der Transaktion vorausgingen. |