1. Home
  2. Data Services
  3. REST-Report API
  4. Zugang & Nutzung

Zugang & Nutzung

Zweck der REST-Report API

Die etracker REST-Report API v6 ist eine Schnittstelle, die Sie nutzen können, um eigene Anwendungen mit den Daten aus etracker zu entwickeln oder um diese Daten im eigenen Unternehmen weiter zu verarbeiten.

Zugang zur REST-Report API

Um die etracker REST-Report API nutzen zu können, müssen Sie sich bei etracker anmelden. Sie hinterlegen bei unserem Support eine gültige E-Mail-Adresse und erhalten einen sogenannten ‚Entwickler-Token‘ (developer token). Mit der E-Mail-Adresse und dem Entwickler-Token sind Sie dann berechtigt, über die etracker REST-Report API auf Daten aus etracker zuzugreifen.

Hinweis:
Um Ihre Privatsphäre zu schützen und eine unberechtigte Benutzung der etracker Web Services API zu vermeiden, sollten Sie den Entwickler-Token in jedem Fall geheim halten.

Über Ihre gültige E-Mail-Adresse können Sie zeitnah über Weiterentwicklungen und Änderungen der etracker REST-Report API auf dem Laufenden gehalten werden. Bei der Anmeldung können Sie angeben, ob Sie regelmäßig Informationen zur etracker API haben möchten oder nicht.

Die E-Mail-Adresse und der Entwickler-Token sind in jeder Web Service Anfrage (Request) innerhalb des Anfrage-Headers mitzuliefern.

Hinweis:
Wenn Sie die etracker Analytics Enterprise Edition haben, können Sie die REST-Report API kostenlos nutzen. In allen anderen Fällen können Sie die Nutzung der REST-Report API gegen einen Aufpreis dazu buchen. Preise nennen wir Ihnen gerne auf Anfrage. Wenden Sie sich bei Bedarf an Ihren etracker Berater oder den Support.

Nutzung der REST-Report API

Um die Nutzung der etracker REST-Report API zu erleichtern, sollten Sie einen REST-Client erstellen. Die Ausgestaltung des Clients hängt von der eingesetzten Programmiersprache ab. Der Client sendet die Anfragen an den Service und gibt definierte Werte zurück, die anschließend weiterverarbeitet werden können.

Außer einer Entwicklungsumgebung für die verwendete Programmiersprache benötigen Sie keinerlei weitere Software oder Installation auf Ihrem System.

Aufbau der URL für die REST-Calls

Die etracker REST API nimmt ausschließlich Calls über https entgegen. Alle in diesem Dokument beschriebenen Calls sind GET-Abfragen. Die Adresse des etracker REST-Servers ist ws.etracker.com und die Basis-URI für alle Abfragen ist /api/v6. Die REST-Calls können mit oder ohne Parameter geschrieben sein. REST-Calls zum Abrufen von Report-Daten ohne Parameter werden nicht empfohlen, da unter Umständen sehr große Datenmengen zrückgegeben werden. Bei den Parametern wird nicht nach Groß- und Kleinschreibung unterschieden. Beispiel mit Parametern zum Abrufen von Daten aus dem Report ‚Gerät‘:

https://ws.etracker.com/api/v6/report/EADeviceType/data?limit=401

Das gleiche Beispiel ohne Parameter (nicht empfohlen):

https://ws.etracker.com/api/v6/report/EADeviceType/data

Rückgabewerte

Das Format der Rückgabewerte von etracker REST API Abfragen ist entweder JSON oder CSV. CSV wird nur bei der Abfrage von Report-Daten unterstützt und kommt nur dann zurück, wenn das Format explizit abgefragt wird. Bei den JSON-Rückgaben kommt immer ein JSON-Array oder -Objekt zurück, auch dann, wenn nur ein Wert zurückgegeben wird. Die etracker REST-Report API arbeitet mit der Kodierung UTF-8. Alle Daten, welche die API liefert oder entgegennimmt, müssen in UTF-8 kodiert sein. Sonderzeichen wie Umlaute werden teilweise in Form von Javascript Escape-Sequenzen zurückgegeben. Ein ‚ä‘-Zeichen wäre dann z. B. ‚\u00e4‘ in den Rückgabedaten. Die meisten JSON-Parser wandeln solche Escape-Sequenzen automatisch in Buchstaben um.

Authentifizierung

Jede REST-Report-Anfrage muss mit einem Header versehen werden. Dieser dient dazu, die Authentifizierung an der API vorzunehmen.

Folgende Header-Informationen sind zwingend notwendig:

  • X-ET-email: Dieses Header-Element enthält die E-Mail-Adresse des Entwicklers, der Zugriff auf die API hat.
  • X-ET-developerToken: Dieses Header-Element enthält den Entwickler-Token, den Sie beim etracker Support anfordern können.
  • X-ET-accountId: Dieses Element enthält die etracker Account-Id. Für die Authentifizierung kann auch ein etracker Mitbenutzer angegeben werden (Format: #accountId#-#subuserId#)
  • X-ET-password: Dieses Element enthält das Passwort des etracker Accounts.

Beispiel:

X-ET-email=qa@etracker.com X-ET-developerToken=ab7891ca89d9b4d10dc1703a7f0214256babe6c9 X-ET-accountId=18854 X-ET-password=demo

Im Firefox können Sie auch Modify Headers (https://addons.mozilla.org/en-us/firefox/addon/modify-headers/) verwenden, um diese Header mitzusenden.