Clés et secrets

Avant d’utiliser Clés, connectez le projet à Cloud Atoms. S’il n’est pas connecté, demandez à l’Agent de connecter Cloud Atoms ou suivez Cloud Atoms.

Utiliser une clé dans Cloud Atoms

Avant de commencer

Avant d’ajouter une clé, assurez-vous que :

• Vous utilisez Atoms sur le web desktop.
• Le projet est connecté à Cloud Atoms.
• Vous êtes propriétaire de l’espace de travail. Seuls les propriétaires de l’espace de travail peuvent ajouter de nouvelles clés.

Si Clés ou Nouvelle clé n’est pas disponible, vérifiez que vous avez ouvert le projet prévu et qu’il est connecté à Cloud Atoms. Si Nouvelle clé reste indisponible, vérifiez que vous êtes propriétaire de l’espace de travail. Si Atoms affiche un message concernant la disponibilité du forfait ou de l’utilisation, suivez le parcours de disponibilité ou de mise à niveau affiché à l’écran, puis réessayez.

Ajouter une clé de test

1. Ouvrez le projet sur un appareil desktop.
2. Dans la même barre d’outils de l’espace de travail où se trouve la Visionneuse d'App, sélectionnez Cloud Atoms.
3. Sélectionnez Clés dans la barre latérale de Cloud Atoms.
4. Ouvrez Clés de test, puis sélectionnez Dans ce projet.
5. Sélectionnez Nouvelle clé.
6. Remplissez les champs obligatoires :
   • Nom : Saisissez un nom de référence clair, tel que RESEND_API_KEY. Utilisez des lettres, des chiffres et des tirets bas, et commencez par une lettre ou un tiret bas.
   • Valeur : Saisissez l’identifiant exactement tel qu’il a été fourni par le fournisseur.
   • Description : Expliquez à quoi sert la clé, par exemple Utilisée pour envoyer des e-mails de compte. N’incluez pas la valeur de l’identifiant.
7. Si vous souhaitez réutiliser la clé dans d’autres projets, sélectionnez Enregistrer dans la bibliothèque.
8. Sélectionnez Ajouter. Lorsque la clé a été enregistrée, Atoms affiche Clé ajoutée avec succès.

Ajouter une clé de test

Seuls les propriétaires de l’espace de travail peuvent ajouter de nouvelles clés. Si vous avez besoin qu’une clé soit ajoutée, demandez-le à un propriétaire de l’espace de travail.

Utiliser une clé enregistrée dans Chat

Référencez la clé enregistrée au lieu de saisir sa valeur dans un message.

1. Ouvrez le Chat du projet dans la version desktop d’Atoms et tapez #.
2. Sélectionnez Clés.
3. Recherchez la clé enregistrée, puis sélectionnez son nom.
4. Indiquez à l’Agent à quoi sert la clé et ce que vous voulez que l’intégration fasse.

Le menu # ajoute une référence à la clé enregistrée sans insérer sa valeur dans votre message.

Référencer une clé enregistrée dans Chat

Tester une clé enregistrée

1. Dans la Visionneuse d'App, effectuez une action simple qui utilise la clé.
2. Vérifiez qu’elle produit le résultat attendu, comme l’envoi d’un e-mail de test ou le renvoi de données de test.
3. Examinez les erreurs ou journaux visibles et assurez-vous qu’ils n’exposent pas la valeur de la clé.

Si le service vous fournit des clés de test et des clés live distinctes, utilisez la clé de test pendant la création de votre app. Utilisez la clé live uniquement après la publication de votre app. Si le test échoue, consultez le tableau de bord du fournisseur pour confirmer que la clé est active et qu’elle a l’autorisation d’effectuer l’action demandée. Ne collez jamais la valeur de la clé dans Chat lors du dépannage.

Comprendre le fonctionnement de Clés

Avant d’ajouter des clés, il est utile de comprendre ce qu’Atoms stocke et comment protéger vos identifiants.

Ce qu’Atoms stocke

Cloud Atoms → Clés stocke les identifiants que votre app utilise pour se connecter à des services externes, tels que des clés API et des jetons d’accès.

