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). Ils sont également utilisés dans le rapport de crash mobile pour iOS et Android.

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 de 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 dont les identifiants sont générés.
• Niveau de projet, permettra de demander des ressources uniquement pour le projet spécifique dont les identifiants sont générés.

Utilisation des identifiants API pour le rapport de crash mobile

Les identifiants API sont utilisés pour le rapport de crash sur iOS et Android.

Rapport de crash iOS

Authentifiez-vous avec des identifiants API pour télécharger des fichiers dSYM pour l'analyse des erreurs, garantissant des rapports de crash lisibles. Après avoir suivi les étapes ci-dessous pour obtenir votre ID client et votre clé secrète client, consultez notre documentation technique sur le téléchargement des dSYMs.

Rapport de crash Android

Des identifiants API sont nécessaires pour le plug-in de crash Gradle dans le fichier build.gradle afin d'automatiser les téléchargements de fichiers de mapping et de symboliser les rapports de crash. Créez vos identifiants en suivant les étapes ci-dessous, puis consultez notre documentation technique sur le rapport de crash.

Comment créer des identifiants

1. Accédez à la 'Console'

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

• Choisissez le niveau de compte ou de projet en fonction de si vous souhaitez des identifiants avec accès à tous les projets d'un compte ou uniquement à un projet spécifique.
• Vous trouverez le même 'Identifiants API' onglet à la fois au niveau du compte et au niveau du projet.
  • Pour le niveau de projet : Allez au projet > 'Identifiant API' onglet > 'Créer des identifiants de compte'
  • Pour le niveau de compte : Allez au compte > 'Identifiant API' onglet > '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.

Comment régénérer des identifiants OAuth

1. Allez à 'Console' > 'Identifiants API' onglet > '...' menu des options supplémentaires > 'Régénérer les identifiants'

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

3. Vos nouveaux identifiants apparaîtront dans une fenêtre contextuelle, utilisez-les pour mettre à jour tous les identifiants existants en cours d'utilisation. Les identifiants régénérés 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 cliquer sur 'J'ai copié mes identifiants'.

Comment modifier les identifiants OAuth

1. Accéder à 'Console' > 'Identifiants API' onglet > '...' menu des options supplémentaires > 'Modifier les identifiants'

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

Comment révoquer des identifiants

1. Accéder à 'Console' > 'Identifiants API' onglet > '...' menu des options supplémentaires > 'Révoquer les identifiants'.

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

3. Vos identifiants seront supprimés de la liste des identifiants et ne pourront plus être utilisés pour interroger les API publiques de Contentsquare.