Quelle API dois-je utiliser ?

Utilisation de l'API REST

L'API REST offre une interface de services Web basés sur REST puissante, pratique et simple qui permet d'interagir avec Salesforce. Parmi ses avantages figurent la facilité d'intégration et de développement. Grâce sa technologie, elle représente un excellent choix pour l'utiliser avec des applications mobiles et des projets Web. Pour certains objets, vous pouvez utiliser l'API REST avec d'autres API REST Salesforce. Pour élaborer une interface utilisateur de création, de lecture, de mise à jour et de suppression d'enregistrements, y compris une interface pour des vues de liste, des actions et des listes de sélection dépendantes, utilisez l'API interface utilisateur. Pour élaborer une interface utilisateur pour B2B Commerce dans Lightning, un contenu géré CMS, des sites Experience Cloud ou Chatter, utilisez l'API REST Connect. Si vous devez traiter un grand nombre d'enregistrements, vous pouvez utiliser l'API de transfert en masse qui est basée sur les principes REST et optimisée pour les jeux de données importants.

Consultez REST API Developer Guide.

Utilisation de l'API SOAP

L'API SOAP offre une interface de services Web basés sur SOAP puissante, pratique et simple qui permet d'interagir avec Salesforce. Vous pouvez utiliser l'API SOAP pour créer, récupérer, mettre à jour ou supprimer des enregistrements. Vous pouvez également utiliser l'API SOAP pour effectuer des recherches et davantage. Utilisez l’API SOAP dans n'importe quelle langue qui prend en charge les services Web.

Par exemple, vous pouvez utiliser l'API SOAP pour intégrer Salesforce aux systèmes ERP et financiers de votre organisation. Vous pouvez également livrer en temps réel des informations commerciales et de support aux portails de sociétés, et remplir les systèmes métier critiques avec des informations sur les clients.

Consultez SOAP API Developer Guide.

Quand utiliser l'API REST Connect

L'API REST Connect fournit un accès par programmation à B2B Commerce pour Lightning, aux contenus gérés CMS, aux sites Experience Cloud, à des fichiers, des notifications, des rubriques, et davantage. Utilisez l'API REST Connect pour afficher des fils, des utilisateurs et des groupes, notamment dans des applications mobiles.

Consultez Connect REST API Developer Guide.

Quand utiliser l'API REST Apex

Utilisez l’API REST Apex pour exposer vos classes et méthodes Apex afin de donner aux applications externes un accès à votre code via l'architecture REST. L'API REST Apex prend en charge OAuth 2.0 et l'ID de session pour l'autorisation.

Consultez Apex Developer Guide : Exposing Apex Classes as REST Web Services.

Quand utiliser l'API SOAP Apex

Utilisez l'API SOAP Apex pour exposer vos méthodes Apex en tant qu'API de service Web SOAP et permettre ainsi aux applications externes d'accéder à votre code via SOAP.

L'API SOAP Apex prend en charge OAuth 2.0 et l'ID de session pour l'autorisation.

Consultez Apex Developer Guide : Exposing Apex Methods as SOAP Web Services et SOAP API Developer Guide : Apex-Related Calls.

Quand utiliser l'API REST Analytics

Vous pouvez accéder à des actifs CRM Analytics, tels que des jeux de données, des perspectives et des tableaux de bord, par programmation en utilisant l'API REST Analytics. Envoyez des requêtes et accédez aux jeux de données qui ont été importés dans la plate-forme Analytics. Créez et récupérez des perspectives. Accédez aux informations XMD. Récupérez une liste de versions de jeux de données. Créez et récupérez des applications CRM Analytics. Créez, mettez à jour et récupérez des tableaux de bord. Récupérez une liste de dépendances pour une application. Déterminez les fonctionnalités disponibles pour l'utilisateur. Utilisez des clichés instantanés. Manipulez les jeux de données répliqués.

Consultez Analytics REST API Developer Guide.

Quand utiliser l'API interface utilisateur

Élaborez une interface utilisateur Salesforce pour des applications mobiles natives et des applications Web personnalisées en utilisant la même API que Salesforce utilise pour créer Lightning Experience et Salesforce pour Android, iOS et Web mobile. Élaborez des interfaces qui permettent aux utilisateurs de travailler avec des enregistrements, des vues de liste, des actions, des favoris et plus encore. Non seulement vous obtenez des données et des métadonnées dans une seule réponse, mais la réponse correspond aux modifications des métadonnées que les administrateurs Salesforce ont apporté à l'organisation. Vous n'avez pas à gérer les présentations, les listes de sélection, la sécurité au niveau du champ ou le partage, il vous suffit d'élaborer l'application que vos utilisateurs vont adorer.

Consultez User Interface API Developer Guide.

Quand utiliser l'API GraphQL

Élaborez des applications très réactives et évolutives en renvoyant uniquement les données dont un client a besoin, le tout dans une seule requête. L'API GraphQL résout les défis des API REST traditionnelles via la sélection de champs, l'agrégation de ressources et l'introspection du schéma. La sélection du champ réduit la taille de la charge de travail, en renvoyant uniquement les champs inclus dans la requête. Les agrégations diminuent les allers-retours entre le client et le serveur, en renvoyant un ensemble de ressources associées dans une seule réponse. L'introspection du schéma permet à un utilisateur de déterminer les types, les champs et les objets auxquels il a accès.

Consultez GraphQL API Developer Guide.

