L’API publique d'iAdvize est une interface qui vous permet de transmettre ou de récupérer des données structurées pour interagir avec notre solution afin d’automatiser vos traitements de reporting, d’administration ou encore d’orchestration des services.
Objectif
Use cases
L’import ou la modification d’utilisateurs permet d’automatiser la gestion de vos utilisateurs pour:
- créer en masse vos utilisateurs
- synchroniser vos utilisateurs entre applications (user provisioning)
- automatiser la création d’un utilisateur selon vos besoins
- mettre à jour les informations d’un utilisateur (nom d’utilisateur, mot de passe, groupe, …)
- modifier la configuration des canaux de communication de vos utilisateurs
- etc.
Marche à suivre
1. Pré-requis : récupération de vos clefs API GraphQL
L’authentification API utilise des clefs d’accès temporaires et révocables.
Veuillez noter que la durée de vie de la clef est de 24 heures
Vous pouvez générer une clef d’accès en appelant l’url mentionnée dans ce lien avec un email utilisateur et un mot de passe.
2. Import de vos utilisateurs
La ressource userCreate, disponible dans notre API GraphQL, vous permet de préciser l’ensemble des informations disponibles lors de la création de vos utilisateurs.
3. Modification de vos utilisateurs
La ressource userUpdate, disponible dans notre API GraphQL vous permet de mettre à jour l’ensemble des informations de vos utilisateurs.
4. Ressources disponibles
|
|
||
| firstName | Prénom de l’utilisateur | ||
| lastName | Nom de l’utilisateur | ||
| Email de l’utilisateur | |||
| password | Mot de passe de l’utilisateur | ||
| roleId | Identifiant du rôle de l’utilisateur: conseiller, manager, administrateur, … | ||
| userName | Nom d’utilisateur qui sera affiché dans la fenêtre de dialogue | ||
| avatar |
Portrait du conseiller qui pourra être affiché dans la fenêtre de dialogue. (L'image doit être inférieure à 1Mo, 1000px par 1000px aux formats PNG, jpg ou gif en sachant qu'un redimensionnement automatique est appliqué par la suite.) |
||
| channels | L’objet channels de cette ressource vous permet de préciser la configuration des différents canaux (chat, call, video, canaux tiers) pour l’utilisateur à créer: activation du canal, nombre de slots configurés, etc | ||
| skills | Liste des identifiants des compétences attribuées à l’utilisateur | ||
| Project Ids | Les identifiants des projets accessibles à cet utilisateur | ||
| groupId | Identifiant du groupe d’utilisateurs | ||
| Country preferences | Localisation de l’utilisateur: langue principale, langues parlées, fuseau horaire, format de date/heure | ||
| externalID | Identifiant externe de l’utilisateur | ||
| samlId | Identifiant SAML de l’utilisateur pour l’utilisation du SSO |
D’autres ressources sont également disponibles pour gérer vos utilisateurs et compétences.
Gestion des utilisateurs
| Informations | Description |
| user | Récupérer des informations sur l'utilisateur en fonction de son identifiant (y compris les paramètres des canaux, l'état de présence et de disponibilité, les rôles de l'utilisateur). |
| users | Collecter une liste d'utilisateurs selon vos critères |
| userCreate | Créer un utilisateur (y compris les 3ème parties et les paramètres de disponibilité, les rôles de l'utilisateur, ...) |
| userUpdate | Mettre à jour les informations d'un utilisateur |
| userDelete |
Supprimer un utilisateur |
| userSkillsAdd | Ajouter facilement une ou plusieurs compétences à un utilisateur |
| userSkillsRemove | Supprimer facilement une ou plusieurs compétences d'un utilisateur |
| userSkillsSet | Supprimer pour remplacer facilement les compétences d'un utilisateur |
Gestion des compétences
| Informations | Description |
| skill | Récupérer des informations sur les compétences en fonction de leur identifiant |
| skills | Collecter une liste de compétences selon vos critères |
| skillCreate | Créer une nouvelle compétence (y compris une compétence de localisation) |
| skillUpdate | Mettre à jour les informations d'une compétence |
| skillDelete |
Supprimer une compétence |
Présence et disponibilité
| Informations | Description |
| userAvailabilityStatusUpdate | Mettre à jour l'état de disponibilité d'un agent |
Pour plus d’information sur ces différentes ressources, vous pouvez consulter notre documentation developers platform.
Gérez la disponibilité de vos utilisateurs grâce à l'API d'iAdvize