Actions API

Les actions API sont Studio actions qui vous permettent d'utiliser CXone Mpower API dans vos scripts. Vous pouvez utiliser l’action au lieu d’appeler l’API à l’aide de méthodes d’intégration traditionnelles telles que l’utilisation d’un extrait de code ou de l’action RestAPI. Les actions API sont toutes situées dans l’onglet Cadre dans Desktop Studio. Dans Studio, ils sont situés sur la palette Actions API.

Les actions API sont différentes des actions Studio standard. Elles ne sont actuellement pas documentées dans l’aide en ligne. Cependant, les API qui correspondent aux actions API sont documentées dans le portail des développeurs CXone Mpower. Vous pouvez utiliser cette documentation lorsque vous travaillez avec des actions API dans vos scripts.

Toutes les API de CXone Mpower n’ont pas d’action API correspondante dans Studio.

Définir l’utilisateur de sécurité dans votre script

Toutes les actions de l'API et de nombreuses actions Framework nécessitent un utilisateur de sécurité pour fonctionner correctement. Un utilisateur de sécurité est un profil d’employé CXone Mpower doté d’autorisations lui permettant d’accéder à CXone Mpower et d’interagir avec lui. Lorsqu’il est utilisé dans un script, l’utilisateur de sécurité donne à l’action Cadre ou API l’accès à CXone Mpower. Il doit s’agir d’un compte dédié utilisé uniquement à cette fin. Vous devez utiliser un profil d'employé CXone Mpower valide et actif.

L’utilisateur de sécurité a besoin d’autorisations lui permettant d’accéder à CXone Mpower et d’y effectuer les actions nécessaires. Il n’existe pas de liste fixe d’autorisations, car les exigences varient en fonction des actions utilisées.

1. Créez un profil d’employé CXone Mpower. Pour cet utilisateur :
   • Attribuez-lui un nom qui l’identifie comme un utilisateur de sécurité.
   • Dans l’onglet Sécurité de la page Créer un nouvel employé, définissez Authentificateur de connexion sur Aucun sélectionné. L’absence d’authentificateur de connexion signifie que ce compte ne peut pas être utilisé pour se connecter à CXone Mpower. Ce n’est pas grave, car vous n’aurez pas besoin de vous connecter au compte. Il n’est utilisé que pour fournir un accès via les scripts Studio.
   • Attribuez-lui un rôle avec les autorisations appropriées. La meilleure pratique consiste à créer un rôle spécifique pour l’utilisateur de sécurité.
   • Après avoir enregistré le nouveau profil d’employé, accédez à ACD > Utilisateurs ACD et recherchez le nouveau profil. Notez le numéro dans la colonne ID. Il s’agit de l’ID d’agent de l’utilisateur. Vous pouvez l’utiliser pour trouver l’utilisateur lorsque vous configurez votre script.
2. Dans votre script Studio, ajoutez une action SetSecurityUser. Cette action se trouve dans l’onglet Cadre dans Desktop Studio et dans l’onglet Actions API dans Studio. Placez l’action avant toute autre action Cadre ou API. Dans Studio, l’action SetSecurityUser se trouve dans la palette Actions API.
3. Dans la propriété Agent dans SetSecurityUser, saisissez le nom ou l’ID d’agent de l’utilisateur de sécurité, puis sélectionnez l’enregistrement correspondant. Vous pouvez utiliser la substitution de variables dans ce champ si vous avez plus d’un utilisateur de sécurité.
4. Gardez la variable de sortie SecurityUser par défaut. Elle est définie dans la propriété ScriptVar (out) (dans Studio : Variable de script). Si vous la modifiez, vous devez configurer chaque action Cadre ou API du script avec la nouvelle variable. Il existe plusieurs noms pour la propriété qui contient la variable, en fonction de l’action Cadre ou API utilisée. Security User et AuthContext sont deux exemples courants.

Versions des actions API

Au fur et à mesure que de nouvelles versions des API CXone Mpower sont publiées, de nouvelles versions des actions correspondantes peuvent être publiées dans Studio. En général, il est préférable d’utiliser la version la plus récente de l’action. Les versions antérieures fonctionnent encore dans la plupart des cas. Vous pouvez essayer les différentes versions pour voir lesquelles fonctionnent et offrent les fonctionnalités dont vous avez besoin.

