Connecteur Salesforce

Introduction

Salesforce est une plateforme logicielle CRM basée sur le cloud, utilisée dans des applications allant du suivi des prospects à la gestion des commandes et des stocks.

Objectif

Ce document décrit en détail le connecteur API REST Salesforce disponible dans la bibliothèque Tulip. Une fois configurées, ces fonctions de connecteur peuvent être utilisées pour récupérer, interroger et modifier des données Salesforce à partir d’une application Tulip.

Documentation de l'API

La documentation relative à l’API REST de Salesforce est disponible ici. Notez que certaines fonctions de connecteur présentées dans cet article effectuent des requêtes à l’aide du langage SOQL (Salesforce Object Query Language), dont la syntaxe complète est documentée ici.

Première configuration

L'authentification de l'API Salesforce suit les normes OAuth 2.0. La procédure suivante décrit comment générer un jeton d'actualisation, qui sera ensuite utilisé par n'importe quelle application Tulip pour récupérer le jeton d'accès nécessaire à la connexion à Salesforce.

1. Créez une application connectée dans Salesforce. Pour ce faire, accédez à l’espace « Configuration » dans Salesforce. Ensuite, accédez à OUTILS DE LA PLATEFORME >> Applications >> Applications connectées >> Gérer les applications connectées.
2. Créez une nouvelle application connectée. Indiquez : a. tous les champs d’application requis par votre application, mais veillez à inclure refresh_token. b. Sélectionnez « Activer les paramètres OAuth », puis saisissez l’URL de rappel sous la forme https://login.salesforce.com/services/oauth2/success.
3. Une fois cette étape terminée, cliquez sur « Gérer les détails du consommateur » pour afficher votre « Clé de consommateur » et votre « Secret de consommateur ». Vous en aurez besoin ultérieurement.
4. À présent, dans Tulip, ouvrez l’ Connector Function [Configuration] URL d’obtention du code d’autorisation. Copiez-collez la « Clé consommateur » générée à l’étape 3 ci-dessus en tant que paramètre de requête client_id.
5. « Exécutez » le connecteur « Connector Function ».
6. Vous constaterez qu’une URL a été générée en tant que « Sortie » du connecteur. Collez cette URL dans la fenêtre de votre navigateur.
7. Suivez les instructions d’authentification qui s’affichent pour autoriser Tulip à interagir avec votre instance Salesforce.
8. En cas de réussite, votre navigateur devrait vous rediriger vers une nouvelle page intitulée « Autorisation de l’application d’accès à distance ». Le code d’autorisation se trouve dans l’URL de cette page. Par exemple, dans l’URL https://login.salesforce.com/services/oauth2/success?code=asdf1234, le code d’autorisation est asdf1234.
9. Enregistrez ce code d’autorisation. Notez que le code doit se terminer par deux signes égal : ==. Si le code se termine par %3D%3D, supprimez ces caractères et remplacez-les par ==.
10. Accédez à la page [Configuration] Obtenir un jeton d'actualisation de Tulip Connector Function. Dans les paramètres de requête, collez toutes les informations recueillies ci-dessus :
    • grant_type= authorization_code
    • redirect_uri= https://login.salesforce.com/services/oauth2/success
    • client_id= la clé consommateur de l’étape 3 ci-dessus
    • client_secret= le secret du consommateur de l'étape 3 ci-dessus
    • code= le code d’autorisation de l’étape 9 ci-dessus
11. Exécutez ce connecteur et enregistrez le refresh_token qui apparaît dans la réponse.
12. Enfin, accédez à la page [Auth] Obtenir un jeton d'accès Connector Function. Remplissez les paramètres de requête suivants :
    • grant_type= authorization_code
    • client_id= la clé du consommateur de l'étape 3 ci-dessus
    • client_secret = le secret du consommateur de l'étape 3 ci-dessus
    • refresh_token = le jeton de rafraîchissement de l'étape 10 ci-dessus
13. Exécutez le connecteur. Notez que la réponse inclut un access_token, qui est mappé en tant que sortie. Enregistrez le connecteur pour conserver le jeton de rafraîchissement

