• Accueil / Salesforce / Résumés Salesforce –…
, Résumés Salesforce &#8211; Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Résumés Salesforce – Exploration de l’API REST de Salesforce1 minutes de lecture


SalesforceSummaries : une série qui livre clé des informations sur les vidéos YouTube de Salesforce, pour vous faire gagner du temps en vous tenant au courant des dernières évolutions technologiques au sein de l’écosystème Salesforce.

Introduction:

L’API REST de Salesforce est le moyen le plus courant d’intégrer des services tiers. Cette présentation traite de l’API REST de Salesforce et des différentes approches pour créer des requêtes API REST plus efficaces ; qui sont particulièrement utiles pour les utilisateurs mobiles.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Des détails: ‘Exploration de l’API REST de Salesforce

Présentateur: Jay Hurst

Temps: 48 minutes

Mots clés: API REST Salesforce, API composite, Ressource REST de traitement par lots

[email protected] — Salesforce a beaucoup travaillé pour améliorer l’API REST de Salesforce afin de la rendre plus efficace et moins lourde à utiliser.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — La couche d’intégration (à droite) est l’API. Le système Salesforce a été conçu pour être d’abord une API. La couche d’intégration est le point d’entrée du programme si vous entrez dans le système Salesforce depuis l’extérieur de Salesforce.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Il y a environ 9 ans, Salesforce a sorti l’API REST de Salesforce (api version 22.0). L’API Salesforce SOAP a été créée avant l’API REST Salesforce. Ce que Salesforce voulait, c’était prendre la fonctionnalité existante de l’API SOAP, qui s’est avérée très efficace, et exposer les points de terminaison REST par-dessus. Ainsi, chaque fois que vous appelez l’API SOAP ou REST de Salesforce pour créer un enregistrement de compte, par exemple, vous appelez en fait la même API à l’intérieur de la couche Java de Salesforce. Salesforce ne crée donc qu’une seule couche d’API mais avec deux points d’entrée différents.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — L’API REST Salesforce est synchrone, mais il existe des API Salesforce RESTful qui traitent de manière asynchrone (par exemple, l’API BULK). le API REST de Salesforce est le mieux adapté pour les navigateurs ou les applications mobiles qui n’ont pas besoin d’accéder à un grand nombre d’enregistrements.

L’API REST de Salesforce prend en charge à la fois XML et JSON.

[email protected] — L’anatomie d’un appel d’API REST est comme ci-dessous :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

/services/données est l’API REST de Salesforce. Si vous utilisez /services/async, il s’agit de l’API BULK et /services/SOAP est l’API SOAP.

Chaque fois que Salesforce publie une nouvelle version (3 par an), la version de l’API augmente progressivement. Si de nouvelles fonctionnalités apparaissent dans une version particulière de Salesforce, elles sont alors liées à cette version et non aux versions précédentes. Mais tout votre code existant qui s’exécute sur une ancienne version continuera à s’exécuter (rétrocompatible). Salesforce ne retire traditionnellement pas les versions d’API. Il est recommandé de conserver vos versions d’API jusqu’aux versions d’API ultérieures (essayez d’avoir moins de 6 versions d’API).

[email protected] — Avec l’API REST, à partir d’une seule requête, vous obtenez une seule réponse.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Dans ce diagramme, l’utilisateur effectue un appel CREATE, DESCRIBE et LIMITS. L’utilisateur envoie la demande CREATE, qui va au point de terminaison REST Salesforce, qui renvoie ensuite une réponse de la base de données Salesforce au client. L’utilisateur peut alors faire un appel DESCRIBE puis un appel LIMITs. C’est le modèle traditionnel avec REST – vous avez une ressource, vous passez l’appel, vous obtenez une réponse, puis vous faites quelque chose avec cette réponse.

Salesforce demande ‘comment rendre ce processus REST plus efficace ?‘.

