API Keys
Verwendung von API-Schlüsseln mit General Translation
Übersicht
Es gibt zwei Arten von API-Schlüsseln, die mit General Translation verwendet werden:
- Production API Key: Wird in der Produktion zum Übersetzen Ihrer Inhalte verwendet.
- Development API Key: Wird in der Entwicklung zum Übersetzen Ihrer Inhalte verwendet.
Das Verhalten der beiden Schlüsseltypen unterscheidet sich, daher sollten Sie darauf achten, den richtigen Schlüssel für die jeweilige Umgebung zu verwenden.
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-api-keyWenn Sie gt-next oder gt-react als eigenständige i18n‑Bibliothek verwenden, benötigen Sie keine API-Schlüssel.
So erhalten Sie ihn
Navigieren Sie zu Ihrem Projekt-Dashboard auf der General Translation-Website.
Klicken Sie auf den Tab „API Keys“ oder „Developer Keys“.
Klicken Sie auf die Schaltfläche „Create API Key“.
Kopieren Sie den API-Schlüssel und fügen Sie ihn in die .env-Datei Ihres Projekts ein.
Verhalten
Kurz gesagt werden mit Prod API Keys Übersetzungen gespeichert, mit Dev API Keys hingegen nicht. Verwenden Sie Dev API Keys zum Prototyping von Übersetzungen und Prod API Keys, wenn Sie für die Bereitstellung bereit sind.
Entwicklungs-API-Schlüssel
Dieser Schlüsseltyp eignet sich für Tests und die Entwicklung. Bei Verwendung eines Entwicklungs-API-Schlüssels erfolgen Übersetzungen als On-Demand-Übersetzungen und werden im Speicher zwischengespeichert (memoisiert). Übersetzungen werden nicht dauerhaft gespeichert.
Der Entwicklungs-API-Schlüssel wird von im Browser gerenderten Komponenten (clientseitig) und von serverseitig gerenderten Komponenten verwendet, um On-Demand-Übersetzungen zu ermöglichen. Das bedeutet, dass er an den Client exportiert werden muss. Dieser Schlüssel darf NIEMALS in Produktionsumgebungen verwendet werden und NIEMALS in einer Produktionsumgebung an den Client übermittelt werden.
# Beispiel Vite .env-Datei für dev
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Nur in der Entwicklung verwendetWarnung: Entwicklungs-API-Schlüssel werden an den Client weitergegeben, um clientseitige Übersetzungen in der Entwicklung zu ermöglichen. Das ist in Entwicklungsumgebungen unproblematisch, stellt in Produktionsumgebungen jedoch ein Sicherheitsrisiko dar. Ist Ihre Anwendung öffentlich im Internet erreichbar, sollten Sie niemals einen Entwicklungs-API-Schlüssel verwenden.
Produktions-API-Schlüssel
Bei Verwendung eines Produktions-API-Schlüssels werden Übersetzungen persistiert. Das bedeutet, dass Übersetzungen gespeichert werden (entweder in einem CDN oder im Bundle deiner App), um zur Laufzeit verfügbar zu sein.
Dieser Schlüssel wird an zwei Stellen verwendet:
- Im Tool
gtx-cli. Siehe die Dokumentation für weitere Informationen. - In der Bibliothek
gt-next, wenn Übersetzungen zur Laufzeit in einem Produktionsbuild erfolgen (ausschließlich serverseitig; wird nicht vongt-reactverwendet).
Der API-Schlüssel wird ausschließlich vom Server verwendet und darf NIEMALS an den Client ausgeliefert werden.
GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # Dieser Schlüssel darf niemals an den Client übertragen werdenHinweise
- Entwicklungs-API-Schlüssel werden für Test- und Entwicklungszwecke verwendet. Sie sollten nur in Entwicklungsumgebungen eingesetzt werden.
- Produktions-API-Schlüssel werden für den Einsatz in Produktionsumgebungen verwendet.
Nächste Schritte
- Erfahre, wie du die
<T>-Komponente verwendest, um während der Entwicklung Live-Übersetzungen zu sehen.
Wie ist dieser Leitfaden?