Salesforce-Konnektor

Einführung

Salesforce ist eine cloudbasierte CRM-Softwareplattform, die in verschiedenen Anwendungsbereichen eingesetzt wird – von der Nachverfolgung von Vertriebsleads bis hin zur Auftrags- und Bestandsverwaltung.

Zweck

Dieses Dokument beschreibt den Salesforce-REST-API-Konnektor, der in der Tulip-Bibliothek zu finden ist. Nach der Konfiguration können diese Konnektorfunktionen verwendet werden, um Salesforce-Daten aus einer Tulip-App abzurufen, abzufragen und zu ändern.

API-Dokumentation

Die Dokumentation zur Salesforce-REST-API finden Sie hier. Beachten Sie, dass einige der in diesem Artikel beschriebenen Connector-Funktionen Abfragen mithilfe von SOQL (Salesforce Object Query Language) durchführen, deren vollständige Syntax hier dokumentiert ist.

Erstkonfiguration

Die Salesforce-API-Authentifizierung folgt den OAuth 2.0-Standards. Der folgende Prozess beschreibt, wie ein Refresh-Token generiert wird, das anschließend von jeder Tulip-App verwendet wird, um das Zugriffstoken abzurufen, das für eine erfolgreiche Verbindung zu Salesforce erforderlich ist.

1. Erstellen Sie eine verbundene App in Salesforce. Navigieren Sie dazu im Salesforce-Bereich zu „Setup“. Gehen Sie anschließend zu PLATFORM-TOOLS >> Apps >> Verbundene Apps >> Verbundene Apps verwalten.
2. Erstellen Sie eine neue verbundene App. Geben Sie dabei Folgendes an: a. alle von Ihrer Anwendung benötigten Bereiche, achten Sie jedoch darauf, „refresh_token“ einzubeziehen. b. Wählen Sie „OAuth-Einstellungen aktivieren“ und geben Sie als Callback-URL „https://login.salesforce.com/services/oauth2/success“ ein.
3. Klicken Sie anschließend auf „Verbraucher-Details verwalten“, um Ihren „Verbraucherschlüssel“ und Ihr „Verbrauchersekret“ anzuzeigen. Diese werden später benötigt.
4. Öffnen Sienun in Tulip die URL „ Connector Function [Setup] Get Auth Code“. Kopieren Sie den in Schritt 3 oben generierten „Consumer Key“ und fügen Sie ihn als Abfrageparameter „client_id“ ein.
5. Führen Sie den „ Connector Function “ aus.
6. Beachten Sie, dass als „Output“ des Connectors eine URL generiert wurde. Fügen Sie diese URL in Ihr Browserfenster ein.
7. Führen Sie die angezeigte Authentifizierungsabfrage durch, um Tulip erfolgreich für die Interaktion mit Ihrer Salesforce-Instanz zu autorisieren.
8. Bei Erfolg sollte Ihr Browser auf eine neue Seite mit der Bezeichnung „Remote Access Application Authorization“ weiterleiten. Der Autorisierungscode ist in der URL dieser Seite zu finden. In der URL https://login.salesforce.com/services/oauth2/success?code=asdf1234 lautet der Autorisierungscode beispielsweise asdf1234.
9. Speichern Sie diesen Autorisierungscode. Beachten Sie, dass der Code mit zwei Gleichheitszeichen enden muss: ==. Falls der Code mit %3D%3D endet, entfernen Sie diese Zeichen und ersetzen Sie sie durch ==.
10. Navigieren Sie zum [Setup] „Get Refresh Token“ von Tulip Connector Function. Fügen Sie in die Abfrageparameter alle oben gesammelten Informationen ein:
    • grant_type= authorization_code
    • redirect_uri= https://login.salesforce.com/services/oauth2/success
    • client_id= der Consumer-Schlüssel aus Schritt 3 oben
    • client_secret= das Consumer-Secret aus Schritt 3 oben
    • code= der Autorisierungscode aus Schritt 9 oben
11. Führen Sie diesen Connector aus und speichern Sie den refresh_token, der in der Antwort angezeigt wird.
12. Navigieren Sie abschließend zur Seite [Auth] „Get Access Token“ Connector Function. Geben Sie die folgenden Abfrageparameter ein:
    • grant_type= authorization_code
    • client_id= der Consumer-Schlüssel aus Schritt 3 oben
    • client_secret= das Consumer-Secret aus Schritt 3 oben
    • refresh_token= das Refresh-Token aus Schritt 10 oben
13. Führen Sie den Connector aus. Beachten Sie, dass die Antwort ein „access_token“ enthält, das als Ausgabe zugeordnet wird. Speichern Sie den Connector, um das Refresh-Token zu speichern