Chaque clé enregistrée possède un nom, une description et une valeur privée. Le nom et la description aident l’Agent à comprendre quand utiliser la clé, tandis que la valeur privée reste masquée dans le Chat.

Où obtenir une clé

Atoms ne crée ni ne fournit d’identifiants pour des services externes. Vous devez les obtenir auprès du fournisseur de service concerné. Suivez les instructions du fournisseur lors du choix des autorisations, du test de la clé et de la vérification de son expiration éventuelle.

Garder les identifiants privés secrets

Ne collez jamais un identifiant privé dans le Chat, le code source, le code exécuté dans le navigateur, les captures d’écran, les journaux ou les messages d’assistance. Enregistrez-le dans Clés, puis référencez l’entrée enregistrée par son nom.

Si une valeur privée a déjà été exposée, considérez-la comme compromise et révoquez-la ou faites-la tourner via le fournisseur.

Identifiants privés et sûrs pour le navigateur

Clés n’étiquette pas les valeurs enregistrées comme Publiques ou Privées. Enregistrer une valeur dans Clés ne la rend pas automatiquement sûre à utiliser dans du code exposé au navigateur. Si votre app utilise la valeur dans le navigateur, les visiteurs peuvent être en mesure de l’inspecter.

Consultez la documentation du fournisseur avant de décider où utiliser un identifiant :

• Utilisez une valeur dans du code exposé au navigateur uniquement lorsque le fournisseur indique explicitement qu’elle peut être exposée sans risque.
• Conservez les identifiants privés dans une logique côté serveur ou backend, où ils ne sont pas exposés aux visiteurs de l’app.

Choisir l’environnement et le stockage de la clé

Lors de l’ajout d’une clé, vous devez prendre deux décisions distinctes :

• Quel environnement utilisera la clé.
• Si la clé restera dans ce projet ou sera disponible pour d’autres projets.

Choisir un environnement

Option	Quand elle est utilisée
Clés de test	Utilisées pendant le développement et les tests de votre app dans la Visionneuse d'App. Si vous n’ajoutez pas de valeur de Production distincte, l’app publiée utilisera également la valeur de test.
Clés de Production	Utilisées par l’app publiée lorsqu’elle nécessite un identifiant live distinct. Les valeurs de Production sont ajoutées pendant le processus de publication et gérées séparément des valeurs de test.

Choisir où enregistrer la clé

Option	Quand l’utiliser
Dans ce projet	Choisissez cette option pour une clé qui doit être utilisée uniquement par le projet actuel.
Bibliothèque de clés	Choisissez cette option lorsque vous souhaitez délibérément réutiliser une clé dans plusieurs projets. Lors de l’ajout ou de la mise à jour d’une clé de test, sélectionnez Enregistrer dans la bibliothèque pour la rendre disponible dans la bibliothèque.

L’environnement et l’emplacement de stockage sont indépendants. Enregistrer une clé de test dans la Bibliothèque de clés la rend réutilisable, mais cela n’en fait pas une valeur de Production.

Utilisez Dans ce projet par défaut. Enregistrez une clé dans la bibliothèque uniquement lorsque vous êtes certain qu’elle doit être partagée entre plusieurs projets.

Utiliser une valeur de Production distincte

Lorsque vous publiez un projet qui utilise une clé enregistrée, le flux de publication peut vous demander de configurer des Clés de Production. Par défaut, l’app publiée utilise la valeur de test. Pour utiliser un identifiant différent, sélectionnez Production et enregistrez une valeur distincte pour la clé.

Utilisez une valeur de Production distincte lorsque :

• Le fournisseur fournit des identifiants de test et live différents.
• Vous ne voulez pas que l’identifiant utilisé pendant le développement soit utilisé par l’app publiée.

Les valeurs de Production sont créées via le flux de publication. Vous ne pouvez pas en créer une en sélectionnant Nouvelle clé depuis l’onglet Clés de Production. Après qu’une valeur de Production a été configurée pour une app publiée, vous pouvez la voir dans Cloud Atoms → Clés → Clés de Production.

