API 密钥

概述

General Translation 使用两种类型的 API 密钥：

这两种类型的密钥行为不同，因此您应该注意在相应环境中使用正确的密钥。

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

如果您将 gt-next 或 gt-react 作为独立的 i18n 库使用，则不需要使用 API 密钥。

导航到 General Translation 网站上的项目仪表板。

点击 "API 密钥" 或 "开发者密钥" 选项卡。

点击 "创建 API 密钥" 按钮。

复制 API 密钥并粘贴到项目的 .env 文件中。

简单来说，Prod API 密钥会持久化翻译，而 Dev API 密钥则不会。您在原型设计翻译时使用 Dev API 密钥，在准备部署时使用 Prod API 密钥。

这种类型的密钥适用于测试和开发目的。使用开发 API 密钥时，翻译是按需进行的并在内存中进行记忆化。翻译不会被保存。

开发 API 密钥由浏览器中渲染的组件（客户端）和服务器端渲染的组件使用，以便进行按需翻译。这意味着它必须导出到客户端。此密钥绝不应在生产环境中使用，也绝不应在生产环境中传递给客户端。

# Vite .env 文件示例（用于开发环境）
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # 仅在开发中使用

警告： 开发 API 密钥会传递给客户端以便在开发中进行客户端翻译。这在开发环境中是可以的，但在生产环境中存在安全风险。如果您的应用程序对互联网开放，您绝不应使用开发 API 密钥。

使用生产 API 密钥时，翻译会被持久化。这意味着翻译将被保存（无论是在 CDN 中还是在您的应用程序包中）以便在运行时使用。

此密钥在两个地方使用：

gtx-cli 工具。查看此指南获取更多信息。
当在生产构建中的运行时进行翻译时，gt-next 库（仅服务器端，不被 gt-react 使用）。
- <Tx> 和 tx() 函数用于在运行时翻译内容。

API 密钥仅由服务器使用，绝不应导出到客户端。

GT_PROJECT_ID=your-project-id
GT_API_KEY=your-prod-api-key # 此密钥绝不应导出到客户端