Sobald diese Funktion in der Lage ist, ein `` access_token zu generieren, ist die Einrichtung abgeschlossen! Dieses access_token `` kann nun in jedem nachfolgenden „ Connector Function “ verwendet werden, solange es die in Schritt 2 konfigurierten Timeout-Einstellungen zulassen.

Tulip-Verbindungsdetails

Damit Ihre Connectoren mit Salesforce kommunizieren können, geben Sie die Subdomain Ihrer Salesforce-Instanz als „Standard-Subdomain“ unter den Verbindungsdetails des Connectors ein. Wenn sich die Salesforce-Instanz beispielsweise unter sample.my.salesforce.com befindet, sollte die Standard-Subdomain sample.my lauten.

Beachten Sie, dass alle hier aufgeführten „ Connector Functions “ für die Verwendung mit der Salesforce-REST-API v46.0 ausgelegt sind.

Connector Functions

Es gibt zwei Haupttypen von Konnektoren: Objekt- und Abfrage-Konnektoren. Beachten Sie, dass beide Konnektoren ein „access_token“ erfordern. Führen Sie daher zuvor unbedingt [Auth] „Get Access Token“ in Ihrer App aus! Es wird allgemein empfohlen, beim Start der App oder des Prozesses ein neues Zugriffstoken zu generieren und es zur späteren Verwendung in einer App-Variablen zu speichern.

Objekt-Konnektoren

• Gibt alle Felder des betreffenden Objekts zurück.
• Verwenden Sie den Endpunkt ./services/data/v46.0/sobjects/<Objektname>/<Objekt-ID>
• Beispiel: Konnektor [Opportunity] „Get All Fields“

Abfrage-Konnektoren

• Geben nur die in der Abfrage angegebenen Felder zurück.
• Es können verknüpfte Informationen (z. B. der mit einer Opportunity verbundene Account-Name) oder aggregierte Informationen (z. B. die Anzahl der Datensätze) zurückgegeben werden.
• Verwenden Sie den Endpunkt ./services/data/v46.0/query
• Erfordert das Erstellen einer Abfrage mit SOQL (Dokumentation hier{target=_blank}).
• Beispiel: Konnektor [Order] Alle Bestellungen mit dem Status abrufen

Enthalten Connector Functions

Die folgenden „ Connector Functions “ sind in diesem Paket enthalten und sollen als Einführung in die über die Salesforce-API möglichen Funktionen dienen:* [Setup] Auth-Code-URL abrufen & [Setup] Refresh-Token abrufen * Wird nur für die Ersteinrichtung verwendet. Weitere Informationen finden Sie oben.*[Auth] Zugriffstoken abrufen * Wird zur Generierung eines Zugriffstokens verwendet, das in allen nachfolgenden „ Connector Functions “-Aufrufen enthalten sein muss.*[Opportunity]-Funktionen: * Alle Felder abrufen * Gibt alle Felder der abgefragten Opportunity zurück. Erfordert ein Zugriffstoken und eine Opportunity-ID. * Phase ändern * Aktualisiert die Phase der angegebenen Opportunity auf den angegebenen Wert.*[Order]-Funktionen: * Alle Aufträge mit einem bestimmten Status abrufen * Gibt eine Liste aller Aufträge mit einem bestimmten Status zurück . * Anzahl der Aufträge mit einem bestimmten Status ermitteln * Gibt die Anzahl aller Aufträge mit einem bestimmten Status zurück. * Auftragsnummer anhand der ID abrufen * Gibt eine Auftragsnummer anhand einer angegebenen Auftrags-ID zurück.

Beachten Sie die folgenden Hinweise, um diese Funktionen an Ihre Bedürfnisse anzupassen: 1. Um die Objekt- Connector Functions en zu ändern, ändern Sie einfach das in der URL angegebene Objekt. Fügen Sie nach Bedarf neue Ausgabewerte hinzu oder entfernen Sie sie. 2. Um Abfragen vom Typ „ Connector Functions “ anzupassen, müssen alle Änderungen in der Abfrage vorgenommen werden. Diese finden Sie in den Abfrageparametern unter dem Schlüssel „q“. 1. Tipp: Begrenzen Sie die Anzahl der Antworten einer Abfrage mit der Funktion LIMIT(Anzahl_der_Antworten)

Haben Sie gefunden, wonach Sie gesucht haben?

Sie können auch auf community.tulip.co vorbeischauen, um Ihre Frage zu stellen oder zu sehen, ob andere bereits ein ähnliches Problem hatten!