Retrait de l'API Salesforce Platform versions 21.0 à 30.0

Date originale de publication - 20 octobre 2020

Mise à jour - 4 mai 2024
 

Quel est le statut des versions 21 à 30 des API SOAP, REST et de transfert en masse ?

• Actuel : Ces versions d’API sont dépréciées (depuis la version Summer ‘22) et ne sont plus prises en charge. Vous pouvez les utiliser, mais si vous rencontrez des problèmes et consignez une requête auprès du Support Salesforce, vous devez d’abord mettre à jour la version d’API. Il n’y aura pas de dépannage ni de correctif de bogues pour ces anciennes versions d’API.

• Futur : Version Summer ‘25 – Ces versions d’API vont être retirées. Les applications qui utilisent les versions seront interrompues car les appels échouent et répondent avec une erreur indiquant que le point de terminaison demandé est introuvable et ne peut pas être traité par la plate-forme. Voici les erreurs :

  • L’API REST renvoie l’erreur 410 : GONE.

  • L’API SOAP renvoie l’erreur 500 : UNSUPPORTED_API_VERSION.

  • L’API de transfert en masse renvoie l’erreur 400 : InvalidVersion.

Remarque : Les versions d’API 7.0 à 20.0 ont déjà été retirées et sont devenues indisponibles lors de la version Summer ’22.

Pourquoi retirons-nous ces versions d’ API ?
Nous orientons nos efforts de développement vers l’amélioration des dernières versions d’API afin d’optimiser l’expérience globale de Salesforce lors de l’élaboration de fonctionnalités personnalisées via des applications. Pour mettre les choses en perspective, la version d’API 30 datait de notre version Spring ‘14.

Quel est l’impact du retrait de la version d’API ?
Ce retrait affecte le code, les packages, les applications ou les intégrations qui exécutent une requête de versions 21.0 à 30.0 d'API SOAP, REST, ou de transfert en masse.  

Remarque : Ce retrait n’affecte pas les éléments suivants :

• Les versions d’API des classes Apex, déclencheurs Apex, pages Visualforce, flux et générateurs de processus

• Le produit prêt à l'emploi B2B Classic/Visualforce

• Composants de métadonnées par version dans un package géré

