# General Translation Platform: API-ключи
URL: https://generaltranslation.com/ru/docs/platform/dashboard/reference/api-keys.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Создавайте API-ключи уровня проекта и организация и управляйте ими для приложений, локальной разработки и автоматизации. Справочник по API-ключам.

API-ключи позволяют аутентифицировать ваши приложения, CLI и средства автоматизации в General Translation. Используйте ключ с минимально необходимой областью для вашего рабочего процесса.

## Области ключей [#key-scopes]

General Translation поддерживает две области API-ключей:

* **ключи организация** для автоматизации на уровне организация. Используйте их для автоматизации на уровне организации или рабочий процессs, которым нужен доступ к нескольким проектам в рамках организация.
* **ключи проекта** для одного проекта. Используйте их в server-окружениях, при локальной разработке и в инструментах в области проекта. Никогда не включайте их в развернутые browser- или мобильные бандлы приложения.

В Dashboard обе области поддерживают разрешения **All** или **Custom**. **All** выдает все разрешения, которые вы можете делегировать в рамках этой области. **Custom** позволяет выбрать меньший набор; выберите хотя бы одно разрешение. Вы можете выдавать только те разрешения, которыми обладаете сами.

## Создание ключей организация [#create-organization-keys]

Создайте ключи организация в разделе **организация > Developer > API Keys**. Ключи организация используют префикс `gtx-org-` и могут быть настроены с собственным набором разрешений.

В этих элементах управления Dashboard разрешения настраиваются отдельно для каждого ресурса. `Write` включает `Read`.

| Ресурс                | Read                                   | Write or enabled                                                           |
| --------------------- | -------------------------------------- | -------------------------------------------------------------------------- |
| **Создание проекта**  | Неприменимо                            | Создание новых проектов в организация                                      |
| **API-ключи проекта** | Просмотр API-ключей проектов           | Просмотр и создание API-ключей проекта                                     |
| **Files**             | Чтение файлов проекта и переводов      | Загрузка исходного содержимого и запись переведённых файлов                |
| **Context**           | Чтение контекста проекта и организация | Управление контекстными группами, Glossary и пользовательскими подсказками |
| **runtime-перевод**   | Неприменимо                            | Перевод контента по запросу                                                |
| **очередь перевода**  | Неприменимо                            | Постановка задач перевода файлов в очередь для фоновой обработки           |
| **Настройки проекта** | Неприменимо                            | Обновление настроек проекта, например локали по умолчанию и CDN delivery   |

Включите **Создание проекта** для автоматизации, вызывающей эндпоинт [Создание проекта](/docs/platform/openapi/reference/project/create-project). Его разрешение `org:projects:create` также позволяет создавать проекты с включённой CDN delivery, а **Настройки проекта** (`project:write`) нужны только для последующего изменения настроек. Предоставляйте каждому ключу только необходимые ему разрешения.

Установите для **Context** значение **Read** или **Write** для автоматизации, вызывающей [Context Management API](/docs/platform/openapi/reference/context-management/list-groups) (`org:context:read` / `org:context:write`). Ключи проекта не могут управлять контекстными группами.

Установите для **API-ключей проекта** значение **Write** для автоматизации, вызывающей [Создание API-ключа проекта](/docs/platform/openapi/reference/project/create-api-key). Для проекта в организации используйте ключ этой организации с необходимыми разрешениями. Ключи проекта не могут создавать другие ключи.

При создании ключей через [HTTP API](/docs/platform/openapi/reference/project/create-api-key) укажите разрешения явно или не указывайте их вовсе — тогда будут предоставлены все разрешения проекта, которые вы можете делегировать. В отличие от элементов управления Dashboard, явно предоставленное через HTTP разрешение Write не включает Read.

## Создание ключей проекта [#create-project-keys]

Ключи проекта создаются в разделе **Project > API Keys**. Новые ключи начинаются с `gtx-api-` и работают в окружениях разработки, staging и production. Их разрешения определяют, какие операции они могут выполнять.

1. Создайте ключ и укажите понятное **Name**.
2. В разделе **Разрешения** выберите **All** или **Custom**.
3. Для варианта **Custom** задайте уровень доступа, необходимый для каждого ресурса.
4. Нажмите **Create** и сразу скопируйте ключ целиком. Храните его в переменных окружения или в менеджере секретов.