Certaines actions de l’API contiennent la version dans le nom de l’action. Vous pouvez le voir dans l’arborescence des actions de l’onglet Cadre. Toutes les actions API n’incluent pas le numéro de version. Pour ces actions, vous pouvez trouver la version dans les propriétés étendues de l’action. Vous ne pouvez voir les propriétés étendues dans l’onglet Propriétés que lorsque l’action est sélectionnée dans l’onglet Cadre.

Chaque version de chaque API n’a pas forcément une action correspondante dans Studio.

Afficher les propriétés étendues de l’action API

1. Dans Studio, réorganisez les onglets de façon à ce que vous puissiez voir l’onglet Propriétés et l’onglet Cadre en même temps.
2. Dans l’onglet Cadre, cliquez sur une action API.
3. Dans l’onglet Propriétés, vous pouvez maintenant voir les propriétés étendues de l’action. En particulier, les propriétés suivantes sont utiles pour en savoir plus sur une action API :
   • Divers > Paramètres > Verbe : Cette propriété vous indique la méthode, ou le verbe, associé à l’action.
   • Divers > Paramètres > Version : Cette propriété indique la version de l’API.
   • Divers > Web > URI : Cette propriété peut être utile pour localiser la documentation de l’API dans le portail des développeurs.

   • Divers > Paramètres : Dans la section Paramètres, vous pouvez développer les propriétés pour obtenir des informations supplémentaires sur chacune des propriétés de l’action.

     Afficher l’image

     

Localiser la documentation de l’API

Les API CXone Mpower sont documentées dans le portail des développeurs CXone Mpower. Les actions API dans Studio n’ont pas de lien direct avec la documentation correspondant à leurs API. Cependant, vous pouvez utiliser les informations disponibles dans les propriétés étendues de l’action pour vous aider à localiser la documentation.

L’utilisation de l’URI nécessite une connaissance générale du système CXone Mpower dans son ensemble et des différentes API CXone Mpower. En effet, il n’est pas toujours facile de déterminer quelle API correspond à une action dans Studio. Connaître le flux général d’un contact via CXone Mpower vous aide à interpréter correctement l’URI d’une action et à appliquer les indices trouvés à la structure de la documentation de l’API dans le portail des développeurs. Les exemples de cette section illustrent l’interprétation qui peut être nécessaire.

La page d’accueil de la section API du portail des développeurs fournit une vue d’ensemble de chaque API CXone Mpower.

Exemple 1

Il existe parfois une corrélation directe entre une action et son API :

• Action : Agent Assignments for given Skills
• URI : /services/$VERSION$/skills/agents
• Documentation de l’API : /API/AdminAPI#/Skills/getAgentsAllSkills

Sur la base du nom et de l’URI de l’action, les deux premières API à considérer sont l’API de l’agent et l’API de l’administrateur. En examinant la liste des appels API pour chacun d’entre eux, vous pouvez éliminer l’API de l’agent. Sa description indique qu’il est utilisé pour gérer les sessions de l’agent et il ne semble pas avoir d’appels liés aux compétences, comme le montre l’image suivante.

L’API Admin indique qu’elle travaille avec des objets système tels que les compétences. La liste des appels API disponibles pour cette API comprend les compétences, comme le montre l’image suivante.

Lorsque vous développez la section Compétences, l’un des terminaux est GET /skills/agents. La petite description de ce terminal indique qu’il « renvoie les assignations de compétences ».

Exemple 2

Parfois, la corrélation n’est pas évidente, comme le montre l’exemple suivant. Dans ce cas, vous devrez utiliser vos connaissances des API CXone Mpower et de la plateforme elle-même pour trouver le terminal de l’API correspondant. -

• Action : Active Contact Details
• URI : /services/$VERSION$/contacts/active
• Documentation de l’API :  /API/RealTimeDataAPI#/RealTime/ActiveContacts

D’après le nom et l’URI de cette action, il n’est pas évident de savoir quelle API consulter en premier. Si vous ne savez pas par où commencer, vous pouvez consulter la documentation de chaque API et examiner toute section relative aux contacts. L’API Admin est la seule à disposer d’une section relative aux contacts de premier niveau. Malheureusement, cette API ne contient pas de terminaux relatifs aux contacts actifs.

À ce stade, vous pouvez vous concentrer sur le mot actif dans le nom de l’action et l’URI. Grâce à votre connaissance de CXone Mpower, vous savez que le terme « actif » indique les contacts en cours de traitement. Cela vous amène à examiner de plus près l’API de données en temps réel. Cette API ne comporte qu’une seule section, et lorsque vous la développez, vous voyez que l’un des terminaux est GET /contacts/active. La petite description de ce terminal indique qu’il "renvoie les contacts actifs"