In diesem Leitfaden wird beschrieben, wie ein Affiliate-Partner Leads an Driftrock senden kann.
Erstens müssen Sie auf der Driftrock-Plattform bereits ein Affiliate Capture eingerichtet haben, an das Sie die Leads senden. Dieses sollte von einem Benutzer im Driftrock-Konto eingerichtet werden. Sehen Sie sich hier die Anleitung von Driftrock zur Einrichtung eines Driftrock-Affilate-Captures an .
Der Driftrock-Benutzer sollte Ihnen auch die folgenden Informationen zur Verfügung gestellt haben, damit Sie die POST-Anfrage erstellen können:
- Die erwarteten Felder in einer Beispiel-Nutzlast
- Ihre Partner-ID
- Ihr API-Schlüssel
Erstellung der POST-Anfrage
Siekönnen POST-Anfragen an diese URL stellen:
https://external-apis.driftrock.com/v2/affiliate_event
Überschriften:
Content-Type: application/json
Accept: application/json
Authorization: Bearer xxxx-xxxx-xxxx-xxxx
wobei xxxx-xxxx-xxxx-xxxx ein API-Schlüssel ist, den der Client an Sie sendet.
Körper:
Der Body muss JSON-formatiert sein und die erforderlichen oder empfohlenen Felder enthalten:
- event_type [string] (erforderlich): Dies sollte auf Lead, Conversion oder Action gesetzt werden.
- event_name [string] (erforderlich): Geben Sie uns an, welche Bezeichnung Sie diesem Ereignis geben möchten (z. B.: Benutzer angemeldet, Seitenansicht, Kauf)
- source_id [string] (erforderlich): Dies wird benötigt, um das Ereignis mit dem erstellten Capture zu verknüpfen. Dies wird in der Beispiel-Nutzlast sein, die der Client sendet.
- affiliate_id [string] (erforderlich): Diese Angabe wird benötigt, um das Ereignis mit einem der Partner zu verknüpfen, die im Schritt "Partner" (Schritt 3) der Erfassung eingerichtet wurden.
- fields [json] (required) : this is a json field, where you send us the attributes of this event (eg: "fields": {"email": "test@driftrock.com", "question_1": "test answer"} )
- event_id [string] (optional): Dies kann eine beliebige ID sein, die in Ihrem System zur eindeutigen Identifizierung dieses Ereignisses verwendet wird. Wenn Sie zwei Ereignisse mit derselben event_id senden, werden sie in unserem System mit derselben Person verknüpft.
- person_id [string] (optional): Dies kann eine beliebige ID sein, die in Ihrem System zur eindeutigen Identifizierung einer Person verwendet wird. Beachten Sie, dass wenn Sie zwei Ereignisse mit der gleichen person_id senden, diese in unserem System mit der gleichen Person verknüpft werden.
- ga_client_id [string] (optional) : Dies ist die Google Analytics ID, die Sie uns zur Verfügung stellen können, damit wir Marketinginformationen extrahieren können.
- created_at [string] (optional): wenn Sie einen genaueren Zeitstempel für das Eintreten des Ereignisses angeben möchten. Wenn Sie keinen Zeitstempel angeben, wird dieser auf den Zeitpunkt gesetzt, zu dem Driftrock das Ereignis empfängt; dies ist ein feiner Unterschied, kann aber für Ihren Geschäftsfall wichtig sein. Der Zeitstempel sollte im ISO8601-Format übergeben werden (z. B. 2019-12-02T10:00:00.000Z).
Unter Verwendung der Beispielzeichenkette und der Partner-ID, die Sie vom Kunden mit Driftrock erhalten haben, sollte der Textkörper beispielsweise so aussehen:
{
"event_type": "lead",
"event_name": "Lead received",
"source_id": "",
"affiliate_id": "AFFILIATE_ID",
"fields": {
"email_": "...", // required
"last_name": "...", // required
"first_name": "...", // required
"postcode": "..."
}
}
Senden Sie Ihre erste Probeleitung.
Wenn Ihr Test erfolgreich war, sollten Sie die folgende Antwort erhalten:
- Status: 200
- payload: {"data": "ok"}
Wenn Ihr Test fehlgeschlagen ist, erhalten Sie die folgende Antwort:
- Status: 400
- payload: {"error": "..."}
Setzen Sie sich mit dem Driftrock-Benutzer in Verbindung, um zu bestätigen, dass Ihr Hinweis erfolgreich gesendet wurde.
