Aperçu

Il existe deux types de clés d’API utilisées avec General Translation :

• Clé d’API de production : utilisée pour traduire votre contenu en production.
• Clé d’API de développement : utilisée pour traduire votre contenu en développement.

Le comportement de ces deux types de clés diffère ; veillez donc à utiliser la clé appropriée pour l’environnement dans lequel vous vous trouvez.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-key

Si vous utilisez gt-next ou gt-react comme bibliothèque i18n autonome, vous n’avez pas besoin d’utiliser de API Keys.

Comment l’obtenir

Comportement

Pour faire simple, les API Keys Prod conservent les traductions, tandis que les API Keys Dev ne le font pas. Utilisez des API Keys Dev pour prototyper des traductions et des API Keys Prod lorsque vous êtes prêt à déployer.

Clé d’API de développement

Ce type de clé est utile pour les tests et le développement. Lorsqu’une clé d’API de développement est utilisée, les traductions sont effectuées à la demande et mémoïsées en mémoire. Les traductions ne sont pas enregistrées.

La clé d’API de développement est utilisée par les composants rendus dans le navigateur (client-side) ainsi que par les composants rendus côté serveur afin de faciliter la traduction à la demande. Cela signifie qu’elle doit être exposée au client. Cette clé ne doit JAMAIS être utilisée en production et ne doit JAMAIS être transmise au client dans un environnement de production.

# exemple de fichier .env Vite pour le dev
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Utilisé uniquement en développement

Clé d’API de production

Lorsqu’une clé d’API de production est utilisée, les traductions sont persistées. Autrement dit, elles sont enregistrées (dans un CDN — réseau de distribution de contenu — ou dans le bundle de votre application) pour être utilisées à l’exécution.

Cette clé est utilisée à deux endroits :

• Avec l’outil gtx-cli. Consultez la documentation pour en savoir plus.
• Par la bibliothèque gt-next lorsque les traductions s’effectuent à l’exécution dans une build de production (côté serveur uniquement, non utilisée par gt-react).
  • Les fonctions <Tx> et tx servent à traduire le contenu à l’exécution.

La clé d’API est utilisée uniquement par le serveur et ne doit JAMAIS être exposée au client.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # Cette clé ne doit jamais être exposée côté client

Notes

• Les clés d’API de développement sont utilisées à des fins de test et de développement. Elles ne doivent être utilisées qu’en environnement de développement.
• Les clés d’API de production sont utilisées à des fins de production.

Prochaines étapes

• Découvrez comment utiliser le composant <T> pour afficher les traductions en direct en environnement de développement.