Verwenden Sie den REST-API-Connector, um eine Verbindung zu REST-konformen Salesforce-Services herzustellen. Nur die REST-APIs Query und Reports werden unterstützt.
Vorbereitende Schritte
Wichtig: Der REST-API-Connector wird nur auf Konnektivität zur genannten REST-API für Salesforce überprüft. Der Connector wird mit eingeschränktem Zugriff auf Salesforce-Daten getestet. Das in diesem Abschnitt bereitgestellte Umsetzungsscript gilt nur für die APIs Query und Reports und wurde für andere Salesforce-APIs nicht verifiziert. Wenden Sie sich an Ihren Ansprechpartner bei IBM Professional
Services, wenn Sie Unterstützung für andere
Salesforce-APIs
benötigen.
- Stellen Sie sicher, dass Sie über ein Salesforce Developer Edition-Konto verfügen.
- Im Salesforce Developer Edition-Konto müssen Sie eine verbundene App erstellen, die für eine Integration zwischen Cloud Application Business Insights und Salesforce sorgt, die OAuth-Einstellungen aktiviert und einen OAuth-Autorisierungsablauf anwendet, um den Zugriff auf die REST-APIs zu erteilen.
Weitere Informationen finden Sie unter https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_oauth_and_connected_apps.htm.
- Sie müssen über den Konsumentenschlüssel (Consumer Key), das Konsumentengeheimnis
(Consumer Secret) und das Sicherheitstoken (Security Token) verfügen.
Weitere Informationen finden Sie unter https://help.salesforce.com/articleView?id=user_security_token.htm&type=5.
- Stellen Sie sicher, dass der
Salesforce-REST-API-Service,
zu dem Sie eine Verbindung herstellen wollen, betriebsbereit und aktiv ist.
- Sie können Daten nur für die REST-APIs
Query und
Reports abrufen.
Weitere Informationen zu URI-Formaten finden Sie unter https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_query.htm und https://developer.salesforce.com/docs/atlas.en-us.224.0.api_analytics.meta/api_analytics/intro_build_reports_dashboards_url.htm.
- Erstellen Sie eine Umsetzungsscriptdatei. Die Scriptdatei enthält die Logik, die
die JSON-Antwort in ein kompatibles Format umsetzt, das im Dashboard angezeigt werden kann.
Verwenden Sie
die folgende Beispieldatei, um eine neue Scriptdatei für die Antwortumsetzung zu erstellen:
- Beispielscriptdatei: restapi_sample_response_t12n.txt
- Beispieldateiposition:
$installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n
Dabei ist installationsverzeichnis das Verzeichnis, in dem die Anwendung
installiert wurde. Wenn Sie bei der Installation kein anderes Installationsverzeichnis angegeben
haben, befindet sich die Anwendung standardmäßig im Ordner /opt/icabi.
Die
von Ihnen erstellte Antwortumsetzungsdatei muss die Namenserweiterung .js aufweisen
und muss sich an der gleichen Speicherposition wie die Beispieldatei befinden. Der Dateiname
darf nicht länger als 100 Zeichen sein. Sie müssen den Namen dieser Antwortumsetzungsdatei
im Feld Name des Scripts für die Antwortumwandlung eingeben, wie in den
Prozedurschritten im weiteren Verlauf dieses Abschnitts beschrieben.
- Wenn Sie für die Beispielanforderung angepasste Header bereitstellen müssen, müssen Sie sicherstellen, dass
Ihnen diese Informationen zur Verfügung stehen. Angepasste Header sind Anforderungsheader, die zum Abrufen von REST-API-Informationen von
einem Web-Service benötigt werden, wie beispielsweise Anforderungsheader für die Autorisierung oder
Anforderungsheader 'Accept-Charset'. Anforderungsheader für die Autorisierung enthalten
Berechtigungsinformationen, die für den Web-Service erforderlich sind. 'Accept-Charset'
gibt die zulässigen Datenzeichen an, die in der Antwort enthalten sein müssen.
Informationen zu diesem Vorgang
Sie können die tokenbasierte Authentifizierung verwenden, um eine Verbindung zum Salesforce-REST-API-Service herzustellen.Bei der tokenbasierten Authentifizierung wird ein Authentifizierungstoken generiert, das zusammen
mit der HTTPS-Anforderung zum Abrufen von Daten übergeben wird. Nach der Authentifizierung des Benutzers generiert der Authentifizierungsserver des REST-API-Service ein Authentifizierungstoken und sendet dieses Token an Cloud Application Business Insights. Dieses codierte Token wird in der von Cloud Application Business Insights gesendeten HTTPS-Anforderung verwendet, mit der die Verbindung zum REST-API-Service hergestellt wird und die Daten abgerufen werden.
Vorgehensweise
Umsetzungsscriptdatei erstellen.
- Führen Sie die folgenden Schritte aus, um eine Umsetzungsscriptdatei zu erstellen:
- Wechseln Sie in das folgende Verzeichnis, in dem sich die
Beispielscriptdatei restapi_sample_response_t12n.txt für die
Umsetzung befindet:
$installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n
- Erstellen Sie eine Kopie dieser Datei, benennen Sie die Datei um und öffnen
Sie diese Datei in einem beliebigen Texteditor.
- Löschen Sie den Inhalt der Datei, kopieren Sie das folgende Script und
fügen Sie es in die Datei ein:
var input;
var finalJson;
var output;
// Parse the input in JSON format
input = JSON.parse(transformationInput);
records=input['records']
output = JSON.stringify(records);
- Speichern Sie die Datei als JavaScript-Datei mit der Dateierweiterung .js.
Die Scriptdatei für die Umsetzung wurde erstellt.
REST-konforme
Salesforce-Web-Services
mithilfe des Connectors REST API hinzufügen
- Führen Sie die folgenden Schritte aus, um REST-konforme Salesforce-Web-Services mithilfe des
REST-API-Connectors hinzuzufügen:
- Öffnen Sie Dashboard Designer.
- Rufen Sie im Navigationsbereich auf.
- Klicken Sie auf der Seite 'Alle Connectorquellen' auf Quelle hinzufügen.
Das Fenster Connectorquelle hinzufügen wird angezeigt.
- Wählen Sie in der Liste Connectortyp den Connector REST-API
aus.
- Geben Sie in das Feld Name der Connectorquelle einen Namen für die Quelle ein.
Der Quellenname kann alphanumerische Zeichen und Unterstreichungszeichen enthalten.
- Geben Sie in das Feld Endpunkt-URL die URL-Details für
den Web-Service in einem der folgenden Formate ein:
- https://server-IP_oder_hostname:port
- http://server-IP_oder_hostname:port
Dabei gilt Folgendes:
- server-IP_oder_hostname ist die IP-Adresse oder der Hostname des Servers,
auf dem der Web-Service gehostet wird.
- port ist der Standardport des Web-Service. Die Standardportnummer für
http-URLs
ist 80. Die Standardportnummer für https-URLs ist
443.
- Geben Sie den Namen der Umsetzungsscriptdatei im Feld Name des
Scripts für die Antwortumwandlung ein, wenn Sie die Antwort umsetzen wollen.
- Wählen Sie in der Liste Authentifizierungstyp die Option
Tokenbasierte Authentifizierung aus und führen Sie die folgenden Schritte aus:
- Geben Sie in das Feld Benutzername einen Benutzernamen ein, der bei der
Konfiguration des REST-API-Service verwendet wird.
- Geben Sie in das Feld Kennwort ein Kennwort ein, das bei der Konfiguration
des REST-API-Service verwendet wird. Hängen Sie das Sicherheitstoken an das Kennwort an.
- Klicken Sie auf Weiter.
- Geben Sie in das Feld Authentifizierungs- oder Anmelde-URL die URL des
Authentifizierungsservers für den REST-API-Web-Service ein. Diese
Authentifizierungs-URL wird vom Provider des REST-API-Web-Service bereitgestellt.
Beispiel:
https://ap17.salesforce.com/services/oauth2/token
- Wählen Sie in der Liste Tokenanforderungsmethode die Methode
POST aus.
- Geben Sie in das Feld Hauptteil der Tokenanforderung einen
Anforderungshauptteil ein. Geben Sie neben den Platzhaltern
{USERNAME}
und {PASSWORD} auch den Konsumentenschlüssel und das
Konsumentengeheimnis der verbundenen App ein.
Beispiel:
grant_type=password
&client_id=enter consumer key of your connected app
&client_secret=enter consumer secret of your connected app
&username={USERNAME}
&password={PASSWORD}
Die Platzhalter für den Benutzernamen und das Kennwort werden intern durch den tatsächlichen Benutzernamen und das tatsächliche Kennwort ersetzt, die Sie in Schritt a und Schritt b eingegeben haben.
- Wählen Sie in der Liste Ablaufzeit des Tokens (in Sekunden)
die Ablaufzeit des Tokens aus.
Nach dem ausgewählten Zeitintervall wird automatisch ein neues Token generiert.
- Geben Sie in das Feld Name des Authentifizierungsheaders der
API-Anforderung den Namen des Anforderungsheaders für den
Authentifizierungsserver ein. Dieser Name des Authentifizierungsheaders wird vom Provider
des REST-API-Web-Service bereitgestellt.
Beispiel: Authorization
- Geben Sie in das Feld Wert des Authentifizierungsheaders der
API-Anforderung den Wert des Anforderungsheaders für den
Authentifizierungsserver ein. Verwenden Sie dabei den Platzhalter
{TOKEN}.
Beispiel: Bearer {TOKEN}
Dieser Platzhalter wird intern durch das tatsächliche vom System generierte
Authentifizierungstoken ersetzt. Dieser Wert des Authentifizierungsheaders wird vom Provider
des REST-API-Web-Service bereitgestellt.
- Führen Sie im Abschnitt Angepasste Header für
Tokenanforderung die folgenden Schritte aus:
- Geben Sie in das Feld Name den Namen des Tokenanforderungsheaders ein, der vom Provider des
REST-API-Web-Service bereitgestellt wird.
Beispiel: Content-Type
- Geben Sie in das Feld Wert den Wert für den Tokenanforderungsheader ein, der vom Provider des
REST-API-Web-Service bereitgestellt wird.
Beispiel:
application/x-www-form-urlencoded
Wenn Sie weitere Tokenanforderungsheader hinzufügen wollen, können Sie auf
Weiteren hinzufügen klicken und die vorherigen Schritte
wiederholen.
- Klicken Sie auf Weiter.
- Wählen Sie in der Liste Methode eine Methode aus und führen Sie
basierend auf der ausgewählten Methode einen der folgenden Schritte aus:
- Geben Sie für die Methode GET im Feld URI den URI
(Uniform Resource Identifier) für die Quelle ein.
- Geben Sie für die Methode POST im Feld URI den URI
für die Quelle ein und im Feld Anforderungshauptteil die POST-Anforderung.
Beispiel-URI für die Methode GET:
/services/data/v48.0/query/?q=SELECT+Name,Type,Phone,Industry+FROM+Account
Beispiel für URI und Anforderungshauptteil für die Methode POST:
URI:
http://ap17.salesforce.com/services/data/v48.0/sobjects/account
Anforderungshauptteil:
{
"Name" : "Petroleum",
"Type": "Customer - Direct",
"Phone": "+11 111 1111111",
"Industry": "Energy"
}
- Führen Sie unter Angepasste Header die folgenden Schritte aus:
- Klicken Sie auf Verbindung testen, um sicherzustellen, dass die
Verbindung zur Datenquelle erfolgreich war.
Wenn die Quellendetails und die Beispielanforderung gültig und vollständig sind, wird eine
Nachricht angezeigt, die besagt, dass die Verbindung erfolgreich hergestellt wurde. Wird eine
Nachricht ausgegeben, die besagt, dass ein Verbindungsfehler aufgetreten ist, müssen Sie die in der
Nachricht beschriebenen Fehler beheben und die Verbindung erneut testen.
Anmerkung: Auch wenn die Quellendetails gültig sind, kann es vorkommen, dass eine
Verbindungsfehlernachricht angezeigt wird. Dies ist der Fall, wenn für die Beispielanforderung eine
ungültige Antwort empfangen wird.
- Klicken Sie auf Speichern.
Ergebnisse
Auf der Seite
Alle Connectorquellen werden die folgenden Details für jede Connectorquelle angezeigt:
- Name der Connectorquelle
- Connectortyp
- Datum und Uhrzeit der erstmaligen Erstellung der Connectorquelle sowie der Benutzername des Benutzers, der die Quelle anfänglich erstellt hat.
- Datum und Uhrzeit der letzten Änderung der Connectorquelle sowie der Benutzername des Benutzers, der die Connectorquelle zuletzt geändert hat. Es wird nur der neueste Datensatz angezeigt.
Der REST-API-Service wird hinzugefügt und kann verwendet werden, um angepasste Datendefinitionen zu erstellen.