API-Schlüssel
Verwendung von API-Schlüsseln mit General Translation
Überblick
Bei General Translation kommen zwei Arten von API-Schlüsseln zum Einsatz:
- Produktions-API-Schlüssel: Dient zum Übersetzen Ihrer Inhalte in der Produktion.
- Entwicklungs-API-Schlüssel: Dient zum Übersetzen Ihrer Inhalte in der Entwicklungsumgebung.
Die beiden Schlüsseltypen verhalten sich unterschiedlich. Achten Sie daher darauf, in der jeweiligen Umgebung den richtigen Schlüssel zu verwenden.
GT_PROJECT_ID=deine-projekt-id
GT_API_KEY=dein-api-keyWenn Sie gt-next oder gt-react als eigenständige i18n-Bibliothek verwenden, benötigen Sie keine API-Schlüssel.
So erhältst du ihn
Navigiere zu deinem Projekt-Dashboard auf der General Translation-Website.
Klicke auf den Tab „API Keys“ oder „Developer Keys“.
Klicke auf die Schaltfläche „Create API Key“.
Kopiere den API-Schlüssel und füge ihn in die .env-Datei deines Projekts ein.
Verhalten
Kurz gesagt: Prod-API-Schlüssel speichern Übersetzungen dauerhaft, Dev-API-Schlüssel nicht. Verwenden Sie Dev-API-Schlüssel zum Prototyping von Übersetzungen und Prod-API-Schlüssel, wenn Sie für die Bereitstellung bereit sind.
Entwicklungs-API-Schlüssel
Dieser Schlüsseltyp ist für Test- und Entwicklungszwecke geeignet. Bei Verwendung eines Entwicklungs-API-Schlüssels werden Übersetzungen als On-Demand-Übersetzung ausgeführt und im Arbeitsspeicher zwischengespeichert. Übersetzungen werden nicht gespeichert.
Der Entwicklungs-API-Schlüssel wird von im Browser gerenderten Komponenten (client-side) und von serverseitig gerenderten Komponenten verwendet, um On-Demand-Übersetzung zu ermöglichen. Das bedeutet, dass er an den Client exportiert werden muss. Dieser Schlüssel darf NIEMALS in Produktionsumgebungen verwendet und NIEMALS in einer Produktionsumgebung an den Client weitergegeben werden.
# Beispiel einer Vite-.env-Datei für die Entwicklung
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Wird nur in der Entwicklung verwendetWarnung: Entwicklungs-API-Schlüssel werden an den Client übergeben, um clientseitige Übersetzung während der Entwicklung zu ermöglichen. Das ist in Entwicklungsumgebungen in Ordnung, stellt jedoch in Produktionsumgebungen ein Sicherheitsrisiko dar. Wenn Ihre Anwendung aus dem Internet erreichbar ist, 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 [Content Delivery Network] oder im Bundle deiner App) und zur Laufzeit zur Verfügung stehen.
Dieser Schlüssel wird an zwei Stellen verwendet:
- Beim Tool
gtx-cli. Sieh dir die Dokumentation für weitere Informationen an. - In der Bibliothek
gt-next, wenn Übersetzungen zur Laufzeit in einem Produktionsbuild erfolgen (nur serverseitig; wird vongt-reactnicht verwendet).
Der API-Schlüssel wird nur vom Server verwendet und darf NIEMALS an den Client exportiert 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 Produktionszwecke verwendet.
Nächste Schritte
- Informieren Sie sich darüber, wie Sie die
<T>‑Komponente verwenden, um während der Entwicklung Live‑Übersetzungen anzuzeigen.
Wie ist diese Anleitung?