Administration:Transaktions-API

Aus easy-m.de Dokumentations-WIKI
Wechseln zu: Navigation, Suche

Dokumentation der Transaktions API – Stand Mai 2015


Allgemeine Informationen zur API und mögliche Parameter zur Filterung:

Die Ausgabe der Datei ist in CSV, XLS sowie XML möglich, dafür müssen Sie nur die Datei Endung entsprechend anpassen (im Beispiel ist es .csv)
Die genauen Links zur API finden Sie im Login Bereich unter API => Daten-API, wo Ihnen neben der Transaktions-API noch bis zu 13 unterschiedliche Statistik-APIs angeboten werden.

Die API-Schnittstelle der Private Network Software easy.affiliate bietet Ihnen mehrere Filtermöglichkeiten.

Startdatum ==> condition[period][from]=01.05.2015
Datum von dem an die Statistiken genommen werden sollen
 
Enddatum  ==> condition[period][to]=15.05.2015
Bis zu diesem Datum sollen die Werte geholt werden
 
Anstelle der oben genannten Eingabe geht auch:
LINK-MIT-APIKEY/get-statistic_transactions.csv?condition[dynamicdate]=currentmonth

condition[dynamicdate]=

currentmonth steht für aktueller Monat
lastmonth wäre letzter Monat
last10d - die letzten 10 Tage
currentweek ist die Aktuelle Woche

Zudem gibt es zusätzlich noch die Status Abfrage:

LINK-MIT-APIKEY/ get-statistic_transactions.csv?condition[period][from]=01.05.2015&condition[period][to]=15.05.2015&condition[l:status]=open

 condition[l:status]=

open steht für offene Transaktionen
confirmed sind bestätigte, aber noch nicht ausgezahlte Transaktionen
paid
sind bestätigte und bereits ausgezahlte Transaktionen
canceled sind stornierte Transaktionen 

Hier ist auch eine Kombination mehrer Status möglich:
condition[l:status]=confirmed,paid


So erhalten Sie die bestätigten sowie ausgezahlten Transaktionen (kommasepariert)

Sonstige API Filter

&condition[l:campaigns]=1,2 Wenn mehrere Kampagnen betrieben werden, können Sie hier gezielt die gewünschten Transaktionen einzelner Kampagnen abfragen
&condition[l:publisher]=1,1001 Falls Sie nur von einzelnen Publishern die Transaktionen laden möchten, so können Sie kommasepariert die IDs eintragen


 

Definition der Felder in der Transaktions-API

<tbody> </tbody>

id interne ID der Transaktion - darf nicht gelöscht oder verändert werden
status 0 = offen |  1 = freigegeben | 2 = Storniert | 3 = ausgezahlt
timestamp Zeitpunkt der Transaktion - Format: YYYY-MM-DD HH:MM:SS
campaign_id Kampagnen ID
ordertoken Order ID / Bestellnummer
source Trackingform - internes Feld 
project_id Projekt ID des Publishers
type Transaktionstyp (lead - sale - bonus)
commission Provisionshöhe zu dieser Transaktion
commission_group_id Interne ID der Provisionsgruppe des Publishers zum Zeitpunkt der Transaktion (sollte nicht verändert werden!)
trigger_id ID des Transaktionstypens (bspw. Sale | Neukunde | Newsletter | Mobile Sale usw.)
description falls im Trackingpixel eine description übergeben wird, erscheint diese hier
trigger_value Wert (prozentwert oder Fixer Wert der Transaktion)
trigger_type Trigger Typ in der Provisionsgruppe (lead_fixed | sale_fixed | lead_dynamic | sale_dynamic)
turnover Netto Warenkorbwert - sollte es Änderungen (Teilstornos) geben so muss dieser Wert angepasst werden beim Abgleich
action_id interne ID der Transaktion
salary_id Auszahlungs ID | -1 = noch nicht ausgezahlt ansonsten erscheint die ID des Gutschriftenlaufs
session_id interne Session ID
order_currency Währung der Bestellung
status_change_date Zeitpunkt des Status-Updates der Transaktion - Format: YYYY-MM-DD HH:MM:SS
cancel_reason Storno Begründung (optional)
source_turnover Ursprünglicher Warenkorbwert - darf nicht verändert werden
last_change Zeitpunkt einer Transaktion Änderung - Format: YYYY-MM-DD HH:MM:SS
user_agent User Agent Informationen des Bestellers
order_actions_id interne ID zur Verknüpfung von Order Details (nicht bearbeiten)
bonus_id Falls es sich um einen Bonuslauf handelt (Staffelbonus) wird hier die ID des Bonuslaufs festgehalten
customer_journey_status 0 = keine Journey bekannt | 1 = Journey vorhanden
ebestid Verschlüsselte Bestellnummer welche dem Publisher angezeigt wird und bei Rückfragen benötigt wird
order_timestamp Zeitpunkt der Transaktion - Format: YYYY-MM-DD HH:MM:SS
action_timestamp Zeitpunkt des Trackingrelevanten Klicks / Postviews - Format: YYYY-MM-DD HH:MM:SS
trigger_title Titel des Trigger / Events (bsp. Neukunde | Sale | Newsletter )
payoutdate Zeitpunkt der Auszahlung - Format: YYYY-MM-DD HH:MM:SS
campaign_group_title Provisionsgruppen Titel (Standard | Premium usw)
campaign_title Titel der Kampagne 
advertiser_id Advertiser ID (intern)
publisher_id Publisher ID (Account ID des Partners)
publisher_prename Nachname des Publishers
publisher_surname Vorname des Publishers
publisher_searchtitle Falls vergeben der Suchtitel eines Publishers
referrer Klickreferrer welcher zu der Transaktion geführt hat
country Land des Bestellers
subid SubID des Publishers zu dieser Transaktion
basket_items Anzahl der Artikel im übermittelten Baskets

 

 


 

REST Schnittstelle

Sie haben weiterhin die Möglichkeit Ihre Transaktion über unsere Restschnittstelle via PUT zu übertragen. Die Schnittstelle Rufen sie über den |API_LINK|/REST/orders/ auf. Hierbei sind nachstehende Parameter verpflichtend.

- login_id

- token (hierbei der login token der sich aus der Normalen )

- section (bei Administrator Admin)

- file (die Datei welche verwendet werden soll)

 

Für die Datei wird nun eine CSV Datei welche Semikolon getrennt und Anführungszeichen als Texttrenner erwartet.

Diese CSV Datei muss nachfolgende Felder Beinhalten.

- orderid

- campaign_id

- commissiongroup

- trigger_id

- project_id

- conversiontype

- price

- commission

- order_timestamp

- ordertoken

- cancel_reason

- status

Meine Werkzeuge
MediaWiki Appliance - Powered by TurnKey Linux