Clés API

SIP Caller vous permet de définir des Clés API pour l’intégrer à des systèmes externes. Vous pouvez définir autant de Clés API que nécessaire, en leur assignant une expiration et des rôles. Un système externe peut utiliser l’API REST fournie par SIP Caller, en s’authentifiant avec le jeton de Clé API généré comme décrit ci-dessous.

Les Clés API nécessitent le forfait Enterprise.

Rôles requis

Pour créer ou modifier une Clé API, l’utilisateur a besoin de l’un des rôles suivants :

• Administrateur

Pour consulter une Clé API, l’utilisateur a besoin de l’un des rôles suivants :

• Lecteur du compte

Créer une Clé API

Pour créer une Clé API :

1. Allez dans « Paramètres » > « Clés API », puis cliquez sur « Créer ».
   
2. Spécifiez un nom pour la Clé API.
3. Sélectionnez une expiration. Veuillez noter que celle-ci ne peut pas être prolongée une fois la Clé API créée.
4. Activez les rôles que vous souhaitez accorder aux applications qui utiliseront cette Clé API. Veuillez noter que cela ne peut pas être modifié une fois la Clé API créée. Les rôles disponibles sont décrits dans Rôles des Clés API.
5. Cliquez sur « Enregistrer » pour créer la Clé API.
   
6. Une boîte de dialogue sera affichée, contenant le Jeton de la Clé API qui vient d’être créée. Copiez la valeur et enregistrez-la dans un endroit sûr. Ce jeton ne sera plus affiché, et ne peut pas être récupéré, car SIP Caller ne le stockera pas. Si vous le perdez, vous devrez créer une autre Clé API.

Rôles des Clés API

Les rôles assignés à une Clé API définissent ce que peuvent faire les applications qui l’utilisent. Les rôles disponibles sont les suivants :

• Moniteur des files d’attente : ce rôle est requis pour utiliser le module SIP Caller Queues Monitor et surveiller votre système téléphonique en temps réel, pour les campagnes exécutées en mode numéroteur prédictif ou progressif. Il peut être limité à des systèmes téléphoniques spécifiques.
• Lecteur des campagnes : ce rôle donne un accès en lecture seule aux campagnes, aux numéros de campagne, aux listes noires, aux listes de contacts et aux rapports de campagne.
• Administrateur des campagnes : ce rôle donne un accès complet aux campagnes, aux numéros de campagne, aux listes noires, aux listes de contacts et aux rapports de campagne.
• Administrateur des numéros de campagne : ce rôle permet de lire, d’ajouter et de retirer les numéros d’une campagne. Il peut être limité à des campagnes spécifiques.
• Fournisseur de numéros de campagne : ce rôle permet d’ajouter des numéros à une campagne, sans pouvoir les lire ni les retirer. Il peut être limité à des campagnes spécifiques.

N’accordez à chaque application que les rôles dont elle a besoin. Par exemple, un formulaire web qui envoie de nouveaux prospects à une campagne n’a besoin que du rôle Fournisseur de numéros de campagne, limité à cette campagne. Consultez la documentation développeur pour plus de détails.

Modifier une Clé API

Pour modifier une Clé API :

1. Allez dans « Paramètres » > « Clés API », puis cliquez sur la Clé API que vous souhaitez modifier.
   
2. À ce stade, vous pouvez uniquement modifier le nom, et visualiser la date et l’heure de création et d’expiration, ainsi que les rôles assignés à la Clé API. Si vous devez modifier d’autres valeurs, vous devrez créer une autre Clé API.

Supprimer une Clé API

Lorsque vous devez révoquer l’accès d’une application à SIP Caller, vous devrez supprimer la Clé API. Pour ce faire :

1. Allez dans « Paramètres » > « Clés API », puis sélectionnez la Clé API que vous souhaitez supprimer.
2. Cliquez sur le bouton Supprimer et confirmez l’opération.