Salesforce-Erweiterung

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Version: 1.0.3

Auf Daten in Ihrem Salesforce-Konto zugreifen Daten einfügen, aktualisieren, abrufen und abfragen.

In diesem Artikel erfahren Sie, wie Sie diese Erweiterung konfigurieren und verwenden.

Voraussetzungen

In diesem Artikel erfahren Sie, wie Sie diese Erweiterung konfigurieren und verwenden. Bevor Sie die Erweiterung mithilfe der ExtensionCallout-Richtlinie von einem API-Proxy verwenden, müssen Sie Folgendes tun:

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

   Der private Schlüssel (.key) wird beim Konfigurieren der Erweiterung als Anmeldedaten verwendet. Sie verwenden die Zertifikatsdatei (.crt) beim Erstellen einer verbundenen App, 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. Richte eine verbundene App ein.

   Eine verbundene Salesforce-App bietet Zugriff auf die Salesforce-Erweiterung. Folgen Sie der Anleitung unten, um die App einzurichten.

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

   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 (Consumer-Key) und kopieren Sie seinen 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 mit Salesforce verbunden werden kann.

In Salesforce können externe Anwendungen mithilfe einer verbundenen Anwendung über APIs eine Verbindung zu Salesforce herstellen.

So richten Sie eine verbundene App ein:

1. Melden Sie sich bei Salesforce an.
2. Klicken Sie rechts oben auf das Zahnradsymbol und dann auf Einrichtung.
3. Maximieren Sie links im Navigationsbereich 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 der Buchhaltung und werden von der Erweiterung nicht verwendet.
6. Klicken Sie unter API (OAuth-Einstellungen aktivieren) das Kästchen OAuth-Einstellungen aktivieren an.
7. Geben Sie eine Callback-URL ein, auch wenn sie von der Erweiterung nicht verwendet wird. 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 Bereich Ausgewählte OAuth-Bereiche unter Ausgewählte OAuth-Bereiche Folgendes hinzu:
    • 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 noch einmal 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 vorab autorisiert.
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 die Kästchen für die Nutzerprofile an, 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. Stellen Sie außerdem sicher, dass mindestens Systemadministrator-Nutzer 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 sein Profil in der Spalte Profil.

18. Klicken Sie auf Speichern.

Über Salesforce

Salesforce ist eine CRM-Plattform (Customer-Relationship-Management). Customer Relationship Management hilft Unternehmen, die Bedürfnisse ihrer Kunden zu verstehen und Probleme zu lösen, indem sie Kundeninformationen und Interaktionen besser verwalten – und das alles über eine einzige Plattform, die jederzeit von jedem Desktop oder Gerät aus zugänglich ist.

Aktionen

insert

Fügen Sie Datensätze 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 Ergebnissen des Einfügevorgangs.

{
  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, das die Ergebnisse der Aktualisierung enthält.

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

retrieve

Datensätze als sObjects anhand ihrer IDs abrufen Gibt alle Felder des sObject-Typs 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. Beachten Sie, dass alle Attribute der Objekte im JSON-Code enthalten sind, auch wenn der Attributwert null ist.

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

querySOQL

Fragen Sie Salesforce.com mit der Salesforce Object Query Language (SOQL) ab.

<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-Einträge 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, das aufgelistete sObjects als JSON enthält.

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

CE

Datensätze mit den angegebenen IDs werden gelöscht.

<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, das die Ergebnisse des Vorgangs enthält.

{
  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

Verwenden Sie Folgendes, wenn Sie diese Erweiterung zur Verwendung in API-Proxys konfigurieren und bereitstellen.

Häufige Erweiterungseigenschaften

Für jede Erweiterung sind die folgenden Eigenschaften vorhanden.

Eigenschaften dieses Erweiterungspakets

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