Après avoir publié ou mis à jour l’app, répétez le parcours utilisateur concerné sur le site web publié pour confirmer que la clé de Production fonctionne correctement. Pour le processus complet de déploiement, consultez Publier et déployer.

Mettre à jour ou faire tourner un identifiant

Mettre à jour une valeur de test enregistrée

1. Ouvrez Cloud Atoms → Clés → Clés de test.
2. Ouvrez Dans ce projet ou Bibliothèque de clés, selon l’endroit où l’entrée a été enregistrée.
3. Sélectionnez la Valeur ou la Description de la clé, saisissez les informations mises à jour, puis sélectionnez Mettre à jour.
4. Attendez Enregistrement réussi, puis testez à nouveau le flux concerné.

Rotation planifiée de clé

Suivez ces étapes lorsque l’identifiant existant est toujours sécurisé et que vous souhaitez le remplacer sans interrompre votre app :

1. Créez un identifiant de remplacement via le fournisseur de service.
2. Remplacez la valeur de test dans Atoms, puis testez la fonctionnalité concernée dans la Visionneuse d'App.
3. Si l’app publiée utilise une valeur de Production distincte, remplacez-la et publiez la mise à jour.
4. Testez la même fonctionnalité sur le site web publié.
5. Après avoir confirmé que le remplacement fonctionne correctement, révoquez l’ancien identifiant via le fournisseur.

Si un identifiant a pu être exposé

Considérez l’identifiant comme compromis et agissez immédiatement :

1. Révoquez-le ou désactivez-le via le fournisseur de service.
2. Créez un identifiant de remplacement.
3. Mettez à jour les valeurs de test et de Production concernées dans Atoms.
4. Testez à nouveau les fonctionnalités concernées à la fois dans la Visionneuse d'App et dans l’app publiée.
5. Supprimez toute copie exposée du code source, du Chat, des captures d’écran et des journaux lorsque c’est possible.

Supprimer une clé ou retirer sa valeur d’Atoms ne révoque pas l’identifiant d’origine. Vous devez le révoquer via le fournisseur de service.

Supprimer un identifiant

Avant de supprimer une clé enregistrée, assurez-vous que votre app n’en dépend plus :

1. Supprimez la fonctionnalité qui utilise la clé, ou remplacez ses références par une autre clé enregistrée.
2. Révoquez l’identifiant d’origine via le fournisseur de service afin qu’il ne puisse plus être utilisé.
3. Ouvrez Cloud Atoms → Clés, trouvez l’entrée inactive, sélectionnez Supprimer, puis confirmez.

La suppression d’une clé est irréversible. Elle peut également casser des aperçus ou d’anciens checkpoints qui y font encore référence. Si Supprimer n’est pas disponible, la clé est toujours marquée comme active. Supprimez ou remplacez chaque référence à celle-ci avant de réessayer.

FAQ

Ma clé de test fonctionne dans Visionneuse d'App mais pas après la publication. Pourquoi ?

Si votre clé de test fonctionne dans Visionneuse d'App mais que l’app publiée échoue parce qu’une clé est manquante ou vide :

1. Vérifiez si la valeur de test ou de Production concernée a été enregistrée avant ou après la dernière publication. Si elle a été enregistrée après, publiez à nouveau pour que la modification prenne effet.
2. Vérifiez que la clé enregistrée possède la bonne valeur de test ou de Production. L’app publiée utilise la valeur de test sauf si une valeur de Production distincte est configurée.
3. Examinez les erreurs du service en aval pour obtenir des indices. « Unauthorized » indique souvent une clé vide ou incorrecte pour cet environnement.

Si le problème persiste, contactez le Support et incluez :

• Lien du projet ou URL live
• Le nom de la clé concernée et si le problème touche la valeur de test ou de Production
• L’erreur complète du service en aval
• Une capture d’écran nettoyée de la page de configuration
• Si la configuration de la clé a été enregistrée avant ou après la publication

Important : fournissez uniquement les noms des clés. N’envoyez PAS de valeurs secrètes, de mots de passe ou de jetons.