Dès que cette fonction est capable de générer un access_token, la configuration est terminée ! Cet access_token peut désormais être utilisé dans toute Connector Function ultérieure, tant que les paramètres de délai d’expiration configurés à l’étape 2 le permettent.

Détails de connexion à Tulip

Pour permettre à vos connecteurs de s’interfacer avec Salesforce, saisissez le sous-domaine de votre instance Salesforce en tant que « sous-domaine par défaut », dans les détails de connexion du connecteur. Par exemple, si l’instance Salesforce est accessible à l’adresse sample.my.salesforce.com, le sous-domaine par défaut doit être sample.my.

Notez que tous les connecteurs « Connector Functions » sont conçus pour fonctionner avec l’API REST Salesforce v46.0.

Connector Functions

Il existe deux types principaux de connecteurs : les connecteurs de type objet et les connecteurs de type requête. Notez que ces deux types de connecteurs nécessitent un access_token; veillez donc à exécuter [Auth] Obtenir un jeton d’accès dans votre application avant de les utiliser ! Il est généralement recommandé de générer un nouveau jeton d’accès au démarrage de l’application ou du processus, puis de l’enregistrer dans une variable d’application pour une utilisation ultérieure.

Connecteurs de type objet

• Renvoient tous les champs de l’objet en question.
• Utilisez le point de terminaison ./services/data/v46.0/sobjects/<Nom de l’objet>/<ID de l’objet>
• Exemple : connecteur [Opportunity] Get All Fields

Connecteurs de type requête

• Renvoient uniquement les champs spécifiés dans la requête.
• Peuvent renvoyer des informations liées (par exemple, le nom du compte associé à une opportunité) ou agrégées (par exemple, le nombre d'enregistrements).
• Utilisez le point de terminaison ./services/data/v46.0/query
• Nécessite la rédaction d'une requête en SOQL (documentation ici{target=_blank}).
• Exemple : Connecteur [Commande] Récupérer toutes les commandes dont le statut est

Inclus Connector Functions

Les « Connector Functions » suivantes sont incluses dans ce pack et sont destinées à servir d’introduction aux fonctions disponibles via l’API Salesforce :* [Setup] Récupérer l’URL du code d’authentification & [Setup] Récupérer le jeton de rafraîchissement * Utilisées uniquement pour la configuration initiale. Voir ci-dessus pour plus d’informations.*[Auth] Récupérer le jeton d’accès * Utilisé pour générer un jeton d’accès, qui doit être inclus dans toutes les Connector Functions ultérieures.* Fonctions [Opportunité] : * Récupérer tous les champs * Renvoie tous les champs de l’opportunité interrogée. Nécessite un jeton d’accès et un ID d’opportunité. * Modifier le stade * Met à jour le stade de l’opportunité indiquée avec la valeur spécifiée.* Fonctions [Commande] : * Récupérer toutes les commandes d’un statut donné * Renvoie une liste de toutes les commandes présentant un statut spécifié . * Compter les commandes d’un statut donné * Renvoie le nombre total de commandes présentant un statut spécifié. * Récupérer le numéro de commande à partir de l’ID * Renvoie le numéro de commande à partir d’un ID de commande spécifié.

Pour adapter ces fonctions à vos besoins, veuillez tenir compte des conseils ci-dessous : 1. Pour modifier une requête de type objet Connector Functions, il suffit de changer l’objet indiqué dans l’URL. Ajoutez ou supprimez des sorties selon vos besoins. 2. Pour modifier les requêtes de type Connector Functions, toutes les modifications doivent être effectuées dans la requête. Celle-ci se trouve dans les paramètres de requête, avec la clé q. 1. Astuce : limitez le nombre de réponses d’une requête à l’aide de la fonction LIMIT(nombre_de_réponses)

Avez-vous trouvé ce que vous cherchiez ?

Vous pouvez également vous rendre sur community.tulip.co pour poser votre question ou voir si d’autres utilisateurs ont rencontré un problème similaire !