[email protected] — Une API composite est une API qui est construite en combinant des fonctions API existantes. Ainsi, au lieu d’avoir 3 appels distincts (selon le schéma ci-dessus qui montrait les appels CREATE, DESCRIBE et LIMITS), cela peut peut-être se résumer à deux ou même un appel, et laisser le serveur exécuter la logique qui se cache derrière ces appels. Ainsi, au lieu d’encourir le coût d’aller du client au serveur plusieurs fois, vous pouvez avoir un seul aller-retour du client au serveur, mais le serveur peut effectuer plusieurs traitements.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Si vous souhaitez créer un contact, vous devez d’abord disposer d’un compte à associer à ce contact. Et donc, vous auriez besoin de deux appels : un pour créer le compte, renvoyer le account.id, puis créer l’enregistrement de contact par rapport au account.id. Ce n’est pas aussi efficace qu’il pourrait l’être car idéalement, un développeur utiliserait les réponses d’une méthode API comme entrées dans une autre méthode. De cette façon, plusieurs API peuvent être utilisées dans un seul appel pour améliorer les performances.

Compositions sont de plus en plus importants pour la conception d’API efficaces à utiliser dans le développement mobile. Appels qui poussent moins de données = plus efficaces.

[email protected] — L’une des ressources composites disponibles est le ressource REST par lots. Vous pouvez regrouper jusqu’à 25 appels de demande en un seul appel JSON que le serveur Salesforce traite en série. Salesforce renverra une réponse sérialisée. Cela peut réduire les allers-retours. Les requêtes d’un lot sont appelées sous-requêtes et sont toutes exécutées dans le contexte du même utilisateur. Les sous-requêtes sont indépendantes et vous ne pouvez donc pas transmettre d’informations entre elles.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] – Avec le TreeSave ressource REST, vous pouvez insérer plusieurs enregistrements dans un seul appel. Par exemple, créez un compte, puis 3 contacts pour ce compte.

[email protected] — Vous avez la possibilité de définir ce que vous voulez et de l’exposer en tant que point de terminaison REST. Vous pouvez donc créer un composite par exemple pour créer plusieurs choses, mais il sera plus facile de tirer parti des ressources composites déjà existantes de Salesforce.

[email protected] — La ressource Batch REST n’est pas adaptée si vous souhaitez effectuer une manipulation transactionnelle car ce n’est pas une approche « tout ou rien ». Au lieu de cela, si une sous-demande échoue, elle passera à la sous-demande suivante et toutes les sous-demandes réussies avant cela ne seront pas annulées.

Il existe un paramètre facultatif — haltOnError — qui empêcherait l’exécution des autres appels série.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Dans l’exemple ci-dessous, si l’on voulait créer 2 comptes, 3 contacts, 2 cas et 2 tâches via l’API REST, cela prendrait 9 appels d’API différents. Voilà à quoi cela ressemblerait :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Cependant, en utilisant l’API REST par lots, on peut regrouper les demandes dans un seul fichier .json (corps), puis envoyer ce corps à un seul appel d’API.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Le serveur Salesforce traitera chacune des sous-requêtes en série, puis transmettra les résultats au format .json.

[email protected] — Voici à quoi ressemble un exemple de requête par lots :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] – Table de travail continue d’être l’un des moyens les plus populaires d’explorer l’API REST de Salesforce. Si vous accédez à l’explorateur de repos dans Workbench et faites une demande GET à /services/data/vXX.X (par exemple, v41.0), vous renverrez une liste de tous les types d’API disponibles.

Vous remarquerez que différentes fonctionnalités ne sont disponibles que dans les versions ultérieures de l’API. Par exemple, si vous comparez la version 41.0 de l’API (actuelle, à partir de Spring ’18) à la version la plus ancienne de l’API REST (22.0), vous pouvez voir comment l’offre REST de Salesforce s’est développée.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Vous pouvez cliquer sur l’un des types d’API, puis vous verrez une liste de sous-arborescence des différentes options qui s’offrent à vous. Par exemple, si vous cliquez sur le type d’API des limites, vous serez dirigé vers une page qui ressemble à ceci. Cette page vous détaille toutes les limites.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Pour faire une requête par lots, saisissez /services/data/v37.0/composite/batch, sélectionnez « POST » et saisissez un corps de requête comme ceci :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Selon le corps de la requête, celui-ci est au format JSON et trois appels indépendants sont écrits. Vous remarquerez que vous n’avez pas besoin de vous lier à la même version d’API d’où provient l’appel.

