Comment créer des identifiants API

Les identifiants OAuth vous permettront d'accéder aux API publiques de Contentsquare (API des métriques et API des données brutes)

Ces identifiants se composent d'une paire : client_id et client_secret qui doivent être fournis à un point de terminaison d'authentification spécifique.

Le point de terminaison d'authentification renverra deux éléments clés :

• Un jeton JWT valide utilisé pour interroger les métriques et les points de terminaison des données brutes de Contentsquare

• Une URL de base pour tous les points de terminaison de l'API Contentsquare, qui est dynamique et dépend de votre hébergement cloud unique (AWS vs. Azure et région)

Vous pouvez générer des identifiants à deux niveaux :

• Niveau de compte, permettra de demander des ressources pour tout projet attaché au compte à partir duquel les identifiants sont générés.

• Niveau de projet, permettra de demander des ressources uniquement pour le projet spécifique à partir duquel les identifiants sont générés.

Comment créer des identifiants

1. Accédez à la 'Console'

2. Choisissez le niveau de compte ou de projet, accédez à l'onglet 'Identifiants API', puis cliquez sur 'Créer des identifiants de compte'.

• Choisissez un niveau de compte ou un niveau de projet en fonction de si vous souhaitez des identifiants avec accès à tous les projets d'un compte ou seulement à un spécifique.
• Vous trouverez le même onglet 'API Credentials' tant au niveau du compte qu'au niveau du projet.
  
  • Pour le niveau de projet : Accéder au projet > onglet 'API credential' > 'Créer des identifiants de compte'
  • Pour le niveau de compte : Accéder au compte > onglet 'API credential' > 'Créer des identifiants de compte'

• Si vous avez déjà des identifiants créés, votre 'Créer des identifiants de compte' bouton sera dans le coin supérieur droit de la liste des identifiants.

3. Remplissez les informations des identifiants OAuth : nom de vos identifiants et liste des adresses IP qui peuvent les utiliser (par défaut toute adresse IP) et cliquez sur 'Créer des identifiants de compte/projet'.

• Si vous devez fournir une liste blanche d'adresses IP spécifiques, sélectionnez 'Autoriser des adresses IP spécifiques' et listez toutes les adresses IP que vous souhaitez mettre sur liste blanche (au format IPv4 ou IPv6) puis cliquez sur 'Créer des identifiants de compte/projet'.

4. Une fenêtre contextuelle apparaîtra avec vos identifiants OAuth générés. Conservez vos identifiants dans un endroit sûr. C'est la dernière fois qu'ils seront affichés et Contentsquare ne les stocke pas pour des raisons de sécurité. Cliquez sur 'J'ai copié mes identifiants'.

5. Vous serez redirigé vers la vue de l'onglet des identifiants API où vos nouveaux identifiants seront listés. Vous pouvez maintenant utiliser ces identifiants pour interroger les API publiques de Contentsquare.

2. Lisez le message de confirmation et cliquez sur 'Régénérer les identifiants'.

3. Vos nouvelles informations d'identification apparaîtront dans une fenêtre contextuelle, utilisez-les pour mettre à jour Tout identifiant existant en cours d'utilisation. Les informations d'identification régénérées rendront l'identifiant précédent pour cette connexion non valide.

• Copier et stocker le client_secret car vous ne pourrez pas le voir à nouveau ou le récupérer plus tard et cliquez sur 'J'ai copié mes informations d'identification'.

Comment modifier les informations d'identification OAuth

1. Accéder à 'Console' > 'Informations d'identification API' onglet > '...' menu d'options supplémentaires > 'Modifier les informations d'identification'

2. Le formulaire de configuration des informations d'identification s'ouvrira. Vous pouvez modifier le nom, la description et la liste des adresses IP autorisées et cliquer sur 'Modifier les informations d'identification du compte' pour enregistrer.

Comment révoquer des informations d'identification

1. Accéder à 'Console' > 'Informations d'identification API' onglet > '...' menu d'options supplémentaires > 'Révoquer les informations d'identification'.

2. Lisez le message de confirmation qui s'affiche vous rappelant que la révocation des informations d'identification en cours d'utilisation peut interrompre l'application. Cliquez sur 'Révoquer les informations d'identification'.

3. Vos informations d'identification seront supprimées de la liste des informations d'identification et ne pourront plus être utilisées pour interroger les API publiques de Contentsquare.