ⓘ À compter du 14 juillet 2023, Contentsquare supprime les keys API.
- les keys API seront prises en charge jusqu'au 30 avril 2024
- pour les applications qui utilisent encore des keys API à la date du 30 avril 2024, les options suivantes cesseront de fonctionner :
- Raw Data et Métriques d'API
- connecteur Looker Studio
- Extension Qualtrics extension (lecteur de Session Replay intégré)
- Reeport
- Dexem
- Pour remplacer vos keys d'API; suivez ces instructions de migration.
Les identifiants OAuth vous permettront d'authentifier les API publiques de Contentsquare (Métriques d'API et API de Raw Data)
Ces identifiants se composent d'une paire d'informations : le client_id
et le 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 consulter les métriques de Contentsquare et les points de terminaisons de données brutes (raw data)
-
une URL de base pour tous les points de terminaison API Contentsquare, qui est dynamique et dépends de votre hébergement cloud unique (AWS vs. Azure et région)
Vous pouvez générer des identifiants à l'un des deux niveaux suivants :
-
le niveau du compte vous permettra de demander des ressources pour n'importe quel projet rattaché au compte depuis lequel les identifiants ont été générés.
-
le niveau du projet permettra de demander uniquement des ressources spécifiquement pour le projet à partir duquel les identifiants ont été créés.
Créer des identifiants
1. Rendez-vous dans les paramètres "⚙️" > "Console"
2. Choisissez entre le niveau compte et le niveau projet, rendez-vous dans l'onglet "Identifiants API" et cliquez sur "Créer les identifiants du compte".
- Basez votre choix de niveau (compte ou projet) selon si vous souhaitez que les identifiants vous permettent d'accéder à tous les projets sur votre compte ou seulement à un projet spécifique.
- Vous trouverez le même onglet "Identifiants API" au niveau du projet et au niveau du compte.
- Pour le niveau projet : Rendez-vous sur le projet > Onglet "Identifiants API" > "Créer les identifiants du projet"
- Pour le niveau compte : Rendez-vous sur le compte > Onglet "Identifiants API" > "Créer les identifiants du compte"
- Si vos identifiants sont déjà créés, votre bouton "Créer les identifiants du compte" se trouvera dans le coin supérieur droit de la liste des identifiants.
3. Renseignez les informations d'identifiants OAuth : nom de vos identifiants et liste des adresses IP pouvant les utiliser (par défaut, n'importe quelle adresse IP) et cliquez sur "Créer les identifiants du compte/projet".
- S'il vous faut fournir une liste blanche des adresses IP spécifiques, sélectionnez "Autoriser des adresses IP spécifiques" et listez toutes les adresses IP que vous voulez mettre sur liste blanche (soit au format IPv4, soit à l'IPv6). Puis, cliquez sur "Créer les identifiants du compte/projet".
4. Un pop-up contenant vos informations d'identification OAuth apparaitra. Gardez ces informations dans un endroit sécurisé. C'est la dernière fois qu'elles s'afficheront et Contentsquare, pour des raisons de sécurité, ne les stocke pas. Cliquez sur "J'ai copié mes identifiants".
5. Vous serez redirigé vers l'onglet des identifiants API où vos nouveaux identifiants seront listés. Vous pourrez alors les utiliser pour consulter les API publiques de Contentsquare.
Régénérer des identifiants OAuth
1. Rendez-vous dans la "Console" > Onglet "Identifiants API" > menu des options "..." > "Régénérer des identifiants"2. Lisez le message de confirmation et cliquez sur "Régénérer des identifiants".
3. Vos nouvelles informations d'identifications apparaîtront dans un pop-up, utilisez-les pour mettre à jour vos identifiants existants en utilisation. Régénérer des identifiants rendra les identifiants utilisés pour cette connexion automatiquement invalide.
- Copiez et stockez bien le "secret client" car vous ne pourrez ni le retrouver, ni le revoir plus tard, et cliquez sur "J'ai copié mes identifiants".
Modifier des identifiants OAuth
1. Rendez-vous dans la "Console" > Onglet "Identifiants API" > menu des options "..." > "Modifier les identifiants"
2. Le formulaire de configuration des identifiants s'ouvrira. Vous pouvez modifier le nom, la description et la liste des adresses IP sur liste blanche. Puis, cliquez sur "Modifier les identifiants du compte" pour enregistrer.
Supprimer des identifiants
1. Rendez-vous dans la "Console" > Onglet "Identifiants API" > menu des options "..." > "Supprimer les identifiants".
2. Lisez le message du pop-in de confirmation qui vous rappelle que supprimer des identifiants en cours d'utilisation peut interrompre l'application, puis cliquez sur "Supprimer les identifiants".
3. Vos informations d'identifications seront supprimées de la liste et ne pourront plus être utilisées pour consulter les API publiques de Contentsquare.