Ключи проекта поддерживают следующие ресурсы:

| Ресурс                | Чтение                            | Запись или включение                                        |
| --------------------- | --------------------------------- | ----------------------------------------------------------- |
| **Files**             | Чтение файлов проекта и переводов | Загрузка исходного содержимого и запись переведённых файлов |
| **Context**           | Чтение контекста проекта          | Управление контекстом проекта                               |
| **runtime-перевод**   | Не применяется                    | Перевод содержимого по запросу                              |
| **очередь перевода**  | Не применяется                    | Постановка задач перевода файлов в очередь                  |
| **настройки проекта** | Не применяется                    | Изменение настроек проекта                                  |

Для локального перевода по запросу подойдёт любой ключ проекта с разрешением `project:translations:generate`, в том числе ключ с полным доступом. Чтобы снизить риски, рекомендуем завести отдельный ключ с разрешениями **Custom**: для **runtime-перевода** выберите **Enabled**, а остальным ресурсам оставьте значение **None**. Для pipeline перевода файлов выдайте **Files > Write** и **очередь перевода > Enabled**; добавьте **Context > Write**, если pipeline генерирует контекст.

Настройка SDK `devApiKey` и переменная окружения `GT_DEV_API_KEY` по-прежнему включают перевод в процессе разработки и горячую перезагрузку. Укажите в этой настройке ключ проекта с разрешением на runtime-перевод. Название настройки не означает, что требуется отдельный тип ключа.

В большинстве рабочих процессов SDK и CLI используйте ключ вместе с ID проекта:

```bash
GT_API_KEY=gtx-api-...
GT_PROJECT_ID=...
```

Для доступа к CLI через учётную запись используйте [`gt login`](/docs/cli/reference/commands/login). Чтобы создать в CLI ключ проекта с явно заданными разрешениями, используйте [`gt api-key create`](/docs/cli/reference/commands/api-key-create).

## Управление ключами [#manage-keys]

Используйте понятные названия, чтобы ключи потом было легко находить.

Откройте список ключей в проекте или организация, чтобы просмотреть существующие ключи. В списке ключей отображаются:

* **Name** и **Key** — включая сокращённый ключ для удобного распознавания
* **разрешение** — как для ключей проекта, так и для ключей организация
* **Created** — дата создания ключа
* **Last Used** — когда ключ использовался в последний раз

При наличии разрешения на управление ключами используйте **Edit key**, чтобы переименовать ключ или изменить его разрешения, и **Delete**, чтобы отозвать его. Полный секрет отображается только в момент создания ключа.

Отзывайте ключи, которые больше не используются, и создавайте новые при ротации учётных данных.

## Существующие ключи разработки [#existing-keys]

Существующие ключи `gtx-dev-` по-прежнему проходят аутентификацию как ключи проекта. Ключи со старым разрешением по умолчанию (только runtime) теперь получают разрешения проекта по умолчанию, включая файлы, контекст, очередь перевода и настройки проекта. Остальные пользовательские наборы разрешений сохраняются.

Проверьте существующие ключи в разделе **Project > API Keys**. Для локальной разработки рекомендуем ограничить их до **runtime-перевода** или заменить новыми ключами, работающими только в runtime. Ключи с полным доступом продолжают работать, но префикс `gtx-dev-` больше не означает ограниченные разрешения. Никогда не включайте такие ключи в клиентские бандлы, которые вы развёртываете.

## Рекомендации по безопасности [#security-practices]

* Никогда не коммитьте ключи в систему контроля версий.
* Никогда не включайте API-ключи в развёрнутые бандлы браузерных или мобильных приложений, независимо от их разрешений. Храните учётные данные развёрнутых приложений в серверных переменных окружения или в менеджере секретов.
* API-ключи можно использовать в клиентском коде, который отдаётся только вашим локальным сервером разработки. Проектные ключи с полным доступом тоже работают, но мы рекомендуем ограничивать локальные ключи разработки разрешением **Runtime-перевод** (`project:translations:generate`), чтобы минимизировать риски.
* Храните ключи в переменных окружения или в менеджере секретов.
* Используйте отдельные ключи для разработки, стейджинга и продакшена.
* Регулярно меняйте ключи.
* Отзывайте неиспользуемые ключи.
* Выбирайте минимально необходимую для интеграции область.

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.