Configurer une connexion Web Service

À quoi ça sert

Une connexion Web Service déclare une API externe que le CRM peut interroger : l'adresse du service et la façon de s'y authentifier. Une fois la connexion créée, vous l'utilisez sur des champs de type « Web Service » ou « Source Web Service », qui affichent sur la fiche des données venues de ce service — un solde de fidélité, un historique de réservations, un état d'abonnement.

L'écran se trouve dans « CRM », « Administration », carte « Connexions Web Service ». Il est réservé aux administrateurs du module CRM.

Le paramétrage des champs qui consomment ces connexions est décrit dans Champs Web Service.

Concepts clés

• Connexion — un nom, une URL de base et un mode d'authentification.
• URL de base — l'adresse racine du service. Les chemins configurés sur les champs s'ajoutent à cette adresse.
• Type d'authentification — la façon dont le CRM prouve son identité au service.
• Valeur d'authentification — la clé ou le jeton. Elle est chiffrée et n'est plus affichée après enregistrement.
• Headers supplémentaires — des en-têtes personnalisés envoyés à chaque requête.
• Connexion active — une connexion inactive cesse de rapporter des données aux champs qui l'utilisent, exactement comme si elle avait été supprimée.

Comment faire

Créer une connexion

1. Ouvrez « CRM », « Administration », puis « Connexions Web Service ».
2. Cliquez sur « Nouvelle connexion ». Un volet s'ouvre sur la droite.
3. Saisissez le « Nom », par exemple « API Clients ».
4. Saisissez l'« URL de base », par exemple https://api.example.com.
5. Choisissez le « Type d'authentification » et complétez les champs qui apparaissent.
6. Renseignez la « Valeur d'authentification » si le type en demande une.
7. Ajoutez les « Headers supplémentaires » nécessaires avec « Ajouter un header ».
8. Laissez « Active » activé, puis cliquez sur « Enregistrer ».

Le message « Connexion créée avec succès » s'affiche et la connexion apparaît dans le tableau.

Tester une connexion

1. Ouvrez la connexion, ou restez dans le volet de création.
2. Cliquez sur « Tester ».
3. Dans la fenêtre qui s'ouvre, saisissez le « Chemin de test » à interroger, / par défaut.
4. Cliquez sur « Tester ».

Le message « Connexion réussie » s'affiche en cas de succès, « Échec de la connexion » suivi du message renvoyé par le service sinon.

En modification, laisser la « Valeur d'authentification » vide fait reprendre le secret déjà enregistré : il n'est pas nécessaire de le ressaisir pour tester.

Modifier une connexion

1. Ouvrez « Connexions Web Service » et cliquez sur la ligne de la connexion.
2. Modifiez les valeurs voulues. Le bouton « Enregistrer » s'active dès qu'une valeur change.
3. Cliquez sur « Enregistrer ».

Le message « Connexion mise à jour avec succès » s'affiche.

Consulter l'historique d'une connexion

1. Ouvrez la connexion.
2. Cliquez sur l'icône « Historique » dans l'en-tête du volet.

Les changements sont listés du plus récent au plus ancien, avec leur date et l'auteur : « Connexion créée », « Connexion mise à jour », « Connexion supprimée ».

Désactiver une connexion

1. Ouvrez la connexion.
2. Désactivez « Active », puis cliquez sur « Enregistrer ».

La connexion reste déclarée, mais les champs qui s'appuient dessus cessent de rapporter des données.

Supprimer une connexion

1. Ouvrez la connexion.
2. Cliquez sur « Supprimer », en bas à gauche du volet.
3. Lisez l'avertissement, puis confirmez par « Supprimer ».

Le dialogue demande « Supprimer cette connexion ? » et prévient : « Les champs Web Service utilisant cette connexion ne pourront plus récupérer de données. » Vérifiez donc, avant de supprimer, quels champs s'appuient sur la connexion : ils resteront en place mais n'afficheront plus rien.

Référence

Champs de la connexion

Les six types d'authentification

Le type « Visor » vise un système externe précis. Il demande le contenu des fichiers de certificat au format PEM, stockés chiffrés, et propose en plus une « Authentification applicative Visor » à activer si le service est en mode sécurisé : nom d'utilisateur, mot de passe et « Timeout de session (secondes) », 10 secondes par défaut. Une aide dans le formulaire rappelle les précautions à prendre, notamment l'ajout d'un header RequestFormat=JSON.

Boutons de test selon le type

« Tester (mTLS seul) » interroge le chemin que vous saisissez, sans l'authentification applicative. « Tester avec auth applicative » interroge un chemin de vérification imposé et ignore le « Chemin de test » saisi.

Le tableau des connexions

Colonnes : « Nom », « URL de base », « Type d'authentification », « Statut » (Active ou Inactive). Sans connexion : « Aucune connexion configurée ».

Où les connexions sont utilisées

Les deux exigent qu'une connexion soit choisie ; à défaut, le champ ne peut pas être enregistré. Le sélecteur de connexion propose aussi les connexions inactives : vérifiez le statut avant de choisir.

Messages

Questions fréquentes

Puis-je revoir la clé ou le jeton après l'avoir enregistré ? Non : « Cette valeur est chiffrée et ne sera plus visible après enregistrement. » Pour en changer, saisissez la nouvelle valeur et enregistrez.

Que se passe-t-il pour les champs si je supprime la connexion ? Ils restent en place mais n'affichent plus rien : « Les champs Web Service utilisant cette connexion ne pourront plus récupérer de données. » Désactiver la connexion produit le même effet, de façon réversible.

Puis-je utiliser la même connexion sur plusieurs entités ? Oui. Une connexion est déclarée une fois pour l'organisation et se choisit ensuite sur autant de champs que nécessaire.

Faut-il ressaisir le secret pour tester une connexion existante ? Non. Laissez « Valeur d'authentification » vide : le test reprend le secret déjà enregistré.