Extension Salesforce

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Version: 1.0.5

Accéder aux données de votre compte Salesforce Insérez, mettez à jour, récupérez et interrogez les données.

Ce contenu fournit une documentation de référence pour configurer et utiliser cette extension.

Prérequis

Ce contenu fournit une documentation de référence pour configurer et utiliser cette extension. Avant d'utiliser l'extension à partir d'un proxy d'API à l'aide de la règle ExtensionCallout, vous devez:

1. Créez une paire clé privée/certificat RSA x509.

   Vous utiliserez la clé privée (.key) comme identifiant lors de la configuration de l'extension. Vous utiliserez le fichier de certificat (.crt) lorsque vous créerez une application connectée qui donnera à l'extension accès à Salesforce.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Configurez une application connectée.

   Une application connectée Salesforce permet d'accéder à l'extension Salesforce. Pour configurer l'application, consultez les instructions ci-dessous.

3. Obtenez la clé client de l'application connectée. L'extension l'utilisera lors de l'authentification auprès de l'application.

   1. Dans la configuration Salesforce, dans le panneau de navigation de gauche, accédez à Applications > Gestionnaire d'applications.
   2. Dans la liste, recherchez l'application connectée que vous avez créée.
   3. Dans le menu déroulant situé à droite de la ligne de l'application, cliquez sur Afficher.
   4. Sous API (Activer les paramètres OAuth), recherchez la clé client et copiez sa valeur dans un endroit sûr pour l'utiliser lors de la configuration de l'extension.

Configurer une application connectée pour l'accès de l'extension

Avant que l'extension Salesforce puisse accéder à Salesforce, vous devez créer une application connectée Salesforce via laquelle l'extension peut se connecter à Salesforce.

Dans Salesforce, une application connectée permet aux applications externes de se connecter à Salesforce via des API.

Pour configurer une application associée

1. Connectez-vous à Salesforce.
2. Cliquez sur l'icône en forme de roue dentée en haut à droite, puis sur Configuration.
3. Dans la barre de navigation de gauche, développez Applications > Gestionnaire d'applications.
4. Sur la page Gestionnaire d'applications, cliquez sur Nouvelle application connectée.
5. Sous Informations de base, renseignez les champs obligatoires. Les valeurs sont destinées à la comptabilité. Elles ne sont pas utilisées par l'extension.
6. Sous (API (Activer les paramètres OAuth), cochez la case Activer les paramètres OAuth.
7. Bien qu'elle ne soit pas utilisée par l'extension, saisissez une URL de rappel. Vous pouvez utiliser http://localhost/ ou un autre hôte d'espace réservé.
8. Cochez la case Utiliser des signatures numériques.
9. Sous Utiliser des signatures numériques, cliquez sur Sélectionner un fichier pour rechercher et importer le fichier salesforce.crt que vous avez généré précédemment.
10. Dans la section Niveaux d'accès OAuth sélectionnés, ajoutez les éléments suivants sous Niveaux d'accès OAuth sélectionnés :
    • Accéder à vos données et les gérer – API
    • Effectuer des requêtes en votre nom à tout moment – refresh_token, offline_access
11. Cliquez sur Enregistrer. En cas d'erreurs, vous devrez peut-être générer et importer de nouveau le fichier salesforce.crt.
12. Sur la page de l'application qui s'affiche, cliquez sur Gérer.
13. Sur la page Gestionnaire d'applications de l'application que vous venez de créer, cliquez sur Modifier les règles.
14. Sous Règles OAuth, cliquez sur le menu déroulant Utilisateurs autorisés, puis sur Les utilisateurs approuvés par l'administrateur sont pré-autorisés.
15. Cliquez sur Enregistrer.
16. De retour sur la page de l'application, sous Profils, cliquez sur Gérer les profils.

17. Sur la page Attribution du profil d'application, cochez les cases correspondant aux profils utilisateur pouvant utiliser cette application.

    Veillez à sélectionner un profil correspondant à l'utilisateur dont vous utiliserez le nom d'utilisateur lors de la configuration de l'extension. Assurez-vous également qu'au moins les utilisateurs Administrateur système ont accès à cette application.

    Vous pouvez afficher le paramètre de profil de l'utilisateur dans Salesforce. Dans la zone Configuration, développez Utilisateurs > Utilisateurs, recherchez l'utilisateur que l'extension représentera, puis recherchez son profil dans la colonne Profil.

18. Cliquez sur Enregistrer.

À propos de Salesforce

Salesforce est une plate-forme de gestion de la relation client (CRM, customer relationship management). La gestion de la relation client aide les entreprises à comprendre les besoins de leurs clients et à résoudre leurs problèmes en améliorant la gestion des informations et des interactions client, le tout sur une seule plate-forme toujours accessible depuis n'importe quel ordinateur ou appareil.

Actions

insert

Insérez les enregistrements en tant que types d'objets.

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Paramètres de requête

Réponse

Tableau results contenant les résultats de l'opération d'insertion.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

Mettez à jour les enregistrements Salesforce.

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Paramètres de requête

Réponse

Tableau results contenant les résultats de la mise à jour.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

retrieve

Récupérez les enregistrements en tant que sObjects par leur ID. Renvoie tous les champs du type sObject.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Paramètres de requête

Réponse

Tableau records d'objets sObject représentés au format JSON. Notez que toutes les propriétés des objets sont incluses dans le fichier JSON, même si la valeur de la propriété est nulle.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

Interrogez Salesforce.com à l'aide du langage SOQL (Salesforce Object Query Language).

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Paramètres de requête

Réponse

Résultats de la requête.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

Lister les enregistrements Salesforce.com Renvoie tous les champs du type d'objets sObject spécifié.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Paramètres de requête

Réponse

Tableau records contenant des sObjects listés au format JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

sup

Supprimez les enregistrements associés aux ID spécifiés.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Paramètres de requête

Réponse

Tableau results contenant les résultats de l'opération.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

Obtenez le jeton d'accès à l'API Salesforce.com. Peut être utilisé pour interroger des API REST.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Paramètres de requête

Aucune.

Réponse

Le jeton d'accès au format JSON.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Documentation de référence sur la configuration

Utilisez les éléments suivants lorsque vous configurez et déployez cette extension pour l'utiliser dans des proxys d'API.

Propriétés d'extension courantes

Les propriétés suivantes sont présentes pour chaque extension.

Propriétés de ce package d'extension

Spécifiez les valeurs des propriétés de configuration suivantes spécifiques à cette extension.