Jetons d'authentification API

Les jetons d'authentification sécurisent l'accès :

à la Webbox lorsque le centre de contact gère une activité de chat et/ou Web Callback,
aux API REST exposées par Unified.

Chaque jeton est soumis à une période de validité : après expiration, il ne vous permet plus d'accéder aux ressources demandées.

Attention : ces jetons doivent rester confidentiels, autant que possible.

Au sommaire

Vue d'ensemble
Créer un jeton pour la Webbox
Créer un jeton pour les API
Définir les URL autorisées à un jeton
Modifier un jeton
Supprimer un jeton

Vue d'ensemble

Cette fonctionnalité est accessible dans le menu Administration > Tenants > Jetons d'authentification API. La partie supérieure de l'écran affiche la liste de tous les jetons d'authentification API existants. Chaque ligne du tableau correspond à un jeton :

Pour chacun d'eux, vous pouvez visualiser :

son identifiant unique attribué par le système,
son état matérialisé par un témoin de couleur,
son nom,
la date de début de validité du jeton,
la date de fin de validité du jeton,
la date et l'heure de dernière modification,
le nom de l'utilisateur l'ayant créé ou modifié,
les actions possibles matérialisées par une icône.

Créer un jeton pour la Webbox

Cette procédure est à suivre uniquement si le centre de contact gère une activité de chat et/ou Web Callback au moyen de la Webbox d'Unified. Dans ce cas, il est obligatoire de générer un jeton d'authentification qui permettra à la Webbox de communiquer avec AIP, le service exposant les API publiques d'Unified. Ce jeton sera d'ailleurs requis pour effectuer la configuration minimale de la Webbox. Par défaut, il accède à toutes les API nécessaires au fonctionnement de la Webbox. Associé à un ou plusieurs domaines, la requête utilisant le jeton doit provenir d'un domaine autorisé.

Attention : ce jeton est strictement réservé à l'usage de la Webbox. Il ne doit en aucun cas être utilisé pour un autre type d'intégration.

Dans l'onglet Administration, cliquez sur Tenants > Jetons d'authentification API.
Cliquez sur le bouton Créer un jeton.
Saisissez obligatoirement le nom du jeton.
Renseignez éventuellement une description relative à son usage.

Saisissez obligatoirement la période de validité du jeton (dates de début et de fin).
Cliquez sur Enregistrer pour valider votre saisie.

Unified attribue un identifiant unique au jeton : c'est ce code qui est utilisé par la requête afin d'autoriser l'accès à l'API REST publique d'Unified. Il doit rester confidentiel. Le jeton est ajouté à la liste existante.

Créer un jeton pour les API

Unified expose des API REST publiques lui permettant de communiquer et d'échanger avec n'importe quelle application. Celles-ci vous permettront de réaliser diverses actions sans passer par l'interface graphique d'Unified. Ces API peuvent être utilisées dans tout projet d'intégration avec un autre logiciel.

L'accès à ces API se fait de manière sécurisée au moyen d'un jeton d'authentification que vous devez paramétrer ici. Celui-ci possède un identifiant unique (UUID) généré par le système à sa création. Il est envoyé dans le header de la requête pour chacune des requêtes du client vers le serveur de ressources.

Dans l'onglet Administration, cliquez sur Tenants > Jetons d'authentification API.
Cliquez sur le bouton Créer un jeton.
Saisissez obligatoirement le nom du jeton.
Renseignez éventuellement une description relative à son usage.

Saisissez obligatoirement la période de validité du jeton (dates de début et de fin).
Cliquez sur Enregistrer pour valider votre saisie.

Cliquez sur l'onglet Liste des URLs.

Vous devez indiquer ici toutes les API d'Unified auxquelles ce jeton d'authentification peut avoir accès :
attachment : pièces jointes rattachées aux dossiers.
campaign : campagnes d'appels sortants (uniquement l'import de panélistes dans cette version).
document : documents rattachés aux dossiers (uniquement les enregistrements des appels dans cette version).
interaction : échanges réalisés au cours d'un dossier.
thread : gestion des dossiers.
user : pilotage de l'interface utilisateur.

Cliquez sur le bouton Ajouter.
Saisissez strictement en minuscules le nom de l'API à autoriser.
Cliquez sur Enregistrer.

Répétez les étapes 8 à 10 pour chaque ressource à autoriser.

Définir les URL autorisées à un jeton

Cette action est possible une fois que le jeton est créé. Vous pouvez définir les URL autorisées, en sachant qu'un jeton est associé à un ou plusieurs domaines.

Dans l'onglet Administration, cliquez sur Tenants > Jetons d'authentification API.
Sélectionnez, dans la liste, le jeton concerné.
Cliquez sur l'onglet Liste des URLs.
Cliquez sur Ajouter.
Saisissez directement l'URL dans le champ dédié. Les expressions régulières sont autorisées.
Cliquez sur Enregistrer pour valider la saisie.

Si nécessaire, vous pouvez modifier ou supprimer à tout instant une URL de la liste à l'aide des fonctions correspondantes.

Modifier un jeton

Cette action vous permet notamment de révoquer un jeton, c'est-à-dire de le rendre inutilisable même si sa période de validité n'est pas encore arrivée à expiration.

Attention : en cas d'ajout d'une nouvelle API (thread, attachment, etc.), un délai de quelques minutes est nécessaire pour que la modification soit prise en compte par AIP, le portail exposant les API publiques d'Unified.

Dans l'onglet Administration, cliquez sur Tenants > Jetons d'authentification API.
Cliquez sur le bouton Modifier () situé sur la ligne du jeton concerné.
Effectuez les modifications souhaitées.
Précisez éventuellement si le jeton doit être révoqué ou non.
Cliquez sur Valider pour enregistrer votre saisie.

Supprimer un jeton

Dans l'onglet Administration, cliquez sur Tenants > Jetons d'authentification API.
Cliquez sur le bouton Supprimer () situé sur la ligne du jeton concerné.

Unified vous demande de confirmer cette action.

Cliquez sur Valider.

Unified met à jour immédiatement la liste : le jeton supprimé n'y figure plus.