Einstellung der Salesforce Platform-API-Versionen 21.0 bis 30.0

Ursprüngliches Veröffentlichungsdatum – 20. Oktober 2020

Aktualisiert am 4. Mai 2024
 

Wie lautet der Status der SOAP-, REST- und Bulk-API-Versionen 21–30?

• Aktuell: Diese API-Versionen wurden (seit der Version Summer '22) ersetzt und werden nicht mehr unterstützt. Sie können sie zwar verwenden, aber wenn Probleme auftreten und Sie einen Kundenvorgang beim Salesforce-Support erstellen, müssen Sie zunächst die API-Version aktualisieren. Für diese alten API-Versionen gibt es keine Fehlerbehebungen mehr.

• Künftig: Version Summer '25: Diese API-Versionen werden eingestellt. Bei Anwendungen, die diese Versionen verwenden, kommt es zu Unterbrechungen, da bei Aufrufen Fehler auftreten, die angeben, dass der angeforderte Endpunkt nicht gefunden wurde und von der Plattform nicht verarbeitet werden kann. Im Folgenden sind die Fehler aufgeführt:

  • Die REST-API gibt Folgendes zurück :410: GONE.

  • Die SOAP-API gibt Folgendes zurück: 500: UNSUPPORTED_API_VERSION.

  • Die Bulk-API gibt Folgendes zurück: 400: InvalidVersion.

Hinweis: Die API-Versionen 7.0 bis 20.0 wurden bereits eingestellt und sind in der Version Summer '22 nicht mehr verfügbar.

Warum stellt Salesforce diese API-Versionen ein?
Salesforce konzentriert seine Entwicklungsbemühungen auf die Verbesserung der neuesten API-Versionen, um die gesamte Salesforce-Erfahrung beim Erstellen benutzerdefinierter Funktionen über Anwendungen zu verbessern. Zur Einordnung: API-Version 30 stammt aus der Version Spring '14.

Welche Auswirkungen hat die Einstellung dieser API-Version?
Diese Einstellung betrifft jeglichen Code, alle Pakete, Anwendungen oder Integrationen, die Anforderungen der Versionen 21.0 bis 30.0 der SOAP-, REST- oder Bulk-API ausführen.  

Hinweis: Diese Einstellung wirkt sich nicht auf Folgendes aus:

• Die API-Versionen von Apex-Klassen, Apex-Auslösern, Visualforce-Seiten, Flows und Prozessgeneratoren

• Das vorkonfigurierte B2B Classic-/Visualforce-Produkt

• Versionierte Metadatenkomponenten in einem verwalteten Paket

• Benutzerdefinierte Apex-REST- und -SOAP-Webservices (ein benutzerdefinierter Apex-Webservice bietet die Möglichkeit, eine Apex-Klassenmethode als öffentliche API aufrufbar zu machen. Hier erhalten Sie weitere Informationen zu Apex-Webservices: Apex-Webservices) 

Welche Maßnahmen müssen ergriffen werden?

1. Ermitteln Sie alle Komponenten/Anwendungen in Ihrer Organisation, die diese alten API-Versionen verwenden.

2. Aktualisieren Sie diese Komponenten/Anwendungen. Vor Einführung der Version Summer '25 müssen Sie Ihre Anwendungen aktualisieren, sodass sie mit aktuellen, unterstützten API-Versionen funktionieren. Salesforce empfiehlt dringend, auf neuere Versionen der APIs umzustellen, da diese erweiterte Funktionen, mehr Sicherheit und eine bessere Leistung bieten.

In der unten stehenden Tabelle finden Sie Stellen, die häufig betroffen sind, sowie die jeweils erforderlichen Aktionen:

Wie kann ich feststellen, ob und wo diese alten API-Versionen in meinen Anwendungen verwendet werden?

Wenden Sie sich an die Entwickler der von Ihnen verwendeten Anwendungen, um die API-Versionen zu bestimmen.

Außerdem können Sie die API-Ereignisse, die über Aktivitäten der SOAP-, REST- und Bulk-API von Salesforce berichten, mit der kostenlosen EventLogFile für die gesamte API-Nutzung mithilfe einer der folgenden beiden Methoden überprüfen.

1. Die erste Methode besteht darin, den neuen Ereignisprotokollbrowser zu verwenden, der in der Version Summer ‘24 enthalten ist.  Damit können Sie die Ereignisprotokolldateien zur gesamten API-Nutzung in Ihrer Organisation durchsuchen und sie als CSV-Dateien herunterladen, um die einzelnen API-Ereignisse anzuzeigen.  

Navigieren Sie in "Setup" zu "Sicherheit" → "Ereignisüberwachung" → "Ereignisprotokollbrowser".  Dort können Sie die Ereignisprotokolldateien der letzten 24 Stunden (oder der letzten 30 Tage, wenn Sie die Ereignisüberwachung) aktiviert haben) anzeigen.  Sie können dann einzelne Ereignisprotokolldateien als CSV-Dateien herunterladen, um die API-Ereignisse darin anzuzeigen.