Quand utiliser l'API Tooling

Utilisez l'API Tooling pour intégrer des métadonnées Salesforce à d'autres systèmes. Les types de métadonnées sont exposés en tant que sObjects, ce qui permet d'accéder à un composant d'un type complexe. Cet accès au niveau du champ accélère les opérations sur les types de métadonnées complexes. Vous pouvez également élaborer des outils de développement personnalisés pour des applications Force.com. Par exemple, utilisez l'API Tooling pour gérer et déployer des copies de travail de classes et de déclencheur Apex, ainsi que des pages et des composants Visualforce. Vous pouvez également définir des points de contrôle ou des marqueurs de décharge mémoire, exécuter un code Apex anonyme, et accéder aux informations de journalisation et de couverture de code.

REST et SOAP sont pris en charge.

Consultez Tooling API.

Quand utiliser l'API de transfert en masse 2.0

Utilisez l'API de transfert en masse 2.0 pour interroger, interroger tout, insérer, mettre à jour, mettre à jour/insérer ou supprimer de façon asynchrone un grand nombre d'enregistrements. L'API de transfert en masse 2.0 est conçue dans l'infrastructure REST de Salesforce.

Toutes les opérations de données qui comprennent plus de 2000 enregistrements sont de bons candidats pour l'API de transfert en masse 2.0 afin de préparer, exécuter et gérer avec succès un workflow asynchrone qui utilise l'infrastructure de transfert en masse. Les tâches qui comprennent moins de 2000 enregistrements doivent invoquer des appels synchrones « traités en masse » dans le code REST (par exemple, composé) ou SOAP.

Lorsque vous travaillez sur des volumes de données importants, la méthode la plus simple consiste à créer, lire, mettre à jour et supprimer (CRUD) des enregistrements à l'échelle. Si votre tâche contient un seul type sObject ou extrait jusqu'à 1 To de données par jour, choisissez l'API de transfert en masse 2.0 Salesforce.

Consultez Bulk API 2.0 and Bulk API Developer Guide.

Utilisation de l'API de métadonnées

L'API de métadonnées permet de restaurer, déployer, créer, mettre à jour ou supprimer des personnalisations pour votre organisation. L'utilisation la plus courante consiste à migrer des modifications depuis une organisation sandbox ou de test vers votre environnement de production. L'API de métadonnées est conçue pour la gestion des personnalisations et la création d'outils capables de gérer le modèle des métadonnées, pas les données elles-mêmes.

Pour accéder à la fonctionnalité dans l'API de métadonnées, le plus simple est d'utiliser Salesforce Extensions pour Visual Studio Code ou Salesforce CLI. Ces deux outils reposent sur l'API de métadonnées et utilisent les outils standard pour simplifier l'utilisation de l'API de métadonnées.

• Salesforce Extensions pour Visual Studio Code inclut des outils de développement sur Salesforce Platform dans l'éditeur de VS Code extensible et léger. Ces outils fournissent les fonctionnalités utiles pour travailler avec des organisations de développement (test, sandbox et DE), Apex, des composants Aura et Visualforce.
• La Salesforce CLI est idéale si vous souhaitez utiliser l'écriture de script ou la ligne de commande pour déplacer les données depuis un répertoire local vers une organisation Salesforce.

Consultez Metadata API Developer Guide.

Quand utiliser l'API Pub/Sub

Vous pouvez utiliser l'API Pub/Sub pour intégrer des systèmes externes à des événements. Les flux d'événements sont basés sur des charges de travail personnalisées à travers des événements de plate-forme ou des modifications dans des enregistrements Salesforce via la Capture des données de modification. Dans Salesforce, vous pouvez publier et vous abonner à des événements avec des déclencheurs Apex, le Générateur de processus et Flow Builder.

L’API Pub/Sub est conçue pour l’intégration d’événements bidirectionnels à grande échelle avec Salesforce. Utilisez l'API Pub/Sub pour publier et vous abonner efficacement à des messages d'événements binaire sous le format Apache Avro. L'API Pub/Sub est basée sur gRPC et HTTP/2, et utilise un modèle pull-based afin de contrôler le flux d'abonnement. Avec l'API Pub/Sub, vous pouvez utiliser l'un des 11 langages de programmation pris en charge par gRPC.

Utilisez le type d'événement de flux qui répond à vos besoins.

• Capture des données de modification : Recevez les modifications d'enregistrements Salesforce avec tous les champs modifiés. La Capture des données de modification prend en charge un plus grand nombre d'objets standard que les événements PushTopic, et offre davantage de fonctionnalités, notamment des champs d'en-tête qui contiennent des informations sur la modification.
• Événement de plate-forme : Publiez et recevez des charges de travail personnalisées avec un schéma prédéfini. Les données peuvent correspondre à n'importe quel élément que vous définissez, y compris des données métiers, par exemple des informations de commande. Spécifiez les données à envoyer en définissant un événement de plate-forme. Abonnez-vous à un canal d'événements de plate-forme pour recevoir des notifications.
• Événements hérités : Événement PushTopic et générique : Les événements PushTopic et génériques sont des événements de première génération. Ils offrent un support limité et ne sont plus mis à jour avec de nouvelles fonctionnalités. Nous recommandons d'utiliser les événements Capture de données de modification au lieu des événements PushTopic et d'événements de plate-forme au lieu d'événements génériques.

Consultez Pub/Sub API documentation.