# 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, которым нужен доступ к нескольким проектам в рамках организация.
* **ключи проекта** для одного проекта. Используйте их для развернутых приложений, локальной разработки, превью и инструментов в области проекта.

У ключей организация и ключей проекта разные способы создания. Ключи проекта создаются как рабочие ключи или ключи разработки. Для ключей организация используется селектор разрешений.

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

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

Разрешения настраиваются отдельно для каждого ресурса. `Write` включает `Read`.

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

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

Установите для **API-ключей проекта** значение **Write** для автоматизации, вызывающей [Создание API-ключа проекта](/docs/platform/openapi/reference/project/create-api-key). Этот эндпоинт принимает имя и необязательный тип ключа — production или ключ разработки; пользовательские разрешения он не принимает. Созданный ключ получает значения по умолчанию для своего типа, ограниченные теми разрешениями проекта, которыми обладает identity запроса. Identity запроса может быть ключом организация или OAuth-токеном доступа пользователя; ключи проекта не могут обладать необходимым разрешением `project:api_keys:write`.

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

Создавайте ключи проекта в разделе **проект > API Keys**. Сразу скопируйте ключ целиком и сохраните его в переменных окружения, менеджере секретов или другом безопасном хранилище.

* **Рабочие ключи** начинаются с `gtx-api-`.
  * Используйте их для загрузки файлов, задач перевода и автоматизации в продакшене. Ключи, созданные в дашборде, получают стандартные разрешения проекта; у ключа, созданного через организация API, делегированных разрешений может быть меньше.
* **Ключи разработки** начинаются с `gtx-dev-`.
  * Используйте их для перевода по запросу во время локальной разработки. Их разрешение по умолчанию — перевод во время выполнения; эндпоинты, доступные только в продакшене, такие ключи отклоняют.
  * Не используйте ключи разработки в продакшене.

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

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

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

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

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

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

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

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

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

* Никогда не коммитьте ключи в систему контроля версий.
* Храните ключи в переменных окружения или в менеджере секретов.
* Используйте отдельные ключи для разработки, стейджинга и продакшена.
* Регулярно меняйте ключи.
* Отзывайте неиспользуемые ключи.
* Выбирайте минимально необходимую для интеграции область.

## Sitemap

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