Action de l’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 snippet ou de l'action RestAPI. Toutes les actions API se trouvent dans l’onglet Cadre Desktop Studio. Dans Studio, ils sont situés sur la palette Actions API.

Les actions API sont différentes des actions standard de Studio. 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 CXone Mpowerportail des développeurs . 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éfinition de l’utilisateur de sécurité dans votre script

Toutes les actions 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 qui lui permettent d’accéder à CXone Mpower et d’interagir avec. Utilisé dans un script, l’utilisateur de sécurité permet à l’action de cadre ou d’API d’accéder à CXone Mpower. Il doit s’agir d’un compte dédié, uniquement utilisé à cette fin. Vous devez utiliser un profil d'employé CXone Mpower valide et actif.

L’utilisateur de sécurité a besoin d’autorisations qui lui permette d’accéder à CXone Mpower et d’y effectuer des actions. La liste des autorisations n’est pas figée, puisque les exigences dépendent des actions utilisées.

1. Créez un profil d’employé CXone Mpower. Pour cet utilisateur :
   • Donnez-lui un nom qui indique clairement qu’il s’agit d’un utilisateur de sécurité.
   • Définissez l’Authentificateur de connexion sur l’onglet Sécurité de la page Créer un nouvel employé avec la valeur Aucun sélectionné. Comme il n’a pas d’authentificateur de connexion, ce compte ne peut pas être utilisé pour se connecter à CXone Mpower. Ce n’est pas un problème, puisque vous n’aurez pas besoin de vous connecter avec ce compte. Il sert uniquement à fournir un accès via les scripts Studio.
   • Attribuez-lui un rôle qui dispose des autorisations appropriées. La meilleure pratique consiste à créer un rôle spécialement pour l’utilisateur de sécurité.
   • Après avoir enregistré le nouveau profil d’employé, allez dans ACD > Utilisateurs ACD et recherchez le nouveau profil. Notez le numéro indiqué dans la colonne ID. Il s’agit de l’ID d’agent de l’utilisateur. Vous pouvez vous en servir pour trouver l’utilisateur lorsque vous configurez votre script.
2. Dans votre script Studio, ajoutez une action SetSecurityUser. Cette action se trouve sur l’onglet Framework dans Desktop Studio et sur l’onglet Actions de l’API dans Studio. Placez l’action avant toute autre action de cadre ou d’API. Dans Studio, l’action SetSecurityUser se trouve dans la palette Actions de l’API.
3. Dans la propriété Agent de SetSecurityUser, entrez le nom ou l’ID d’agent de l’utilisateur de sécurité, puis sélectionnez l’enregistrement correspondant. Si vous avez plusieurs utilisateurs de sécurité, vous pouvez utiliser la substitution de variables dans ce champ.
4. Conservez la variable de sortie par défaut SecurityUser. Elle est définie dans la propriété ScriptVar (out) (dans Studio : Variable de script). Si vous la modifiez, vous devez configurer chauqe action Cadre ou action d’API dans le script avec la nouvelle variable. Selon l’action de cadre ou d’API utilisée, la propriété qui contient la variable peut avoir différents noms. Security User et AuthContext sont deux propriétés couramment utilisées.

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 règle générale, 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 fournissent les fonctionnalités dont vous avez besoin.

Le nom de certaines actions API contient leur numéro de version. Vous pouvez le voir dans l'arborescence des actions de l'onglet Cadre. Le numéro de version ne figure pas dans le nom de toutes les actions API. Pour ces actions, vous pouvez trouver la version dans les propriétés étendues. 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.

Toutes les versions de chaque API n'ont pas d'action correspondante dans Studio.

Voir les propriétés étendues de l'action API

1. Dans Studio, réorganisez les onglets de façon à 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 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é indique la méthode, ou le verbe, associée à l'action.
   • Divers > Paramètres > Version : cette propriété indique la version de l'API.
   • Divers > Web > URI : cette propriété peut servir à 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.

     Voir l'image

     

Recherche de la documentation de l’API

CXone Mpower Les API 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. Vous pouvez toutefois utiliser les informations disponibles dans les propriétés étendues de l'action pour 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 aisé de déterminer à quelle action de Studio correspond chaque API. Une connaissance générale du cheminement d’un contact dans CXone Mpower vous aide à interpréter correctement l’URI d’une action et à faire le lien entre les indices qu’elle fournit et la structure de la documentation relative aux API sur 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 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 Agent et l'API Admin. En examinant la liste des appels API pour chacun d'entre eux, vous pouvez éliminer l'API Agent. Sa description indique qu'il est utilisé pour gérer les sessions des agents 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 du 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 points de terminaison est GET /skills/agents. La description succincte de ce point de terminaison indique qu'il « renvoie les affectations de compétences ».

Exemple 2

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

• Action : Active Contact Details
• URI : /services/$VERSION$/contacts/active
• Documentation 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 de contact de niveau supérieur. Malheureusement, cette API ne contient pas de points de terminaison relatifs aux contacts actifs.

À ce stade, vous pouvez vous concentrer sur le mot active 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. Vous pouvez donc examiner de plus près l'API sur les 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 points de terminaison est GET /contacts/active. La description succincte de ce point de terminaison indique qu'il « renvoie les contacts actifs ».