2. Alternativ besteht die zweite Methode darin, einen Client wie Salesforce CLI zu verwenden, um eine SOQL-Abfrage für das Objekt "EventLogFile" auszuführen, mit der die Ereignisprotokolldateien der letzten 24 Stunden (oder der letzten 30 Tage, wenn Sie die Ereignisüberwachung aktiviert haben) bereitgestellt werden.

sf data query -q "SELECT Id, LogFile, EventType, CreatedDate FROM EventLogFile WHERE EventType IN ('ApiTotalUsage')" -o <Ihr-Benutzername>

Führen Sie für jedes Ergebnis eine REST-API-Anforderung mit den Endpunkten im Abfrageergebnis aus, um die Ereignisprotokolldaten in dieser Ereignisprotokolldatei abzurufen*.

/services/data/v58.0/sobjects/EventLogFile/0AT3i000005vXpWGAU/LogFile

Fügen Sie den Antworttext in eine Anwendung ein, um die Ereignisprotokolldaten einfach als CSV-Datei zu untersuchen.

3. Überprüfen Sie die einzelnen CSV-Dateien und bestimmen Sie, ob Anforderungen für Endpunkte mit der API-Version 30 oder niedriger vorgenommen werden.

Überprüfen Sie alle Ereignisse der gesamten API-Nutzung (ApiTotalUsage-EventType) mit API_VERSION 30 und niedriger**

4. Befolgen Sie bei Integrationen oder Clients, die die Version 30.0 und niedriger verwenden, die Tipps, die in den Schlüsselfeldern in den Ereignisprotokolldaten angegeben sind, um die Quelle des Aufrufs einer alten API zu identifizieren:

CLIENT_NAME, CONNECTED_APP_ID, ENTITY_NAME, USER_ID

Weitere Informationen zur Ereignisüberwachung erhalten Sie im Trailhead-Modul Ereignisüberwachung.

* Einführende Informationen zum Ausführen einer REST-API-Anforderung finden Sie in Trailhead unter Verwenden der REST-API.

** Der Ereignistyp "Gesamte API-Nutzung" konsolidiert relevante Anforderungsinformationen übergreifend für die SOAP-, Bulk- und REST-APIs, einschließlich der Versionsinformationen. Hier können Sie die Ereignisdefinitionsdetails anzeigen. API-fähige Organisationen verfügen über kostenlosen Zugriff auf die Protokolldateien des Ereignisses "Gesamte API-Nutzung", bei dem die Daten einen Tag lang aufbewahrt werden. Wenn die Ereignisüberwachung aktiviert ist, können Sie auf diesen und alle anderen Ereignisprotokoll-Dateitypen mit einem Datenaufbewahrungszeitraum von 30 Tagen zugreifen.

Sie können auch folgende Schritte ausführen, um Bulk-API-Anforderungen oder SOAP-API-Anmeldungen zu finden:

• Bulk-API-Anmeldungen finden: Navigieren Sie bei der Bulk-API im Setup zur Seite "Aufträge für das Massenladen von Daten" und zeigen Sie die Details für jeden Auftrag vom Typ "Massenvorgang V1" an. Die Einstellung dieser API hat Auswirkungen auf alle Aufträge, die im Feld "API-Version" den Wert "30.0" oder einen geringeren Wert aufweisen.

• SOAP-API-Anmeldungen finden: Navigieren Sie für den SOAP- Vorgang "login()" unter "Setup" zu "Anmeldeverlauf" und überprüfen Sie die Einträge mit "SOAP Enterprise" oder "SOAP Partner" als API-Typ. Alternativ kann das sObject "LoginHistory" per SOQL abgefragt werden. Alle Anmeldeeinträge mit dem Wert 30.0 oder niedriger im Feld "API-Version" sind von dieser Einstellung betroffen.

Hinweis: Partner können die Paketnutzungsprotokolle für Statistiken zur Nutzung Ihrer ersetzten APIs verwenden.

Wo erhalte ich weitere Informationen?

Informationen zu den neuesten unterstützten API-Versionen finden Sie auf der Salesforce Developers-Site.

Informationen zu APIs und ausgehendem Messaging:

• Plattform-API – Grundlagen (Trailhead)

• Introduction to SOAP API (Entwicklerhandbuch)

• Understanding Outbound Messaging (Entwicklerhandbuch)

• Bulk API (Entwicklerhandbuch)

• Introduction to REST API (Entwicklerhandbuch)

  • "REST" deckt alle APIs mit Endpunkt-URIs unter "/services/data/vXX.Y/" und "/services/metadata/vXX.Y/" ab, wobei "XX.Y" die API-Version darstellt. Dies schließt auch die "standardmäßige" Salesforce Platform-REST-API mit ein, die für sObjects und Datensätze verwendet werden kann, aber auch die folgenden Ressourcen:

    • Metadata API Developer

    • Tooling-API

    • Chatter-/Connect-API

    • Query- und Query All-APIs

    • Search-API

    • Limits-API

    • Login-API (auch "Identity")

• • • Beobachten Sie die Ergebnisse einer REST-Anforderung für "GET /services/data/v30.0" oder "GET /services/metadata/v30.0", um nachzuvollziehen, welche Ressourcen der obersten Ebene betroffen sind, wenn die Endpunkte v30.0 und niedriger eingestellt werden.

Weitere Informationen über die Einstellung von alten APIs finden Sie unter An Important Update to Our Legacy API Retirement Plan (Wichtige Aktualisierung des Plans zur Einstellung alter APIs).

Eine Erklärung zu den API-Versionen, die sich an Administratoren richtet, finden Sie in diesem Podcast (er ist zwar schon ein paar Jahre alt, aber die wichtigsten Informationen sind immer noch relevant): Why API Versions Matter mit Kris Harrison.

Ich benötige weitere Hilfe. Was kann ich als Nächstes tun?

• Sehen Sie sich die oben aufgeführten Ressourcen an.

• Posten Sie in der Trailblazer Community.

• Erstellen Sie über die Salesforce-Hilfe einen Kundenvorgang für den Salesforce-Support. Bitte merken Sie sich, was Sie bereits versucht haben und an welcher Stelle Sie nicht weiterkommen, damit der Support Ihnen so effizient wie möglich helfen kann. ** Beachten Sie, dass der Support die alten APIs in Ihrer Organisation nicht aktualisieren kann.

Unter Einstellungen von Salesforce-Produkten und -Funktionen können Sie alle aktuellen und vergangenen Einstellungen anzeigen. Weitere Informationen zur Vorgehensweise von Salesforce bei der Einstellung von Produkten und Funktionen erfahren Sie in der Philosophie zur Einstellung von Produkten und Funktionen.