introduction
Que vous soyez un développeur Salesforce de longue date, que vous débutiez sur la plate-forme ou que vous ayez simplement besoin d’intégrer le système de votre choix à Salesforce, Postman vous apporte tous les outils dont vous avez besoin pour rendre le processus plus facile, plus rapide et plus rationalisé.
Dans cet article, nous montrerons comment Postman peut vous aider à commencer à construire le cœur de votre intégration basée sur l’API sur les deux côtés de l’API, que ce soit en tant que fournisseur ou consommateur.
Développement d’API Salesforce
Alors que Salesforce dispose de plusieurs applications prédéfinies pour des tâches commerciales clés telles que les ventes, le service et le marketing, dans cet article, nous nous concentrerons sur la capacité de Salesforce en tant que plate-forme de développement, avec son propre langage de programmation : Apex.
Salesforce peut exposer des services codés sur mesure à des applications tierces, sous forme de services Web SOAP ou d’API REST. Dans notre démo, nous développerons une API REST très légère et montrerons comment Postman peut accélérer ce processus.
Comment Postman accélère le développement
L’un des cas d’utilisation les plus populaires de Postman consiste à explorer l’API d’applications tierces, afin de mieux comprendre comment soumettre des demandes et à quoi s’attendre pour les réponses. En voyant les demandes et les réponses, développer votre propre code pour gérer ces API devient beaucoup plus facile. Nous pouvons également développer une implémentation de serveur fictif de notre propre API, qui génère les réponses attendues. De cette façon, nous n’avons pas besoin d’attendre une « vraie » implémentation de l’API avant de pouvoir commencer à la développer. En utilisant les outils de Postman pour le développement d’API, nous pouvons rapidement prototyper une API REST Salesforce avant l’API (et le code qui l’utilise) a terminé son développement.
Le rassembler
Comme première étape, nous utiliserons l’une des fonctionnalités les plus puissantes de Postman : des serveurs fictifs.
Serveurs fictifs
Un serveur fictif est une interface serveur légère qui répond de manière réaliste à vos demandes d’API, vous permettant d’obtenir rapidement et facilement une réponse valide sans trop vous soucier des détails. Avec Postman, vous pouvez démarrer un serveur fictif qui répond aux requêtes HTTP de votre conception en très peu de temps, sans aucun codage requis. En pointant votre code sur ce serveur fictif, vous pouvez écrire et tester votre code consommateur d’API.
Nous utiliserons le client Desktop pour nos exemples, mais tout ici devrait être également applicable avec le client Web de Postman. Des serveurs fictifs peuvent être trouvés dans votre espace de travail dans Postman.
Création et configuration du serveur fictif
Cliquer sur Créer un serveur fictif pour commencer.
Ensuite, nous pouvons commencer à définir les requêtes HTTP que nous aimerions simuler. En spécifiant la méthode de requête HTTP, l’URL, le code de réponse et le corps de la réponse, nous pouvons indiquer à Postman comment répondre aux requêtes.
Dans cet exemple, nous nous moquons d’une demande d’enregistrement de compte Salesforce. Plutôt que de coder en dur un compte Salesforce id, nous utilisons la capacité de Postman à utiliser des variables. En faisant correspondre la variable à la fois dans la demande et dans la réponse, nous pouvons renvoyer la valeur fournie dans la demande. Nous utiliserons cette fonctionnalité plus en détail plus tard.
Pour l’instant, nous allons juste nous moquer de cette demande et cliquer sur le bouton Prochain pour finaliser notre configuration de serveur fictif avec quelques paramètres supplémentaires.
En plus de nommer le serveur fictif, nous allons simplement nous en tenir aux valeurs par défaut et cliquer sur le Créer un serveur fictif bouton. Cela créera notre instance de serveur fictif avec une URL unique pour recevoir des demandes, comme illustré ci-dessous.
Étant donné que nous avons sélectionné l’option d’enregistrer l’URL du serveur fictif en tant que variable d’environnement, il existe cependant un moyen plus simple de référencer cela. Si nous développons la liste déroulante de l’environnement en haut à droite de Postman, nous verrons qu’un environnement a été automatiquement créé pour nous.
Si nous sélectionnons cet environnement, l’URL du serveur fictif est automatiquement renseignée pour nous dans un paramètre appelé {{url}}. Le processus de création d’un nouveau serveur fictif a également créé une nouvelle collection Postman pour nous. Cette collection a notre demande, et la demande est prête à être renseignée avec des paramètres, le cas échéant.
Lorsque nous sélectionnons cette demande, nous voyons l’interface utilisateur pour construire notre demande. En remplaçant le {{accountId}} variable dans la requête avec un exemple id et en envoyant la demande, nous devrions recevoir une réponse de notre serveur fictif qui répète que id retour vers nous.
Extension de la réponse fictive
Maintenant que notre serveur fictif de base fonctionne, nous pouvons étendre les réponses pour qu’elles soient plus significatives et réalistes. Développez l’exemple de demande dans notre collection à partir de l’arborescence de l’espace de travail et cliquez sur l’exemple (actuellement appelé « Par défaut »).
Nous allons apporter quelques modifications à la façon dont le serveur fictif répond à cette demande. Les attributes domaine n’est pas indispensable. Nous simulons simplement la réaction de Salesforce.
Dans l’onglet du corps de la réponse dans la section inférieure, remplacez le contenu par le JSON suivant :
{
"attributes" :
{
"type" : "Account",
"url" : "/services/data/v53.0/sobjects/Account/accountId"
},
"Id" : "{{accountId}}",
"Name" : "{{$randomCompanyName}}"
}Remarquez comment nous avons utilisé l’outil pratique de Postman $randomCompanyName variable. De nombreuses variables utiles peuvent être utilisées pour générer des exemples de données, documentées ici.
Dans l’onglet En-têtes de réponse dans la section inférieure, ajoutez un Content-Type clé avec la valeur application/json.
Cliquez sur sauvegarder pour mettre à jour l’exemple de réponse. Le serveur fictif répondra maintenant avec la réponse mise à jour à la demande que nous avons faite précédemment.
À ce stade, nous pouvons ajouter des demandes et des exemples supplémentaires à notre collection. Cliquez sur les points de suspension (...) à côté du nom de notre collection et sélectionnez Ajouter une demande pour en générer un nouveau. Ensuite, cliquez sur l’icône points de suspension à côté de la nouvelle demande et sélectionnez Ajouter un exemple. Cela ajoute un nouvel exemple de réponse que le serveur fictif servira à votre demande. Vous pouvez créer une nouvelle réponse de serveur fictif de la même manière que précédemment, en spécifiant de nouveaux chemins, verbes HTTP et réponses, jusqu’à ce que vous ayez rédigé votre API. À ce stade, nous pouvons même tester l’API depuis l’extérieur de Postman – l’un des moyens les plus rapides de le faire est via la fonctionnalité d’extrait de code de Postman. Cela permet un développement tout aussi rapide du code pour consommer l’API.
Extraits
Postman fournit des exemples de code pour appeler vos API, fictives ou non, dans plusieurs langages et bibliothèques. Avec une demande sélectionnée dans votre espace de travail, cliquez sur le bouton </> à droite pour développer le menu de l’extrait de code. À partir de là, vous pouvez sélectionner une combinaison langue/bibliothèque appropriée et voir l’exemple de code pour appeler votre API.
CORS est activé pour les serveurs fictifs Postman. Par conséquent, vous pouvez remplacer vos applications Web par des données fictives à l’aide des points de terminaison fictifs. Les applications Web de développement ou de production peuvent ensuite envoyer des demandes à votre point de terminaison fictif Postman et recevoir des exemples de réponses.
L’extrait de code résoudra les variables là où il le pourra. Dans notre exemple, où nous utilisons le {{url}} variable pour référencer notre Mock Server, ceci est développé pour nous. Ceci est illustré dans l’exemple de code JavaScript Fetch ci-dessous.
Note importante: cet extrait de code, tel que généré à partir de Postman, comporte une petite erreur. Les requêtes HTTP GET envoyées via Fetch doivent ne pas définir un corps dans la demande. Pour nos tests, nous devrons supprimer la ligne 5 dans l’exemple ci-dessus. Vous trouverez ci-dessous le code mis à jour, enveloppé dans une page HTML légère.
<html>
<head>
<script>
var raw = "";
var requestOptions = {
method: 'GET',
redirect: 'follow'
};
fetch("https://768bb73c-2824-49fa-8787-3967ce6ea0c1.mock.pstmn.io//Account/001000000WCFB8", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
</script>
</head>
<body>
<p>Check the browser console to see the output from our mock server.</p>
</body>
</html>
Sommaire
Dans cet article, nous avons examiné les bases de la configuration d’un serveur fictif dans Postman, de la création du serveur fictif et d’un exemple de réponse à son extension avec des données JSON plus significatives et à l’ajout de réponses supplémentaires. Nous avons également vu à quel point il est simple de générer des extraits de code qui montrent comment utiliser l’API dans le langage/la plate-forme de votre choix. Les extraits de code facilitent grandement le développement de vos propres outils qui utilisent votre API.
Avec les outils fournis par Postman, nous pouvons fournir une exigence technique à la fois à nos développeurs Salesforce mettant en œuvre l’API et à nos développeurs sur d’autres plates-formes communiquant avec Salesforce dans le cadre d’une intégration.
Il existe une multitude de ressources supplémentaires disponibles pour travailler avec Postman et Salesforce. Certains de ceux qui sont pertinents pour ce que nous avons couvert ici peuvent être trouvés ci-dessous :