Vue d’ensemble

Il existe deux types d’API Keys utilisées avec General Translation :

• Production API Key : utilisée pour traduire votre contenu en production.
• Development API Key : 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 opérez.

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

Si vous utilisez gt-next ou gt-react comme bibliothèques i18n autonomes, vous n’avez pas besoin d’utiliser des API Keys.

Comment l’obtenir

Comportement

Pour faire simple, les API Keys Prod enregistrent les traductions, tandis que les API Keys Dev ne les enregistrent pas. Utilisez des API Keys Dev pour prototyper vos 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 mises en cache en mémoire. Les traductions ne seront pas enregistrées.

La clé d’API de développement est utilisée par les composants rendus dans le navigateur (côté client) 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 Vite .env 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

Lorsque vous utilisez une clé d’API de production, les traductions sont conservées. Autrement dit, elles sont enregistrées (dans un CDN ou dans le bundle de votre application) pour être utilisées à l’exécution.

Cette clé est utilisée à deux endroits :

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

La clé d’API est uniquement utilisée côté serveur et ne doit JAMAIS être exportée vers le client.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # Cette clé ne doit jamais être exportée vers le client

Notes

• Les clés d’API de développement sont destinées aux tests et au développement. Elles ne doivent être utilisées qu’en environnement de développement.
• Les clés d’API de production sont destinées à l’environnement de production.

Prochaines étapes

• Découvrez comment utiliser le composant <T> pour afficher des traductions en temps réel en développement.