API-Schlüssel

Übersicht

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 der beiden Schlüsseltypen ist unterschiedlich, 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-key

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

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.

Einfach ausgedrückt: Prod-API-Schlüssel speichern Übersetzungen dauerhaft, während Dev-API-Schlüssel dies nicht tun. Du verwendest Dev-API-Schlüssel zum Prototyping von Übersetzungen und Prod-API-Schlüssel, wenn du bereit bist, zu deployen.

Entwicklungs-API-Schlüssel

Dieser Schlüsseltyp ist nützlich für Test- und Entwicklungszwecke. Bei Verwendung eines Entwicklungs-API-Schlüssels werden Übersetzungen bei Bedarf durchgeführt und im Speicher zwischengespeichert. Übersetzungen werden nicht gespeichert.

Der Entwicklungs-API-Schlüssel wird von Komponenten verwendet, die im Browser (Client-seitig) gerendert werden, sowie 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 werden und NIEMALS in einer Produktionsumgebung an den Client weitergegeben werden.

# Beispiel 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 verwendet

Warnung: Entwicklungs-API-Schlüssel werden an den Client weitergegeben, um clientseitige Übersetzungen in der Entwicklung zu ermöglichen. Das ist in Entwicklungsumgebungen in Ordnung, stellt aber ein Sicherheitsrisiko in Produktionsumgebungen dar. Wenn deine Anwendung öffentlich im Internet zugänglich ist, solltest du niemals einen Entwicklungs-API-Schlüssel verwenden.

Produktions-API-Schlüssel

Bei Verwendung eines Produktions-API-Schlüssels werden Übersetzungen gespeichert. Das bedeutet, dass Übersetzungen gespeichert werden (entweder in einem CDN oder im Bundle deiner App), um sie zur Laufzeit zu verwenden.

Dieser Schlüssel wird an zwei Stellen verwendet:

Im gtx-cli Tool. Sieh dir die Dokumentation für weitere Informationen an.
In der gt-next Bibliothek, wenn Übersetzungen zur Laufzeit in einem Produktions-Build stattfinden (nur serverseitig, nicht von gt-react verwendet).
- Die Funktionen <Tx> und tx() 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 # Dieser Schlüssel sollte niemals an den Client exportiert werden

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

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