API Keys
Comment utiliser les clés d’API avec General Translation
Vue d’ensemble
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 à l’environnement dans lequel vous vous trouvez.
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-keySi vous utilisez gt-next ou gt-react comme bibliothèque i18n autonome, vous n’avez pas besoin d’utiliser des clés d’API.
Comment l’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é d’API et collez-la dans le fichier .env de votre projet.
Comportement
En bref, les API Keys Prod conservent les traductions, tandis que les API Keys Dev ne les conservent 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. Lorsque vous utilisez une clé d’API de développement, 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 pour 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 en 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éveloppementAvertissement : Les clés d’API de développement sont transmises au client pour faciliter la traduction côté client en environnement de développement. Cela est acceptable en développement, mais constitue un risque de sécurité en production. Si votre application est accessible sur Internet, n’utilisez jamais une clé d’API de 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, réseau de diffusion de contenu, ou dans le bundle de votre application) pour être utilisées à l’exécution.
Cette clé est utilisée à deux endroits :
- Par l’outil
gtx-cli. Consultez la documentation pour plus d’informations. - Par la bibliothèque
gt-nextlorsque les traductions s’effectuent à l’exécution dans un build de production (côté serveur uniquement, pas utilisé pargt-react).
La clé d’API est uniquement utilisée côté 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é clientNotes
- 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 aux environnements de production.
Prochaines étapes
- Découvrez comment utiliser le composant
<T>pour afficher des traductions en temps réel pendant le développement.
Comment trouvez-vous ce guide ?