API-Schlüssel

Überblick

Es gibt zwei Arten von API-Schlüsseln, die mit General Translation verwendet werden:

Produktions-API-Schlüssel: Dieser wird verwendet, um Ihre Inhalte in der Produktion zu übersetzen.
Entwicklungs-API-Schlüssel: Dieser wird verwendet, um Ihre Inhalte in der Entwicklung zu übersetzen.

Das Verhalten zwischen den beiden Schlüsseltypen ist unterschiedlich, daher sollten Sie darauf achten, den richtigen Schlüssel für die Umgebung zu verwenden, in der Sie sich befinden.

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

Wenn Sie gt-next oder gt-react als eigenständige i18n-Bibliothek verwenden, müssen Sie keine API-Schlüssel verwenden.

Wie man sie erhält

Navigieren Sie zum Projekt-Dashboard auf der General Translation Website.

Klicken Sie auf den Tab "API-Schlüssel" oder "Entwicklerschlüssel".

Klicken Sie auf die Schaltfläche "API-Schlüssel erstellen".

Kopieren Sie den API-Schlüssel und fügen Sie ihn in die .env-Datei Ihres Projekts ein.

Einfach ausgedrückt: Prod-API-Schlüssel speichern Übersetzungen dauerhaft, während Dev-API-Schlüssel dies nicht tun. Sie verwenden Dev-API-Schlüssel für Prototyp-Übersetzungen und Prod-API-Schlüssel, wenn Sie bereit sind für den Einsatz.

Development API Key

Diese Art von Schlüssel ist nützlich für Test- und Entwicklungszwecke. Bei Verwendung eines Development-API-Schlüssels werden Übersetzungen bei Bedarf durchgeführt und im Speicher zwischengespeichert. Übersetzungen werden nicht gespeichert.

Der Development-API-Schlüssel wird von Komponenten verwendet, die im Browser gerendert werden (clientseitig), und von serverseitig gerenderten Komponenten, um die Übersetzung bei Bedarf zu ermöglichen. Das bedeutet, dass er an den Client exportiert werden muss. Dieser Schlüssel sollte NIEMALS in Produktionsumgebungen verwendet und NIEMALS in einer Produktionsumgebung an den Client übergeben werden.

# example Vite .env file for dev
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Only used in development

Warnung: Development-API-Schlüssel werden an den Client übergeben, um clientseitige Übersetzungen in der Entwicklung zu ermöglichen. Dies ist in Entwicklungsumgebungen in Ordnung, stellt aber in Produktionsumgebungen ein Sicherheitsrisiko dar. Wenn Ihre Anwendung für das Internet zugänglich ist, sollten Sie niemals einen Development-API-Schlüssel verwenden.

Production API Key

Bei Verwendung eines Production-API-Schlüssels werden Übersetzungen dauerhaft gespeichert. Das bedeutet, dass Übersetzungen gespeichert werden (entweder in einem CDN oder im Bundle Ihrer App), um zur Laufzeit verwendet zu werden.

Dieser Schlüssel wird an zwei Stellen verwendet:

Das gtx-cli Tool. Weitere Informationen finden Sie in dieser Anleitung.
Die gt-next Bibliothek, wenn Übersetzungen zur Laufzeit in einem Produktions-Build stattfinden (nur serverseitig, nicht von gt-react verwendet).
- <Tx> und tx() Funktionen werden verwendet, um Inhalte zur Laufzeit zu übersetzen.

Der API-Schlüssel wird nur vom Server verwendet und sollte NIEMALS an den Client exportiert werden.

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # This key should never be exported to the client

Hinweise

Entwicklungs-API-Schlüssel werden für Test- und Entwicklungszwecke verwendet. Sie sollten nur in der Entwicklung verwendet werden.
Produktions-API-Schlüssel werden für Produktionszwecke verwendet.

Nächste Schritte

Erfahren Sie, wie Sie die <T>-Komponente verwenden, um Live-Übersetzungen in der Entwicklung zu sehen.
Sehen Sie sich die Nutzungsanleitung für das CLI-Tool an.