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, comme l’utilisation d’un extrait ou de l’RestAPI action.

Les Actions API sont différentes des actions standard Studio. Elles ne sont pas documentées dans l’aide en ligne. Toutefois, les API qui correspondent 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 dans la palette Actions API dans Studio. Leur organisation correspond à l’organisation des API sur le portail des développeurs. Cela facilite le repérage de la documentation correspondante. Dans Desktop Studio, elles se trouvent dans l’onglet Cadre. Ce ne sont pas toutes les API NiCE CXone qui ont une action API correspondante dans Studio.

Définir 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 doté des autorisations lui permettant d’accéder à NiCE CXone et d’interagir avec NiCE CXone. Lorsqu’il est utilisé dans un script, l’utilisateur de sécurité donne à l’action Cadre ou API l’accès à NiCE CXone. Il doit s’agir d’un compte dédié utilisé uniquement à cette fin. Vous devez utiliser un profil d’employé NiCE CXone valide et actif.

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

1. Create a NiCE CXone employee profile. For this user: 
   • Attribuez-lui un nom qui l’identifie comme un utilisateur de sécurité.
   • Définissez Authentificateur de connexion dans l’onglet Sécurité de la page Créer un Nouvel Employé sur Aucun sélectionné. L’absence d’authentificateur de connexion signifie que ce compte ne peut pas être utilisé pour se connecter à NiCE CXone. Ce n’est pas un problème, car vous n’aurez pas besoin de vous connecter avec ce compte. Il sert uniquement à fournir un accès via des scripts Studio.
   • Attribuez-lui un rôle disposant des 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é, allez à ACD > Utilisateurs acd et recherchez le nouveau profil. Notez le numéro figurant dans la colonne ID. Il s’agit de l’id de l’agent de l’utilisateur. Vous pouvez l’utiliser pour trouver l’utilisateur lors de la configuration de votre script.
2. Dans votre script Studio, ajoutez une action SetSecurityUser. Cette action se trouve dans l’onglet Cadre dans Desktop Studio et dans la palette Actions API dans Studio. Placez SetSecurityUser avant toute autre action Cadre ou API.
3. Dans la propriété Agent de SetSecurityUser, entrez le nom ou l’id de l’agent de l’utilisateur de sécurité, puis sélectionnez l’enregistrement correspondant. Vous pouvez utiliser la substitution de variable dans ce champ si vous utilisez plus d’un utilisateur de sécurité.
4. Laissez la variable de sortie par défaut SecurityUser. Elle est définie dans la Variable de script. Dans Desktop Studio, la propriété est ScriptVar (out). Si vous la modifiez, vous devez configurer chaque action Cadre ou API dans le script avec la nouvelle variable. Il existe différents noms pour la propriété qui contient la variable, selon l’action Cadre ou API utilisée. Utilisateur de Sécurité et AuthContext en sont deux courants.

Versions des actions API

À mesure que de nouvelles versions des API NiCE CXone 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 plus anciennes fonctionnent encore dans la plupart des cas. Vous pouvez essayer les différentes versions pour voir lesquelles fonctionnent et offrent la fonctionnalité dont vous avez besoin.

Certaines Actions API comportent 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 d’une action API

1. Dans Studio, réorganisez les onglets de manière à pouvoir 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. 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 le verbe, associé à l’action.
   • Divers > Paramètres > Version : Cette propriété vous 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 voir des 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 portail des développeurs NiCE CXone. Les Actions API dans Studio n’ont pas de lien direct vers la documentation correspondant à leurs API. Toutefois, 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 exige une bonne connaissance générale du système NiCE CXone dans son ensemble et des différentes API NiCE CXone. En effet, déterminer quelle API correspond à une action dans Studio n’est pas toujours simple. Connaître le flux général d’un contact à travers NiCE CXone vous aide à interpréter correctement l’URI d’une action et à appliquer les indices qui s’y trouvent à 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 requise.

La page d’accueil de la section API du portail des développeurs offre 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

D’après le nom et l’URI de l’action, les deux premières API à considérer sont l’Agent API et l’Admin API. En examinant la liste des appels API de chacune, vous pouvez éliminer l’Agent API. Sa description indique qu’elle sert à gérer les sessions des agents et elle ne semble comporter aucun appel lié aux compétences, comme le montre l’image suivante.

L’Admin API indique qu’elle fonctionne 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 des cas comme celui-ci, vous devrez appliquer vos connaissances des API NiCE CXone et de la plateforme elle-même pour trouver le terminal 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 immédiatement évident de savoir quelle API examiner en premier. Si vous ne savez pas par où commencer, vous pouvez parcourir la documentation de chaque API et examiner toute section relative aux contacts. L’Admin API est la seule à posséder une section contacts de premier niveau. Malheureusement, cette API ne contient pas de terminaux relatifs aux contacts actifs.

À ce stade, vous pourriez vous attarder sur le mot actif dans le nom de l’action et l’URI. En vous appuyant sur vos connaissances de NiCE CXone, vous savez qu’actif désigne les contacts qui sont actuellement traités. Cela vous amène à examiner de plus près l’API Real-Time Data. 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. »