Clés API

Aperçu

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

Clé API de production : Celle-ci est utilisée pour traduire votre contenu en production.
Clé API de développement : Celle-ci est utilisée pour traduire votre contenu en développement.

Le comportement entre les deux types de clés est différent, vous devez donc veiller à utiliser la bonne clé 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 clés API.

Comment les obtenir

Accédez au tableau de bord de votre projet sur le site web de General Translation.

Cliquez sur l'onglet "API Keys" ou "Developer Keys".

Cliquez sur le bouton "Create API Key".

Copiez la clé API et collez-la dans le fichier .env de votre projet.

En termes simples, les clés API Prod conservent les traductions, tandis que les clés API Dev ne le font pas. Vous utilisez les clés API Dev pour prototyper des traductions et les clés API Prod lorsque vous êtes prêt à déployer.

Clé API de développement

Ce type de clé est utile à des fins de test et de développement. Lors de l'utilisation d'une clé API de développement, les traductions sont effectuées à la demande et mémorisées en mémoire. Les traductions ne seront pas sauvegardées.

La clé API de développement est utilisée par les composants rendus dans le navigateur (côté client) et par les composants rendus côté serveur pour faciliter la traduction à la demande. Cela signifie qu'elle doit être exportée vers le client. Cette clé ne devrait JAMAIS être utilisée dans des environnements de production et ne devrait JAMAIS être transmise au client dans un environnement de production.

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

Avertissement : Les clés API de développement sont transmises au client pour faciliter la traduction côté client en développement. C'est acceptable dans les environnements de développement, mais constitue un risque de sécurité dans les environnements de production. Si votre application est ouverte sur internet, vous ne devriez jamais utiliser une clé API de développement.

Clé API de production

Lors de l'utilisation d'une clé API de production, les traductions sont persistantes. Cela signifie que les traductions seront sauvegardées (soit dans un CDN, soit dans le bundle de votre application) pour être utilisées au moment de l'exécution.

Cette clé est utilisée à deux endroits :

L'outil gtx-cli. Consultez ce guide pour plus d'informations.
La bibliothèque gt-next lorsque les traductions se produisent au moment de l'exécution dans une version de production (côté serveur uniquement, non utilisée par gt-react).
- Les fonctions <Tx> et tx() sont utilisées pour traduire le contenu au moment de l'exécution.

La clé API est uniquement utilisée par le serveur, et elle ne devrait JAMAIS être exportée vers le client.

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

Remarques

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

Prochaines étapes

Découvrez comment utiliser le composant <T> pour voir les traductions en direct en développement.
Consultez le guide d'utilisation pour l'outil CLI.