Le premier appel est un POST (création) sur le sObject du compte. Deux champs sont en train d’être remplis : Nom et Industrie. Le deuxième appel obtient toutes les métadonnées du sObject du compte. L’appel final est un GET vers la ressource de requête et l’exécution d’une requête pour tous les comptes classés par la date de création.

[email protected] — Lors de l’exécution, les résultats sont renvoyés. Vous pouvez sélectionner « Afficher la réponse brute », qui renvoie la réponse au format JSON, ou vous pouvez utiliser la structure de fichier de sous-arborescence à la place.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Vous pouvez voir pour la réponse du troisième appel que c’était un succès (réponse 200 Http) et vous pouvez voir la liste des comptes qui ont été sélectionnés dans la requête. Vous remarquerez que le compte « NewName » a été ajouté à la réponse car il a été créé au moment de l’exécution de la requête (car le compte a été créé lors du premier appel et la requête était lors du troisième appel).

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Si vous saisissez une syntaxe incorrecte pour l’un des appels d’API dans le corps de la requête, vous remarquerez que la réponse contiendra des erreurs.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — La façon dont l’API REST de Salesforce est conçue à l’heure actuelle est qu’elle ne peut accepter qu’un seul URI par requête et que vous ne pouvez donc pas transmettre un tableau dans l’URI.

[email protected] — La ressource TreeSave est une structure de données récursive. Une seule requête peut contenir jusqu’à 200 enregistrements dans toutes les arborescences. Par exemple, vous pouvez créer 1 enregistrement de compte et 199 contacts.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Le diagramme de l’API TreeSave ressemble à :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Pour poster des contacts sous le compte, l’URI serait /services/data/v37.0/composite/tree/Compte

[email protected] — Pour le moment, seule l’opération INSERT DML est prise en charge pour TreeSave. Les sauvegardes partielles ne sont pas prises en charge. La transaction n’est pas terminée tant qu’elle n’est pas réussie à 100 %. Tout sera annulé s’il y avait une erreur.

Des limites de gouverneur distinctes sont appliquées à chaque niveau de l’arborescence.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Dans cet exemple, un tableau de comptes est en cours d’insertion et quelques contacts (enfants).

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Le haut de chaque niveau a une balise d’attribut, qui fait référence au type de sObject et à l’ID de référence. Ensuite, le nom du champ — les valeurs sont spécifiées.

[email protected] — La réponse ressemble à ci-dessous :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

Le sObject de niveau supérieur retournerait en premier dans la réponse, mais le traitement des enregistrements enfants n’est pas déterministe et vous ne pouvez pas écrire de logique pour dire « ce sObject enfant doit être créé en premier ».

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] –

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] –

Avec un API composite, vous pouvez profiter des avantages de la demande par lots et du TreeSave ensemble. Cela se traduit par une structure Web (pas une structure arborescente), dans la mesure où vous pouvez appliquer différentes méthodes d’API REST sur des données liées ou non.

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

[email protected] — Vous trouverez ci-dessous un exemple de requête d’API composite :

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>

, Résumés Salesforce – Exploration de l&rsquo;API REST de Salesforce<span class="wtr-time-wrap after-title"><span class="wtr-time-number">1</span> minutes de lecture</span>



Source de l’article traduit automatiquement en Français

Besoin d'aide ?
Vous utilisez Pardot depuis un certain temps mais vous n'êtes pas sûr d'en
exploiter tout le potentiel

Notre analyse de votre Pardot offerte dès aujourd'hui
Merci, vous pouvez compléter notre questionnaire
Nous allons revenir vers vous rapidement !

Fermer