Wenn Sie Nachrichten an externe Sevices über API senden möchten, können Sie den Abruf von Callbacks (Rückrufen) aus Prozessen einrichten. Callback stellt eine spezielle Funktion dar, die Daten an externe Systeme übermittlet. Sie kann von Nutzen sein, wenn Sie z.B. einen externen Service zum Verarbeiten der Kunden-Datenbank haben und Sie dorthin Angaben über Benutzer aus GetCourse übertragen möchten, die eine Handlung ausgeführt haben, die in einem Ihrer Prozesse eingerichtet wurde.
Dazu muss man beim Einstellen des Prozesses die Operation “URL abrufen” hinzufügen:
Im Link muss man die Adresse (URL) des externen Services angeben und die Daten aufführen, die aus GetCourse zu übermitteln sind.
Z.B. kann im benutzerorientierten Prozess die folgende Syntax verwendet werden:
api_url/?var_1={object.first_name}&var_2={object.email}&...
Dann wird in der Anforderungen statt {object.first_name} der Benutzername und statt {object.email} die E-Mail-Adresse des Benutzers angegeben werden. Man kann auch andere Variablen verwenden – die volle Liste siehe unten.
Sehr wichtig ist, die Variablen richtig einzugeben.
Sie können das Verfahren für die Datenübertragung selbst auswählen: GET oder POST (dabei werden jedoch alle Daten unabhängig von der von Ihnen ausgewählten Variante im Link übermittelt, der im URL-Feld angegeben wurde).
Hier ist die volle Liste der Variablen, die man im Link verwenden kann:
1. Benutzer:
- first_name — Name,
- last_name — Nachname,
- name — vollständiger Name,
- id — Identifikator,
- email — Email,
- phone — Telefon,
- city — Stadt,
- avatar_url — Link zum Avatar des Benutzers,
- Feldtitel — Daten aus dem zusätzlichen Feld des Benutzers. Man muss den vollen Titel des Feldes eingeben, dessen Wert zu übertragen ist,
- personal_manager — Name des persönlichen Beraters des Benutzers,
- personal_manager_email — E-Mail-Adresse des persönlichen Beraters des Benutzers,
- personal_manager_phone — Telefon-Nummer des persönlichen Beraters des Benutzers.
2. Bestellung:
- number — Nummer der Bestellung,
- id — Identifikator der Bestellung,
- positions — Zusammensetzung der Bestellung (Bezeichnungen der Angebote),
- offers — Zusammensetzung der Bestellung (ID’s der Angebote),
- cost_money — Wert der Bestellung mit Leerzeichen,
- cost_money_value — Wert der Bestellung ohne Leerzeichen,
- left_cost_money — zu zahlender Restbetrag,
- payed_money —eingezahlter Betrag,
- status — Status der Bestellung,
- payment_link — Link zur Zahlung,
- promocode — wenn in der Bestellung der Promocode verwendet wurde, kann man seine Bezeichnung übermitteln,
- manager — Name des Beraters der Bestellung,
- manager_email — E-Mail-Adresse des Beraters der Bestellung,
- manager_phone — Telefon-Nummer des Beraters der Bestellung.
In der Bestellung gibt es ein spezielles Feld “user” (“Benutzer”), in dem man zusätzliche Daten zum Kunden bekommen kann, der die Bestellung erstellt hat: user.first_name usw. (siehe oben).
3. Einkauf:
- product_title — Bezeichnung des Produktes,
- start_at — Datum des Einkaufsbeginns,
- finish_at — Datum der Einkaufsbeendigung,
- start_at_ago — Zeit, die nach dem Start vergangen ist,
- finish_at_ago — Zeit, die bis zur Beendigung geblieben ist,
- period_string — Dauer des Zugangs,
- state — Status des Einkaufs (aktueller Zustand),
- link — Link zum Einkauf,
- training_link — Link zum Training (wenn das Produkt mit dem Training verbunden ist),
- training_title — Bezeichnung des Trainings,
- training_teacher_full_name — voller Name des Hauptlehrers im Training,
- training_teacher_avatar_src — Pfad zur Avatardatei des Lehrers.
Der Einkauf hat, genau so wie die Bestellung, ein spezielles Feld “user” (“Benutzer”), in dem man zusätzliche Daten zum Kunden bekommen kann, der die Bestellung erstellt hat: user.first_name usw. (siehe oben).
Bitte beachten Sie: für die korrekte Funktion der Variablen, die sich auf den persönlichen Berater des Benutzers und den Berater der Bestellung beziehen — personal_manager, personal_manager_email, personal_manager_phone und manager, manager_email, manager_phone — müssen die Daten im Abschnitt “Partnerprogramm” angegeben sein.
Sollten im Feld “Absendername” keine Daten angegeben sein, werden die Werte für die Variablen personal_manager und manager aus dem Beraterprofil geholt.
4. Partners des Benutzers:
- partner.uid — Identifikator des Partners,
- partner.first_name — Vorname des Partners,
- partner.last_name — Familienname des Partners,
- partner.real_name — automatisch generierter russischsprachiger Name des Partners,
- partner.email — E-Mail-Adresse des Partners,
- partner.phone — Telefon-Nummer des Partners,
- partner.created_at — Anmeldungsdatum des Partners.
5. Quelle des Benutzers (Session, bei welcher der Benutzer sich angemeldet hat):
- create_session.gcpc — Partner-Code,
- create_session.utm_source — UTM-Tags,
- create_session.utm_medium
- create_session.utm_campaign
- create_session.utm_content
- create_session.utm_term
- create_session.utm_group
- create_session.clickid usw.
Sie können in den Link einen beliebigen Benutzerparameter (Custom-Parameter) einfügen — wenn ein neuer Benutzer diesem Link folgen und sich anmelden wird, wird dieser Parameter in die Quelle des Benutzers eingetragen werden, und es wird möglich sein, ihn über API zu übertragen.
Nach Abruf der URL können Sie die Rückmeldung des Servers erhalten und im zusätzlichen Feld des Benutzers einspeichern, um sie später zu verwenden (z.B. bei zu versendenden E-Mails):
Die Arbeit der Callback-Funktion kann man z.B. über den Service RequestBin testen — erstellen Sie RequestBin und senden Sie an diese Adresse den URL-Abruf mit erforderlichen Parametern.
Darauf werden Sie das Ergebnis mit übermittelten Daten sehen.
Ein Beispiel für die Anforderung im bestellungsorientierten Prozess:
https://requestb.in/yiy4yryi?imya={object.user.first_name}&pochta={object.user.email}&telefon={object.user.phone}&nomer_zakaza={object.number}&soderzhimoe={object.positions}&stoimost={object.cost_money}
Ergebnis:
bitte autorisieren Sie sich