Ein Guide zum Zugang von ActiveTrail’s RESTful API

Während ActiveTrail den Nutzern einen einfach zu nutzenden und effektiven Online Arbeitsbereich bietet, empfinden  manche Unternehmen es als einfacher mit ActiveTrail durch ihr eigenes System zu arbeiten, indem sie ein Application Programming Interface (API) statt der Standard ActiveTrail User Interface (UI) nutzen. Zudem gibt es einige Operationen die eine Integration mit externen Systemen erfordern, wie Kundenwebseiten, CRM (Customer Relationship Management) Systeme und andere. Das API Interface ermöglicht solche Integrationen, sodass Programmierer Verfahren, wie Datensynchronisierungen, auch aus der Ferne ausführen können.

RESTful API gibt Ihnen die Option alle verfügbaren Aktionen im ActiveTrail System durch das Maschineninterface auszuführen.

Wie logge ich mich auf RESTful API ein?

Um RESTful API nutzen zu können, müssen Sie sich an der oberen Seite der Menüleiste einloggen. Gehen Sie zu:

Mehr >> Integrationen >> API >> Apps

RESTful API

Unter Einstellungen, im Reiter „API Apps“, können Sie einen Zugangs-Token eingeben, durch welchen Sie sich mit dem ActiveTrail System verbinden können.

Um einen Zugangs-Token zu erstellen, klicken Sie auf den Button „Neu“, was das “API App” Fenster öffnen wird, wo Sie die Details zur Generierung eines Tokens eingeben können.

API App

ActiveTrail gibt Ihnen die Möglichkeit so viele Zugangs-Token wie erforderlich zu erstellen, indem jeder Token für ein unterschiedliches System definiert ist. Jeder Token kann separat storniert werden, indem Sie den Zugang zu einem System entfernen, ohne dass der Betrieb mit anderen Systemen beeinträchtigt wird.

Für jeden ausgegebenen Zugangs-Token können Sie auch eine einzige oder eine Reihe an autorisierten IP Adressen definieren.

Nachdem Sie die Informationen des Zugangs-Token eingegeben haben, klicken Sie „Speichern“. Dies generiert den tatsächlichen Token und der neue Token erscheint auf der Liste im „API Apps“ Fenster.

API Apps

Webhooks

Unter „Einstellungen“, rechts neben dem Reiter “API Apps” ist der Reiter „Events“.  Die RESTful API’s Dokumentation bezieht sich auf diese Events als Webhooks.  Im System repräsentieren sie Updates zu Kontaktinformationen.

Diese Updates können manuell ausgeführt werden, in Fällen in denen Sie solch Änderungen direkt im ActiveTrail System durchführen können, oder automatisch, wenn sich jemand durch das Registrierungsformular registriert, wenn ein bestehender Nutzer seine Kontaktinformationen extern ändert (z.B. in einem „Informationen aktualisieren“ Formular auf einer Dritten Webseite), und mehr.

Damit ActiveTrail sich mit Ihrem System verbinden kann, müssen Sie Ihre API Webadresse im URL Feld für da gewünschte Event eingeben. Bitte geben Sie die vollständige URL ein, inklusive “http://”, z.B. “https://www.activetrail.com”.

„Parameter“ – geben Sie Parameter basierend auf ihrem eigenen API ein, die mit jedem Aufruf Ihres API gesendet werden.

„Test“ – führen Sie einen Test aus um zu sehen, ob Ihre Applikation Anrufe von ActiveTrail empfängt.

Test

Es gibt eine Reihe an Events, die den Webhook triggern und ActiveTrail zu einem Anruf Ihres API führt. Um diese Events einzurichten, geben Sie Ihre API URL in dem entsprechenden Feld ein. Die Hauptevents sind:

  1. Kontaktänderungen – Kommt vor, wenn eine Änderung an einer Kontaktinformation außerhalb der ActiveTrail Benutzeroberfläche ausgeführt wurde, z.B. als Ergebnis eines externen Updates (via Registrierungsformular, durch ein API Update, durch eine Landingpage, oder einen anderen, nicht-manuellen Weg).
  1. Manuelle Kontaktänderungen – wenn eine manuelle Änderung an den Kontaktinformationen durch die ActiveTrail Web App vorgenommen wurde. (das ActiveTrail User Interface).

Zusätzliche, im System verfügbar Events sind:

  • Automatisierungsschritt
  • Kontakt ist einer Gruppe beigetreten
  • Kontakt wurde aus einer Gruppe entfernt
  • Kontakt hat sich abgemeldet
  • Kontakt aktualisiert

Online Dokumentationsansatz

Das RESTful API ist direkt über das Weg zugänglich (nicht nur durch die ActiveTrail Web App) und wir haben eine Online Dokumentation auf unserer Webseite veröffentlicht, welche die Funktion und das Vorgehen deutlich beschreibt!

API Documentation

Jede durch ActiveTrail’s User Interface vervollständigte Aufgabe  kann auch durch API ausgeführt werden. Es stehen Ihnen alle Systemfunktionen zur Verfügung, inklusive Automatisierungen.

Sehen Sie hier die Dokumentation und beginnen Sie zu arbeiten!

Zusätzliche Reiter

Sie finden zwei weitere Reiter in Bezug auf Integrationen mit externen Systemen im Fenster Einstellungen:

Facebook Leads – Erlaubt Ihnen das Einloggen in Ihr Facebook Konto innerhalb des ActiveTrail Systems und die Auswahl von Facebook Leads, die Sie gerne mit Ihren ActiveTrail Kontakten synchronisieren möchten.

Zapier – Zapier ist eine webbasierte Applikation, durch welche Sie Applikationen wie ActiveTrail auf API Level in andere Applikationen integrieren können, wie Ihrem  CRM System.  Wenn Sie solche Integrationen ausführen möchten, aber keine Softwareentwickler oder Zugang zu Programmierern haben, dann ist dies eine Option für Sie.

Hätten Sie gerne weitere Informationen zu RESTful API?

Kontaktieren Sie unser Supportteam +972 3 688-5050 oder klicken Sie hier um uns zu kontaktieren.

Ein Kostenloses Konto Öffnen

Keine Kreditkarte notwendig.

 

Brauchen Sie weitere Hilfe? Unser Support Team ist von Sonntag - Freitag, 9:00 - 18:00 Uhr unter der Rufnummer 1-212-203-0074, im Chat oder per Email verfügbar.