Actions API

Les actions API sont des actions Studio qui vous permettent d'utiliser les API NiCE CXone dans vos scripts. Vous pouvez utiliser l'action au lieu d'appeler l'API en utilisant des méthodes d'intégration traditionnelles telles que l'utilisation d'un extrait ou de l'action RestAPI.

Les Actions API sont différentes des actions standard de Studio. Ils ne sont pas documentés dans l'aide en ligne. Toutefois, les API correspondant aux Actions API sont documentées dans le portail des développeurs NiCE CXone . Vous pouvez utiliser cette documentation lorsque vous travaillez avec des Actions API dans vos scripts.

Les actions API se trouvent sur le palette d'Actions API dans Studio. Leur organisation correspond à l'organisation des API sur le portail développeur. Cela permet de localiser plus facilement la documentation correspondante. Dans Desktop Studio, elles se trouvent dans l'onglet Framework. Toutes les API de NiCE CXone n'ont pas d'action API correspondante dans Studio.

Définition de l’Utilisateur de sécurité dans votre script

Toutes les Actions API nécessitent un utilisateur de sécurité pour fonctionner correctement. Un utilisateur de sécurité est un profil d'employé NiCE CXone avec des autorisations qui lui permettent d'accéder à NiCE CXone et d'interagir avec celui-ci. Utilisé dans un script, l’utilisateur de sécurité permet à l’action de cadre ou d’API d’accéder à NiCE CXone. Il doit s’agir d’un compte dédié, uniquement utilisé à cette fin. Vous devez utiliser un profil employé valide et actif NiCE CXone.

L’utilisateur de sécurité a besoin d’autorisations qui lui permette d’accéder à NiCE CXone 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. Create a NiCE CXone employee profile. For this user: 
   • Donnez-lui un nom qui indique clairement qu’il s’agit d’un utilisateur de sécurité.
   • Définissez Login Authenticator sur l'onglet Sécurité de la page Create New Employee sur Aucun sélectionné. Comme il n’a pas d’Authentificateur de connexion, ce compte ne peut pas être utilisé pour se connecter à NiCE CXone. 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 disposant des autorisations appropriées. La meilleure pratique consiste à créer un rôle spécifiquement pour l'utilisateur de sécurité.
   • Après avoir enregistré le nouveau profil d'employé, accédez à ACD > ACD Users 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 dans la palette Actions API dans Studio. Placez SetSecurityUser avant toute autre Action Framework ou API.
3. Dans la propriété Agent de SetSecurityUser, entrez le nom de l'utilisateur de sécurité ou l'ID agent, puis sélectionnez l'enregistrement correspondant. Vous pouvez utiliser la substitution de variable dans ce champ si vous utilisez plus qu'un utilisateur de sécurité.
4. Conservez la variable de sortie par défaut SecurityUser. Ceci est défini dans la Variable . Dans Desktop Studio, la propriété est ScriptVar (out). Si vous le modifiez, vous devez configurer chaque Action Framework ou API dans le script avec la nouvelle variable. Il existe différents noms pour la propriété qui contient la variable, selon le Framework ou l'action API utilisée. Utilisateur de sécurité et AuthContext en sont deux exemples courants.

Versions d'Action API

Lorsque de nouvelles versions des API NiCE CXone 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 réessayer les différentes versions pour voir celles qui fonctionnent et offrent la fonctionnalité 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.

Afficher les Propriétés étendues de l'Action API

1. Dans Studio, réorganisez les onglets de manière à pouvoir voir l'onglet Propriétés et l'onglet Framework en même temps.
2. Dans l'onglet cadre, cliquez sur une action API.
3. On the Properties tab, you can now see the extended properties of the action. In particular, the following properties are helpful when learning about an API action: 
   • Divers > Paramètres > Verbe : Cette propriété vous indique la méthode, ou verbe, associée à l'action.
   • Misc > Paramètres > Version : cette propriété vous 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.

   • Misc > Paramètres : Dans la section Paramètres, vous pouvez développer les propriétés pour afficher les informations supplémentaires sur chacune des propriétés de l'Action.

     Voir l'image

     

Localiser la documentation de l'API

Les API NiCE CXone sont documentées dans le NiCE CXone Developer Portal. 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 NiCE CXone dans son ensemble, ainsi que des différentes API NiCE CXone. En effet, il n’est pas toujours aisé de déterminer à quelle action de Studio correspond chaque API. La connaissance générale flux d'un contact à travers NiCE CXone vous aide à interpréter correctement l'uri d'une Action et à appliquer les indices qui y sont trouvés à la structure de la documentation de l'API dans le portail développeur. 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 NiCE CXone.

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 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 comporter d'appels liés aux compétences, comme illustré dans 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 NiCE CXone 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 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 de contact de haut niveau. Malheureusement, cette API ne contient pas de points de terminaison relatifs aux contacts actifs.

À ce stade, vous pourriez vous concentrer sur le mot actif dans le nom de l’action et l’URI. Grâce à votre connaissance de NiCE CXone, vous savez que le terme « actif » indique les contacts en cours de traitement. Ceci vous amène à examiner plus en détail l'API de données En temps réel. Cette API comporte uniquement une section, et lorsque vous la développez, vous constatez 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 ».