Mit REST-Datendiensten verbinden
Konzept-Informationen
REST (REpresentational State Transfer) ist ein Architekturstil für die Standardisierung der Kommunikation zwischen Computersystemen im Web. Systeme, die mit Rest kompatibel, bzw. „RESTful“ sind, können einfach miteinander kommunizieren.
Sie können Daten aus RESTful-Systemen in Analytics laden, indem Sie Endpunkte treffen, die GET-Methoden verwenden. Andere Typen von HTTP-Verbindungen wie POST und PUT, die dafür vorgesehen sind, Daten an eine Ressource zu senden, werden nicht unterstützt.
Achtung
In Analytics 15 wurde der REST-Konnektor erweitert. Er unterstützt nun mehr Authentifizierungsmethoden und auch die entsprechenden Verbindungsfelder wurden aktualisiert. Skripts aus früheren Versionen werden nach dem Upgrade aber in dieser Version nicht mehr funktionieren. Wenn Sie auf Analytics Version 15 aktualisieren, müssen Sie den Konnektor umkonfigurieren, damit er sich mit einem RESTful-System verbinden kann. Falls Sie in der Robots-App oder in Analytics Exchange frühere Versionen von REST-Konnektor-Skripts ausführen, müssen Sie die umkonfigurierten Skripts nach dem Upgrade auf Analytics 15 hochladen.
Vorbereitungen
Um sich mit einem RESTful-System zu verbinden, brauchen Sie:
- den URI-Endpunkt des RESTful-Systems, mit dem Sie sich verbinden möchten.
- Anmeldeinformationen für das System, falls erforderlich. In einigen Fällen wird es sich hierbei nur um den Benutzernamen und ein Kennwort handeln. Einige Systeme verwenden stärkere Anmeldeinformationen wie OAuth. Wenn Sie nicht sicher sind, welche Anmeldeinformationen Sie benötigen, wenden Sie sich an den Administrator des REST-Diensts in Ihrem Unternehmen. Falls Ihr Administrator Ihnen nicht weiterhelfen kann, fragen Sie die Support Services des Systems, mit dem Sie sich verbinden möchten.
REST-Verbindung erstellen
- Wählen Sie aus dem Analytics-Hauptmenü Importieren > Datenbank und Anwendung.Analytics
- Auf der Registerkarte Neue Verbindungen im Abschnitt ACL-Konnektoren wählen Sie REST.
Tipp
Sie können die Liste verfügbarer Konnektoren filtern, indem Sie in das Feld Verbindungen filtern eine Suchzeichenfolge eingeben. Die Konnektoren sind alphabetisch aufgelistet.
- Im Bereich Datenverbindungseinstellungen rufen Sie die Verbindungseinstellungen auf und klicken unten innerhalb des Bereichs auf Speichern und verbinden.
Sie können den standardmäßigen Verbindungsnamen akzeptieren oder einen neuen Namen eingeben.
Die Verbindung für REST wird in der Registerkarte Bestehende Verbindungen gespeichert. In Zukunft können Sie sich über die gespeicherte Verbindung erneut mit REST verbinden.
Sobald die Verbindung hergestellt ist, wird das Fenster „Datenzugriff“ im Stagingbereich geöffnet und Sie können den Datenimport beginnen. Hilfe für den Datenimport aus REST finden Sie unter Mit dem Fenster „Datenzugriff“ arbeiten.
Verbindungseinstellungen
Grundlegende Einstellungen
Einstellung | Beschreibung | Beispiel |
---|---|---|
URI |
Der Uniform Resource Identifier (URI) oder absolute Dateipfad der RESTful-Ressource. |
https://jsonplaceholder.typicode.com/users/ |
Format | Legt fest, ob die Daten im XML- oder JSON-Format vorliegen. | JSON |
Autorisierungstyp |
Das zur Authentifizierung verwendete Schema. Folgende Authentifizierungsarten stehen zur Verfügung:
|
Keine Authentifizierung |
Schlüssel |
Legt den API-Schlüssel zur Authentifizierung fest. Dieses Feld ist aktiviert, falls Sie im Feld Autorisierungstyp den Wert API-Schlüssel ausgewählt haben. |
|
Wert |
Der Wert in diesem Feld wird mit dem angegebenen API-Schlüssel zur Authentifizierung am Server verwendet. Dieses Feld ist aktiviert, falls Sie im Feld Autorisierungstyp den Wert API-Schlüssel ausgewählt haben. |
|
Hinzufügen an | Gibt an, ob das API-Schlüssel-Wert-Paar an den Anforderungsheader oder die Abfrageparameter angehängt werden soll. | Kopfdaten |
Token |
Legt den Bearertoken für die Authentifizierung mit dem Server fest. Der Token kann ein Zugriffsschlüssel sein, wie der JSON Web Token, der im Anforderungsheader aufgenommen wird. Dieses Feld ist aktiviert, falls Sie im Feld Autorisierungstyp Bearertoken ausgewählt haben. |
|
Benutzer |
Der Benutzername, der für eine Verbindung mit einer REST-Datenquelle verwendet wird. Dieses Feld ist aktiviert, falls Sie im Feld Autorisierungstyp Standardauthentifizierung ausgewählt haben. |
jgibbons |
Kennwort |
Das Kennwort für den Benutzernamen, der für eine Verbindung mit einer REST-Datenquelle verwendet wird. Dieses Feld ist aktiviert, falls Sie im Feld Autorisierungstyp Standardauthentifizierung ausgewählt haben. |
|
URL OAuth-Autorisierung | Die Autorisierungs-URL für den OAuth-Dienst. | https://login.beispiel.com/services/oauth2/autorisieren |
URL OAuth-Zugriffstoken | Die URL, aus welcher der OAuth-Zugriffstoken abgerufen werden soll. In OAuth 1.0 wird der autorisierte Anfragetoken durch den Zugriffstoken dieser URL ausgetauscht. | https://login.beispiel.com/services/oauth2/zugriff |
URL OAuth-Anfrage-Token | Die URL für den Abruf von Anfragetokens. | https://login.example.com/services/oauth2/token |
OAuth-Client-Kennung | Die Client-ID, die Ihnen bei der Registrierung Ihrer REST Datenquelle bei einem OAuth-Autorisierungsserver zugeteilt wurde. | ZYDPLLBWSK3MVQJSIYHB1OR2JXCY0X2C5UJ2QAR2MAAIT5Q |
OAuth-Client-Geheimnis | Der Clientschlüssel, der Ihnen bei der Registrierung Ihrer REST Datenquelle bei einem OAuth-Autorisierungsserver zugeteilt wurde. | |
URL OAuth-Aktualisierungs-Token | Die URL, aus welcher der OAuth-Zugriffstoken aktualisiert werden soll. In OAuth 2.0 wird der Aktualisierungstoken auf dieser URL durch einen neuen Zugriffstoken ausgetauscht, sobald der alte Zugriffstoken abläuft. | https://login.beispiel.com/services/oauth2/aktualisieren |
OAuth-Bewilligungstyp |
Der Bewilligungstyp für den OAuth-Fluss. Folgende Optionen sind verfügbar:
|
CODE |
Rückruf URL | Die OAuth-Rückruf-URL, die bei der Authentifizierung zurückzugeben ist. Dieser Wert muss der Rückruf-URL entsprechen, die Sie in Ihren App-Einstellungen festgelegt haben. | https://www.beispiel.com/api/abrechnung/123 |
Erweiterte Einstellungen
Einstellung | Beschreibung | Beispiel |
---|---|---|
Benutzerdefinierte Kopfzeilen |
Diese Eigenschaft kann auf eine Zeichenfolge mit HTTP-Kopfzeilen eingestellt werden, die an die Kopfzeilen der HTTP-Anforderung anderer Eigenschaften, wie „Content-Type“, „From“ usw. angehängt werden sollen. Die Kopfzeilen müssen das Format „Kopfzeile:Wert“ entsprechend den HTTP-Spezifikationen aufweisen. Jede Kopfzeile sollte eine eigene Zeile aufweisen. Seien Sie mit dieser Option vorsichtig! Bei ungültigen Kopfzeilen können HTTP-Anforderungen scheitern. Diese Eigenschaft ist für eine Feinanpassung hilfreich, um spezialisierte oder nicht standardmäßige APIs zu integrieren. |
Content-Type: text/html; charset=utf-8 Connection: keep-alive |
Benutzerdefinierte URL-Parameter | Die in die Anfrage einzuschließende benutzerdefinierte Abfragezeichenfolge. Die Parameter müssen als Abfragezeichenfolge codiert sein. Die Werte in der Abfragezeichenfolge müssen URL-codiert sein. | Feld1=Wert1&Feld2=Wert2&Feld3=Wert3 |
Zugriffsschlüssel | Ihr AWS-Kontozugriffsschlüssel. Auf diesen Wert können Sie auf Ihrer Seite mit den AWS-Sicherheitsinformationen zugreifen. | AKIAIOSFODNN7EXAMPLE |
Geheimer Schlüssel | Der geheime Schlüssel Ihres AWS-Kontos. Auf diesen Wert können Sie auf Ihrer Seite mit den AWS-Sicherheitsinformationen zugreifen. | wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY |
Region | Die Hosting-Region Ihrer Amazon Web Services. | NORTHERNCALIFORNIA |
Andere |
Ausgeblendete Eigenschaften, die nur in spezifischen Anwendungsfällen erforderlich sind. Normalerweise müssen Sie hier nichts eingeben. Legen Sie mehrere Eigenschaften durch eine mit Semikolons getrennte Liste fest. Konfiguration des Zwischenspeicherns
Integration und Formatierung
OAuth-Eigenschaften
|
CachePartial=True; QueryPassthrough=True |
Datenmodell |
Legt das zu verwendende Datenmodell fest, falls Sie JSON- oder XML-Dokumente analysieren und Metadaten erstellen.
|
Dokument |
Datenquelle | Diese Eigenschaft legt eine URI für den Standort der REST-Ressource fest. | s3://remotePath/file.json |
Arrays vereinfachen |
Standardmäßig werden verschachtelte Arrays als JSON- oder XML-Zeichenfolgen zurückgegeben. Die Eigenschaft „Arrays vereinfachen“ kann verwendet werden, um die Elemente verschachtelter Arrays in eigene Spalten zu vereinfachen. Stellen Sie „Arrays vereinfachen“ auf die Anzahl der Elemente ein, die Sie aus verschachtelten Arrays zurückgeben möchten. Wenn Sie „Arrays vereinfachen“ auf -1 einstellen, werden alle Elemente verschachtelter Arrays vereinfacht. |
1 |
Objekte vereinfachen | Stellen Sie „Objekte vereinfachen“ auf „Wahr“ ein, um Objekteigenschaften in eigene Spalten zu vereinfachen. Andernfalls werden in Arrays verschachtelte Objekte als JSON- oder XML-Zeichenfolgen zurückgegeben. | wahr |
JSON-Format | Legt das Format des JSON-Dokuments fest. | JSON |
Schemadateien erstellen |
Gibt an, ob eine Schemadatei (RSD) aus dem analysierten Dokument erstellt werden soll.
Diese Eigenschaft wird zusammen mit „Format“, „URI“, „XPath“ und „Speicherort“ verwendet. |
Nie |
XPath |
Der XPath eines Elements, das auf derselben Höhe im XML-/JSON-Dokument wiederholt wird (wird verwendet, um das Dokument in mehrere Zeilen aufzuteilen). Mehrere Pfade können über eine durch Semikolons getrennte Liste festgelegt werden. Die Einstellung „Datenmodell“ ermöglicht Ihnen zu konfigurieren, wie XPath-Werte zur Erstellung von Tabellen und der Anzeige von Daten verwendet werden. |
$.store.book[0].title |
Kerberos-Keytab-Datei | Die Keytab-Datei enthält Paare aus Kerberos-Prinzipalen und verschlüsselten Schlüsseln. | /Pfad_zur_Keytab-Datei/Dateiname.keytab |
Kerberos-SPN | Wenn der Dienstprinzipalname (SPN) auf dem Kerberos-Domänencontroller nicht mit der URL identisch ist, mit der Sie sich authentifizieren, verwenden Sie diese Eigenschaft, um den SPN festzulegen. | HTTP/TimeOffWebPortal |
Untersuchungstiefe von Zeilen |
Die Anzahl der zu scannenden Zeilen, wenn die Spalten der Tabelle dynamisch festgestellt werden. Spalten werden dynamisch festgestellt, falls eine Schemadatei (RSD) für die Tabelle nicht verfügbar ist, beispielsweise wenn „Schemadateien erstellen“ verwendet wird. Höhere Werte ergeben eine längere Anfrage, werden jedoch genauer sein. Wenn Sie diesen Wert auf „0“ (Null) einstellen, wird das gesamte Dokument analysiert. |
100 |
SSL-Serverzertifikat |
Wenn Sie eine TLS/SSL-Verbindung verwenden, kann diese Eigenschaft verwendet werden, um das TLS/SSL-Zertifikat festzulegen, das durch den Server akzeptiert wird. Andere Zertifikate, denen der Computer nicht vertraut, werden abgelehnt. Bei einer fehlenden Angabe wird jedes Zertifikat akzeptiert, dem der Computer vertraut. Verwenden Sie '*', falls Sie alle Zertifikate akzeptieren möchten (aus Sicherheitsgründen nicht empfohlen).
|
|
Grenze der Schlüsselgröße |
Die maximale Länge einer Primärschlüsselspalte. In einigen ODBC-Tools darf die Länge der Primärschlüsselspalte nicht länger als ein spezifischer Wert sein. Durch diese Eigenschaft überschreibt der ODBC-Treiber die gemeldete Länge aller Primärschlüsselspalten. Dies ist besonders hilfreich, wenn der ODBC-Treiber als eine verknüpfte Microsoft-Access-Datenquelle verwendet wird. Wenn „Grenze der Schlüsselgröße“ auf Null eingestellt wird, wird die ursprüngliche Schlüssellänge wiederhergestellt. |
255 |
Long Varchar zuordnen |
Diese Eigenschaft kontrolliert, ob eine Spalte als SQL_LONGVARCHAR zurückgegeben wird. Einige Anwendungen verlangen, dass alle Textdaten, die eine bestimmte Zeichenanzahl überschreiten, als SQL_LONGVARCHAR gemeldet werden. Verwenden Sie diese Eigenschaft, um alle Spalten über einer bestimmten Größe so zuzuordnen, dass sie als SQL_LONGVARCHAR statt SQL_VARCHAR gemeldet werden. |
-1 |
WVarchar zuordnen | Diese Eigenschaft steuert, ob Zeichenfolgentypen als SQL_WVARCHAR statt SQL_VARCHAR zugeordnet werden. Standardmäßig ist diese Option aktiviert. | wahr |
Pseudospalten |
Gibt an, ob Pseudospalten der Tabelle ebenfalls als Spalten hinzugefügt werden sollen. Diese Einstellung ist besonders im Entity Framework hilfreich, das Ihnen nicht ermöglicht, einen Wert für eine Pseudospalte anzugeben, solange sie keine Tabellenspalte ist. Sie können das Sternchen („*“) verwenden, um alle Tabellen und alle Spalten einzuschließen. Beispiel: „*=*“. |
Tabelle1=Spalte1; Tabelle1=Spalte2; Tabelle2=Spalte3 |
Bezeichner in Großbuchstaben | Alle Bezeichner in Großbuchstaben melden. Für Oracle-Datenbanken ist dies die Standardeinstellung. Sie ermöglicht Ihnen eine bessere Integration mit Oracle-Tools, wie beispielsweise dem Oracle Database Gateway. | falsch |
Authentifizierung für Proxy |
Dieser Wert legt den Authentifizierungstyp fest, der für die Authentifizierung mit dem HTTP-Proxy (angegeben durch „Proxy-Server“ und „Proxy-Port“) zu verwenden ist. Beachten Sie, dass der Treiber standardmäßig die Proxy-Einstellungen des Systems verwenden wird, sodass keine weitere Konfiguration notwendig ist. Wenn Sie sich mit einem anderen Proxy verbinden möchten, müssen Sie zusätzlich zur Angabe von „Proxy-Server“ und „Proxy-Port“ den Wert von „Autom. Proxy-Erkennung“ auf „falsch“ setzen. Zur Authentifizierung stellen Sie „Authentifizierung für Proxy“ ein und geben bei Bedarf „Proxy-Benutzer“ und „Proxy-Kennwort“ an. Es gibt folgende Authentifizierungstypen:
|
BASIC |
Autom. Proxy-Erkennung | Gibt an, ob die Proxy-Einstellungen des Systems verwendet werden sollen. Stellen Sie „Autom. Proxy-Erkennung“ auf FALSE ein, falls Sie benutzerdefinierte Proxy-Einstellungen verwenden möchten. Dies hat Vorrang gegenüber anderen Proxy-Einstellungen. | wahr |
Proxy-Benutzer | Ein Benutzername kann für die Authentifizierung mit dem unter „Proxy-Server“ angegebenen Proxy verwendet werden. | jgibbons |
Proxy-Kennwort | Ein Kennwort kann für die Authentifizierung mit dem unter „Proxy-Server“ angegebenen Proxy verwendet werden. | UsaTelefon897Batterien!Tokio |
Proxy-Server | Der Hostname oder die IP-Adresse eines Proxy, durch den der HTTP-Datenverkehr geleitet werden soll. | 192.168.1.100 |
Proxy-Port | Der TCP-Port, den der unter „Proxy-Server“ angegebene Proxy verwendet. | 80 |
Proxy SSL-Typ |
Der SSL-Typ, der für die Verbindung mit dem unter „Proxy-Server“ angegebenen Proxy zu verwenden ist.
|
AUTO |
Proxy-Ausnahme |
Eine durch Semikolons getrennte Liste von Hosts oder IPs, die von einer Verbindung über den Proxy-Server ausgenommen sind. Der Treiber wird standardmäßig die Proxy-Einstellungen des Systems verwenden, sodass keine weitere Konfiguration notwendig ist. Wenn Sie explizit Proxy-Ausnahmen für diese Verbindung konfigurieren möchten, müssen Sie „Proxy-Server“ und „Proxy-Port“ konfigurieren und den Wert von „Autom. Proxy-Erkennung“ auf „falsch“ setzen. Zur Authentifizierung stellen Sie „Authentifizierung für Proxy“ ein und geben bei Bedarf „Proxy-Benutzer“ und „Proxy-Kennwort“ an. |
172.16.254.1;192.0.2.1 |