Sie befinden sich hier:
Welche API wird von mir verwendet?
Wählen Sie die richtige Salesforce-API für Ihre Integrationsanforderungen. Prüfen Sie die Auswahl der APIs, die Salesforce bietet, einschließlich der unterstützten Protokolle, Datenformate und Anwendungsfälle.
Erforderliche Editionen
| Verfügbarkeit: Salesforce Classic (nicht in allen Organisationen verfügbar) und Lightning Experience |
| Verfügbarkeit: Professional (mit aktiviertem API-Zugriff), Enterprise, Performance, Unlimited und Developer Edition |
| Erforderliche Benutzerberechtigungen | |
|---|---|
| Verwenden der APIs: | API aktiviert |
Verwenden von Apex-Klassen und -Methoden als REST-Webservices: Ermöglicht den Zugriff auf Apex-REST-Services, selbst wenn die Berechtigung "API-aktiviert" nicht erteilt wurde. |
Apex-REST-Services |
| API-Name | API-Typ | Datenformat | Kommunikation |
|---|---|---|---|
| REST API | REST | JSON, XML | Synchron |
| SOAP-API | SOAP (WSDL) | XML | Synchron |
| Connect-REST-API | REST | JSON, XML | Synchron (Fotos werden asynchron verarbeitet) |
| Apex-REST-API | REST | JSON, XML, benutzerdefiniert | Synchron |
| Apex-SOAP-API | SOAP (WSDL) | XML | Synchron |
| Analytics-REST-API | REST | JSON, XML | Synchron |
| Benutzeroberflächen-API (allgemein verfügbar) | REST | JSON | Synchron |
| GraphQL-API | GraphQL | JSON | Synchron |
| Tooling-API | REST oder SOAP (WSDL) | JSON, XML, benutzerdefiniert | Synchron |
| Bulk-API 2.0 | REST | CSV | Asynchron |
| Metadaten-API | SOAP (WSDL) | XML | Asynchron |
| Pub/Sub-API | gRPC und Protokollpuffer | Binary | Asynchron |
Einsatzmöglichkeiten der REST-API
Die REST-API bietet eine leistungsstarke, bequeme und einfache Webservices-Schnittstelle auf REST-Basis für die Interaktion mit Salesforce. Zu den Vorteilen zählen einfache Integration und Entwicklung. Für mobile Anwendungen und Webprojekte ist die API hinsichtlich der Technologie eine ausgezeichnete Wahl. Für bestimmte Projekte können Sie die REST-API mit anderen Salesforce-REST-APIs verwenden. Wenn Sie eine Benutzeroberfläche zum Erstellen, Lesen, Aktualisieren und Löschen von Datensätzen einschließlich des Erstellens einer Benutzeroberfläche für Listenansichten, Aktionen und abhängigen Auswahllisten erstellen möchten, verwenden Sie die Benutzeroberflächen-API. Verwenden Sie die Connect-REST-API, um eine Benutzeroberfläche für B2B Commerce für Lightning, verwaltete CMS-Inhalte, Experience Cloud-Sites oder Chatter zu erstellen. Wenn viele zu verarbeitende Datensätze vorliegen, sollten Sie vielleicht die Verwendung der Bulk-API in Betracht ziehen, die auf den REST-Prinzipien basiert und für die Verarbeitung großer Datensätze optimiert wurde.
Siehe REST API Developer Guide.
Einsatzmöglichkeiten der SOAP-API
Die SOAP-API bietet eine leistungsstarke, bequeme und einfache Webservices-Schnittstelle auf SOAP-Basis für die Interaktion mit Salesforce. Mit der SOAP-API können Sie Datensätze erstellen, abrufen, aktualisieren und löschen. Sie können die SOAP-API außerdem für Suchvorgänge und vieles mehr verwenden. Sie können die SOAP-API in jeder Sprache verwenden, die Webservices unterstützt.
Beispielsweise können Sie über die SOAP-APISalesforce in das ERP- und Finanzsystem Ihrer Organisation integrieren. Sie können damit außerdem Vertriebs- und Supportdaten in Echtzeit für Unternehmensportale bereitstellen und Kundendaten in wichtige Geschäftssysteme übernehmen.
Siehe SOAP API Developer Guide.
Einsatzmöglichkeiten der Connect-REST-API
Die Connect-REST-API bietet programmgesteuerten Zugriff auf B2B Commerce für Lightning, verwaltete CMS-Inhalte, Experience Cloud-Sites, Dateien, Benachrichtigungen, Themen und mehr. Verwenden Sie die Connect-REST-API, um Chatter-Feeds, -Benutzer und -Gruppen anzuzeigen, insbesondere in mobilen Anwendungen.
Einsatzmöglichkeiten der Apex-REST-API
Verwenden Sie die Apex-REST-API, wenn Sie Ihre Apex-Klassen und -Methoden öffentlich zugänglich machen möchten, sodass externe Anwendungen über die REST-Architektur auf Ihren Code zugreifen können. Die Apex-REST-API unterstützt für die Autorisierung sowohl OAuth 2.0 als auch eine Sitzungs-ID.
Siehe Apex Developer Guide: Exposing Apex Classes as REST Web Services.
Einsatzmöglichkeiten der Apex-SOAP-API
Verwenden Sie die Apex-SOAP-API, wenn Sie Apex-Methoden als SOAP-Web Service-APIs öffentlich zugänglich machen möchten, sodass externe Anwendungen über SOAP auf Ihren Code zugreifen können.
Die Apex-SOAP-API unterstützt für die Autorisierung sowohl OAuth 2.0 als auch eine Sitzungs-ID.
Siehe Apex Developer Guide: Exposing Apex Methods as SOAP Web Services und SOAP API Developer Guide: Apex-Related Calls.
Einsatzmöglichkeiten der Analytics-REST-API
Sie können mithilfe der Analytics-REST-API programmgesteuert auf CRM Analytics-Datenbestände wie Datensets, Linsen und Dashboards zugreifen. Senden Sie Abfragen und greifen Sie auf Datensets zu, die in die Analyseplattform importiert wurden. Erstellen Sie Linsen und rufen Sie sie ab. Greifen Sie auf XMD-Informationen zu. Rufen Sie eine Liste von Datenset-Versionen ab. Erstellen Sie CRM Analytics-Anwendungen und rufen Sie sie ab. Erstellen und aktualisieren Sie Dashboards und rufen Sie sie ab. Rufen Sie eine Liste von Abhängigkeiten für eine Anwendung ab. Bestimmen Sie, welche Funktionen dem Benutzer zur Verfügung stehen. Arbeiten Sie mit Snapshots. Ändern Sie replizierte Datensets.
Einsatzmöglichkeiten der Benutzeroberflächen-API
Erstellen Sie eine Salesforce-Benutzeroberfläche für native mobile Anwendungen und benutzerdefinierte Webanwendungen unter Verwendung derselben API, die Salesforce verwendet, um Lightning Experience und Salesforce für Android, iOS und die mobile Webversion zu erstellen. Erstellen Sie Benutzeroberflächen, auf denen Benutzer Datensätze, Listenansichten, Aktionen, Favoriten und mehr verwenden können. Sie erhalten nicht nur Daten und Metadaten in einer einzelnen Antwort, sondern die Antwort gleicht Metadatenänderungen ab, die von Salesforce-Administratoren an der Organisation vorgenommen wurden. Machen Sie sich keine Gedanken hinsichtlich Layouts, Auswahllisten, Feldebenensicherheit oder Freigaben. Sie müssen nur eine Anwendung erstellen, die Benutzer zu schätzen wissen.
Einsatzmöglichkeiten der GraphQL-API
Erstellen Sie hochgradig reaktionsfähige und skalierbare Anwendungen, indem Sie nur die Daten zurückgeben, die ein Kunde benötigt – und das alles in einer einzigen Anforderung. Die GraphQL-API meistert die Herausforderungen, die traditionelle REST-APIs mit sich bringen, durch Feldauswahl, Ressourcenaggregation und Schemaselbstprüfung. Durch die Feldauswahl wird die Größe der Nutzlast reduziert. Es werden nur Felder zurückgegeben, die in der Abfrage enthalten waren. Mit Aggregationen werden Umwege zwischen Client und Server reduziert. So wird ein Satz zugehöriger Ressourcen in einer einzigen Antwort zurückgegeben. Durch die Schemaselbstprüfung kann ein Benutzer die Typen, Felder und Objekte anzeigen, auf die der Benutzer Zugriff hat.
Siehe GraphQL API Developer Guide.
Einsatzmöglichkeiten der Tooling-API
Mithilfe der Tooling-API lassen sich Salesforce-Metadaten in andere Systeme integrieren. Metadatentypen werden als sObjects angezeigt. Auf diese Weise können Sie auf eine Komponente eines komplexen Typs zugreifen. Mit diesem feldspezifischen Zugriff lassen sich Vorgänge für komplexe Metadatentypen beschleunigen. Sie können auch benutzerdefinierte Entwicklungstools für Force.com-Anwendungen erstellen. Mit der Tooling-API können Sie beispielsweise funktionierende Kopien von Apex-Klassen und -Auslösern sowie Visualforce-Seiten und -Komponenten verwalten und bereitstellen. Außerdem haben Sie damit die Möglichkeit, Prüfpunkte und Heap-Dump-Markierungen zu setzen, anonymen Apex-Code auszuführen und auf Informationen zur Protokollierung und Codeabdeckung zuzugreifen.
REST und SOAP werden unterstützt.
Siehe Tooling-API.
Einsatzmöglichkeiten der Bulk-API 2.0
Verwenden Sie Bulk-API 2.0, um die Vorgänge "query", "queryAll", "insert", "update", "upsert" oder "delete" für eine große Anzahl von Datensätzen asynchron auszuführen. Bulk-API 2.0 wurde für das Salesforce-REST-Framework entwickelt.
Alle Datenvorgänge, die mehr als 2.000 Datensätze umfassen, sind gute Kandidaten für die Bulk-API 2.0, um einen asynchronen Workflow, der das Bulk-Framework nutzt, erfolgreich vorzubereiten, auszuführen und zu verwalten. Aufträge mit weniger als 2.000 Datensätzen sollten in Massenvorgängen verarbeitete, synchrone Aufrufe in REST (z. B. Composite) oder SOAP enthalten.
Bei der Arbeit mit großen Datenmengen ist dies die einfachste Möglichkeit, zahlreiche Datensätze auf einmal zu erstellen, zu lesen, zu aktualisieren und zu löschen (CRUD). Wenn Ihr Auftrag nur einen sObject-Typ enthält oder bis zu 1 TB Daten pro Tag extrahiert, ist Bulk-API 2.0 die Salesforce-API Ihrer Wahl.
Einsatzmöglichkeiten der Metadaten-API
Verwenden Sie die Metadaten-API zum Abrufen, Bereitstellen, Erstellen, Aktualisieren oder Löschen von Anpassungen für Ihre Organisation. Der häufigste Verwendungszweck besteht in der Migration von Änderungen aus einer Sandbox- oder Testorganisation in die Produktionsumgebung. Die Metadaten-API ist für die Verwaltung von Anpassungen und zur Erstellung von Tools gedacht, die zur Verwaltung des Metadatenmodells, nicht der Daten selbst, dienen.
Die einfachste Methode für den Zugriff auf die Funktionen in der Metadaten-API besteht in der Verwendung der Salesforce-Erweiterungen für Visual Studio Code oder die Salesforce CLI. Beide Tools wurden auf der Grundlage der Metadaten-API erstellt und verwenden die Standardtools, um die Arbeit mit der Metadaten-API zu vereinfachen.
- Die Salesforce-Erweiterungen für Visual Studio Code beinhalten Tools für die Entwicklung auf der Salesforce-Plattform im kompakten, erweiterbaren VS Code-Editor. Diese Tools stellen Funktionen für die Arbeit mit Entwicklungsorganisationen (Testorganisationen, Sandbox- und DE-Organisationen), Apex, Aura-Komponenten und Visualforce bereit.
- Die Salesforce CLI ist ideal, wenn Sie ein Skript oder die Befehlszeile verwenden, um Metadaten zwischen einem lokalen Verzeichnis und einer Salesforce-Organisation zu verschieben.
Siehe Metadata API Developer Guide.
Einsatzmöglichkeiten der Pub/Sub-API
Sie können die Pub/Sub-API verwenden, um externe Systeme in Ereignisse zu integrieren. Ereignis-Streams basieren auf benutzerdefinierten Nutzlasten durch Plattformereignisse oder Änderungen in Salesforce-Datensätzen über die Datenänderungserfassung. In Salesforce können Sie Ereignisse mit Apex-Auslösern, dem Prozessgenerator und dem Flow Builder veröffentlichen und abonnieren.
Die Pub/Sub-API wurde für die umfangreiche bidirektionale Ereignisintegration in Salesforce erstellt. Verwenden Sie die Pub/Sub-API zum effizienten Veröffentlichen und Abonnieren von binären Ereignismeldungen im Apache Avro-Format. Die Pub/Sub-API basiert auf gRPC und HTTP/2 und verwendet ein entnahmebasiertes Modell, sodass Sie den Abonnement-Flow steuern können. Mit der Pub/Sub-API können Sie eine der 11 Programmiersprachen verwenden, die von gRPC unterstützt werden.
Verwenden Sie den Typ von Streaming-Ereignissen, der für Ihre Anforderungen geeignet ist.
- Ereignis "Datenänderungserfassung": Sie können Änderungen an Salesforce-Datensätzen mit allen geänderten Feldern erhalten. "Datenänderungserfassung" unterstützt mehr Standardobjekte als PushTopic-Ereignisse und bietet mehr Funktionen, wie etwa Header-Felder, die Informationen über die Änderung enthalten.
- Plattformereignis: Sie können benutzerdefinierte Nutzlasten mit einem vordefiniertem Schema veröffentlichen und empfangen. Dabei kann es sich um beliebige Daten handeln, die Sie definieren, einschließlich Geschäftsdaten wie Auftragsinformationen. Geben Sie an, welche Daten gesendet werden sollen, indem Sie ein Plattformereignis definieren. Um Benachrichtigungen zu erhalten, abonnieren Sie einen Plattformereigniskanal.
- Alte Ereignisse: PushTopic- und generische Ereignisse: PushTopic- und generische Ereignisse sind Ereignisse der ersten Generation. Der Support ist eingeschränkt und sie werden nicht mehr mit neuen Funktionen aktualisiert. Es wird empfohlen, Ereignisse der Datenänderungserfassung anstelle von PushTopic-Ereignissen und Plattformereignisse anstelle von generischen Ereignissen zu verwenden.
Informationen finden Sie in der Pub/Sub-API-Dokumentation.
