Консоль

API‑ключи

Как использовать API‑ключи в General Translation

Обзор

В General Translation используются два типа API‑ключей:

  • Production API Key: используется для перевода контента в продакшене.
  • Development API Key: используется для перевода контента в среде разработки.

Поведение этих двух типов ключей различается, поэтому важно использовать правильный ключ для соответствующего окружения.

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

Если вы используете gt-next или gt-react как автономную библиотеку i18n, ключи API не требуются.

Как получить

Перейдите в панель управления проектом на сайте General Translation.

Откройте вкладку «API Keys» или «Developer Keys».

Нажмите кнопку «Create API Key».

Скопируйте ключ API и вставьте его в файл .env вашего проекта.

Поведение

Проще говоря, Prod API-ключи сохраняют переводы, а Dev API-ключи — нет. Используйте Dev API-ключи для прототипирования переводов, а Prod API-ключи — когда вы готовы к развёртыванию.

Ключ API для разработки

Этот тип ключа удобен для тестирования и разработки. При использовании ключа разработки переводы выполняются по запросу и кэшируются в памяти. Переводы не сохраняются.

Ключ разработки используется компонентами, рендерящимися в браузере (на стороне клиента), а также компонентами, рендерящимися на сервере, чтобы обеспечивать перевод по запросу. Это означает, что его нужно экспортировать на клиент. Этот ключ НИКОГДА нельзя использовать в продакшене и НИКОГДА нельзя передавать на клиент в продакшен‑окружении.

# пример файла Vite .env для разработки
VITE_GT_PROJECT_ID=your-project-id
VITE_GT_API_KEY=your-dev-api-key # Используется только при разработке

Предупреждение: Ключи Development API передаются на клиент, чтобы обеспечить клиентскую переводку в ходе разработки. Это допустимо в среде разработки, но представляет угрозу безопасности в продакшене. Если ваше приложение доступно из интернета, никогда не используйте ключ Development 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 # Этот ключ никогда не должен передаваться на клиент

Примечания

  • Ключи Development API предназначены для тестирования и разработки. Их следует использовать только в среде разработки.
  • Ключи Production API предназначены для эксплуатации (продакшена).

Дальнейшие шаги

  • Узнайте, как использовать компонент <T>, чтобы видеть актуальные переводы во время разработки.

Насколько полезно это руководство?

На этой странице

Обзор
Как получить
Поведение
Ключ API для разработки
Продуктивный ключ API
Примечания
Дальнейшие шаги
API‑ключи