Salesforce-Erweiterung

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

Version: 1.0.5

Sie können auf Daten in Ihrem Salesforce-Konto zugreifen. Daten einfügen, aktualisieren, abrufen und abfragen

Dieser Artikel enthält eine Referenz zum Konfigurieren und Verwenden dieser Erweiterung.

Vorbereitung

Dieser Artikel enthält eine Referenz zum Konfigurieren und Verwenden dieser Erweiterung. Bevor Sie die Erweiterung über einen API-Proxy mit der ExtensionCallout-Richtlinie verwenden können, müssen Sie Folgendes tun:

1. Erstellen Sie ein RSA-x509-Paar aus privatem Schlüssel und Zertifizierung.

   Sie verwenden den privaten Schlüssel (.key) als Anmeldedaten, wenn Sie die Erweiterung konfigurieren. Sie verwenden die Zertifikatsdatei (.crt), wenn Sie eine verbundene App erstellen, die der Erweiterung Zugriff auf Salesforce gewährt.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Richten Sie eine verbundene App ein.

   Eine verbundene Salesforce-Anwendung gewährt der Salesforce-Erweiterung Zugriff. Eine Anleitung zur Einrichtung der App finden Sie unten.

3. Rufen Sie den Consumer-Key für die verbundene Anwendung ab. Die Erweiterung verwendet diesen bei der Authentifizierung bei der Anwendung.

   1. Klicken Sie in der Salesforce-Einrichtung im linken Navigationsbereich auf Apps > App Manager.
   2. Suchen Sie in der Liste nach der verbundenen App, die Sie erstellt haben.
   3. Klicken Sie im Drop-down-Menü rechts in der Zeile der Anwendung auf Anzeigen.
   4. Suchen Sie unter API (OAuth-Einstellungen aktivieren) den Consumer-Key und kopieren Sie den Wert an einen sicheren Ort, um ihn bei der Konfiguration der Erweiterung zu verwenden.

Verbundene App für den Zugriff durch die Erweiterung einrichten

Bevor die Salesforce-Erweiterung auf Salesforce zugreifen kann, müssen Sie eine verbundene Salesforce-App erstellen, über die die Erweiterung eine Verbindung zu Salesforce herstellen kann.

In Salesforce ermöglicht eine verbundene Anwendung externen Anwendungen, über APIs eine Verbindung zu Salesforce herzustellen.

Verbundene App einrichten

1. Melden Sie sich bei Salesforce an.
2. Klicken Sie rechts oben auf das Zahnradsymbol und dann auf Einrichten.
3. Maximieren Sie in der Navigationsleiste links Apps > App-Manager.
4. Klicken Sie auf der Seite App-Manager auf Neue verbundene App.
5. Füllen Sie die Felder unter Grundlegende Informationen aus. Die Werte dienen nur der Buchhaltung und werden nicht von der Erweiterung verwendet.
6. Klicken Sie unter API (OAuth-Einstellungen aktivieren) das Kästchen OAuth-Einstellungen aktivieren an.
7. Obwohl sie von der Erweiterung nicht verwendet wird, geben Sie eine Callback-URL ein. Sie können http://localhost/ oder einen anderen Platzhalterhost verwenden.
8. Klicken Sie das Kästchen Digitale Signaturen verwenden an.
9. Klicken Sie unter Digitale Signaturen verwenden auf Datei auswählen, um die zuvor generierte Datei salesforce.crt zu suchen und hochzuladen.
10. Fügen Sie im Abschnitt Ausgewählte OAuth-Bereiche Folgendes hinzu, damit sie sich unter Ausgewählte OAuth-Bereiche befinden:
    • Daten aufrufen und verwalten (api)
    • Anfragen jederzeit in Ihrem Namen ausführen (refresh_token, offline_access)
11. Klicken Sie auf Speichern. Falls Fehler auftreten, müssen Sie die Datei salesforce.crt möglicherweise neu generieren und hochladen.
12. Klicken Sie auf der resultierenden Anwendungsseite auf Verwalten.
13. Klicken Sie auf der Seite „App Manager“ für die gerade erstellte App auf Richtlinien bearbeiten.
14. Klicken Sie unter OAuth-Richtlinien auf das Drop-down-Menü Zulässige Nutzer und dann auf Vom Administrator genehmigte Nutzer sind vorautorisiert.
15. Klicken Sie auf Speichern.
16. Kehren Sie zur Seite „App“ unter Profile zurück und klicken Sie auf Profile verwalten.

17. Klicken Sie auf der Seite Anwendungsprofilzuweisung auf die Kästchen für die Nutzerprofile, die diese Anwendung verwenden können.

    Wählen Sie ein Profil aus, das dem Nutzer entspricht, dessen Nutzernamen Sie bei der Konfiguration der Erweiterung verwenden. Achten Sie außerdem darauf, dass mindestens Nutzer mit Berechtigungen eines Systemadministrators Zugriff auf diese Anwendung haben.

    Sie können die Profileinstellung für den Nutzer in Salesforce aufrufen. Maximieren Sie im Bereich Einrichtung die Option Nutzer > Nutzer, suchen Sie den Nutzer, den die Erweiterung repräsentieren soll, und suchen Sie dann in der Spalte Profil nach seinem Profil.

18. Klicken Sie auf Speichern.

Über Salesforce

Salesforce ist eine CRM-Plattform (Customer-Relationship-Management). Das Customer-Relationship-Management hilft Unternehmen, die Anforderungen ihrer Kunden zu verstehen und Probleme zu lösen, indem die Kundendaten und Interaktionen besser verwaltet werden – alles auf einer einzigen Plattform, die immer von jedem Computer oder Gerät aus zugänglich ist.

Aktionen

insert

Fügen Sie Einträge als sObject-Typen ein.

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Anfrageparameter

Antwort

Ein results-Array mit den Ergebnissen des Insert-Vorgangs.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

Salesforce-Datensätze aktualisieren

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Anfrageparameter

Antwort

Ein results-Array mit Ergebnissen der Aktualisierung.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

retrieve

Datensätze als sObjects anhand ihrer IDs abrufen Gibt alle Felder des Typs „sObject“ zurück.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Anfrageparameter

Antwort

Ein records-Array von sObjects, die als JSON dargestellt werden. Hinweis: Alle Eigenschaften der Objekte sind im JSON-Format enthalten, auch wenn der Attributwert null ist.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

Salesforce.com mit der Salesforce Object Query Language (SOQL) abfragen

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Anfrageparameter

Antwort

Ergebnisse der Abfrage.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

Salesforce.com-Datensätze auflisten Gibt alle Felder des angegebenen sObject-Typs zurück.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Anfrageparameter

Antwort

Ein records-Array mit aufgeführten sObjects als JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

CE

Löschen Sie Einträge mit den angegebenen IDs.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Anfrageparameter

Antwort

Ein results-Array mit den Ergebnissen des Vorgangs.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

Rufen Sie das Salesforce.com API-Zugriffstoken ab. Kann zum Abfragen von REST APIs verwendet werden.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Anfrageparameter

Keine.

Antwort

Das Zugriffstoken im JSON-Format.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Konfigurationsreferenz

Beachten Sie Folgendes, wenn Sie diese Erweiterung für die Verwendung in API-Proxys konfigurieren und bereitstellen.

Gängige Erweiterungseigenschaften

Für jede Erweiterung sind die folgenden Eigenschaften vorhanden.

Properties für dieses Erweiterungspaket

Geben Sie Werte für die folgenden Konfigurationseigenschaften an, die für diese Erweiterung spezifisch sind.