• Services Web REST & SOAP Apex personnalisés (un service Web Apex personnalisé permet d’appeler une méthode de classe Apex comme API publique. Pour plus d'informations sur les services Web Apex, suivez ce lien : Services Web Apex) 

Quelles sont les mesures à prendre ?

1. Identifiez les composants/applications dans votre organisation qui utilisent ces anciennes versions d’API.

2. Mettez à jour ces composants/applications. Avant la version Summer '25, vous devez modifier ou mettre à niveau vos applications pour qu’elles fonctionnent avec les versions d’API actuelles qui sont prises en charge. Salesforce recommande vivement de migrer vers les versions plus récentes des API pour bénéficier de capacités avancées et d’une amélioration des performances et de la sécurité.

Consultez le tableau ci-dessous répertoriant les composants couramment impactés et les mesures à prendre pour chacun d’eux :

Comment puis-je déterminer si ces anciennes versions d’API sont utilisées dans mes applications et à quel endroit ?

Pour déterminer les versions d’API, contactez les développeurs.

En outre, vous pouvez passer en revue les événements API dans API Total Usage EventLogFile (gratuit) qui rend compte de l’activité des API SOAP, REST et de transfert en masse de Salesforce à l’aide de l’une des deux méthodes suivantes.

1. La première méthode consiste à utiliser le nouveau navigateur de fichiers journaux d’événements inclus dans la version Summer ‘24.  Il vous permet de parcourir les fichiers journaux d’événements de l’utilisation totale de l’API sur votre organisation et de les télécharger sous forme de fichiers CSV afin de visualiser les événements API individuels.  

Dans Configuration, accédez à Sécurité → Surveillance des événements → Navigateur de fichiers journaux d’événements.  Vous pouvez consulter ici les fichiers journaux d’événements des dernières 24 heures (ou des 30 derniers jourssi vous avez activé Surveillance des événements).  Vous pouvez ensuite télécharger des fichiers journaux d’événements individuels sous forme de fichiers CSV afin de visualiser les événements API qui y figurent.

2. Sinon, la seconde méthode consiste à utiliser un client comme Salesforce CLI pour exécuter une requête SOQL sur l’objet EventLogFile, fournissant les fichiers journaux d’événements pour les dernières 24 heures (ou les 30 derniers jours si vous avez activé la surveillance des événements).

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

Pour chaque résultat, effectuez une requête d’API REST à l’aide des points de terminaison dans le résultat de requête pour récupérer les données des journaux d’événements dans ce fichier journaux d’évènements*.

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

Collez le corps de la réponse dans une application pour inspecter facilement les données des journaux d’événements en tant que fichier CSV.

3. Examinez chaque fichier CSV et déterminez si les demandes sont faites auprès des points de terminaison avec les versions d’API inférieures à 30.

Vérifiez tous les événements Utilisation totale de l’API(Type d’événement ApiTotalUsage) dont l’API_VERSION est inférieure ou égale à 30**

4. Pour les intégrations ou les clients qui utilisent les versions 30.0 et les versions inférieures, suivez les indications fournies par les champs clés dans les données des journaux d’événements pour identifier la source de l’appel de l’ancienne API :

CLIENT_NAME, CONNECTED_APP_ID, ENTITY_NAME, USER_ID

Pour en savoir plus sur la surveillance des événements, suivez le module Trailhead Surveillance des événements.

*Pour obtenir des informations d’introduction sur l’exécution d’une requête API REST, consultez le module Trailhead Utilisation de l’API REST.

**Le type d’événement « API Total Usage » regroupe les informations de requête pertinentes des API REST, SOAP, et de transfert en masse, ainsi que des informations de version. Consultez les détails de définition d’événement ici. Les organisations dont l’API est activée disposent d’un accès gratuit aux fichiers journaux d’événements API Total Usage avec une rétention des données d’un jour. Lorsque la surveillance des événements est activée, vous pouvez y accéder, ainsi qu’à tous les autres types de fichiers journaux d’événements avec une rétention des données de 30 jours.

Vous pouvez aussi effectuer les opérations suivantes pour rechercher des requêtes d’API de transfert en masse ou des connexions d’API SOAP :

• Rechercher des requêtes d’API de transfert en masse : Pour l’API de transfert en masse, accédez à la page « Tâches de chargement de données en masse » dans Configuration et affichez les détails de chaque tâche « Transfert en masse V1 ». Ce retrait d’API impactera toutes les tâches ayant une valeur de 30.0 ou inférieure dans le champ « Version d’API ».

• Rechercher des connexions d’API SOAP : Pour l’opération SOAP login (), accédez à la page « Historique de connexion » dans Configuration et affichez les entrées avec « SOAP Enterprise » ou « SOAP Partner » comme type d’API. Sinon, le LoginHistory sObject peut être interrogé via SOQL. Toutes les entrées de connexion qui présentent une valeur de 30.0 ou inférieure dans le champ « Version d’API » vont être impactées par ce retrait.

Remarque : Les partenaires peuvent tirer parti des Package Usage Logs (en anglais) pour obtenir des informations sur leur utilisation d’API obsolète.

Comment obtenir des informations supplémentaires ?

En ce qui concerne les dernières versions d’API prises en charge, consultez le site Salesforce Developers.

À propos des API et des messages sortants :

• Bases de l’API de la plate-forme (Trailhead)

• Introduction to SOAP API (en anglais) (Guide du développeur)

• Understanding Outbound Messaging (en anglais) (Guide du développeur)

• Bulk API (en anglais)(Guide du développeur)

• Introduction to REST API (en anglais) (Guide du développeur)

  • « REST » couvre toutes les API avec des URI de point de terminaison sous /services/data/vXX.Y/ et /services/metadata/vXX.Y/ où XX.Y est la version d’API. Cela inclut l’API REST Salesforce Platform « standard » qui fonctionne avec sObjects et les enregistrements, mais également les ressources suivantes :

    • Metadata API Developer (en anglais)

    • Tooling API (en anglais)

    • Chatter/Connect API (en anglais)

    • Query and Query All APIs (en anglais)

    • Search API (en anglais)

    • Limits API (en anglais)

    • Login API (c’est-à-dire « URL d'identité »)

• • • Observez les résultats d'une requête REST sur GET /services/data/v30.0 ou GET /services/metadata/v30.0 pour comprendre les ressources de niveau supérieur affectées lors du retrait des points de terminaison des versions v30.0 et des versions inférieures.

Si vous souhaitez plus d’informations sur le retrait de cette ancienne API, vous pouvez consulter An Important Update to Our Legacy API Retirement Plan (en anglais).

Pour obtenir une explication des versions d’API destinées aux administrateurs, écoutez le podcast ici (il date de quelques années, mais les informations essentielles sont toujours d’actualité) : Why API Versions Matter with Kris Harrison (en anglais).

J’ai encore besoin d’aide. Que puis-je faire ensuite ?

• Accédez aux ressources ci-dessus.

• Publiez une publication dans la communauté Trailblazer.

• Créez une requête auprès du Support Salesforce via l’ Aide de Salesforce. Prenez note de ce que vous avez déjà essayé et à quel endroit vous êtes bloqué pour que le Support puisse vous aider au mieux. **Notez que le Support ne peut pas mettre à jour les anciennes API dans votre organisation.

Pour afficher les retraits actuels et passés, consultez les Retraits de fonctionnalités Salesforce. Pour en savoir plus sur l'approche de Salesforce concernant le retrait de produits et de fonctionnalités, lisez notre Philosophie de retrait de fonctionnalité.