API-ключи

Max PrilutskiyГенеральный директор и соучредитель4 мин чтения

API-ключи аутентифицируют запросы к API локализации и MCP-серверу. В Lingo.dev есть два типа ключей — выберите тот, который подходит под ваш сценарий вызова API.

Два типа ключей#

ПерсональныйОрганизационный
ВладелецПользователь, который его создалНет — предназначен для автоматизации
АвторизацияНаследует роль RBAC создателя и доступ к движкамБез RBAC — доступ к чтению и переводу во всей организации. С RBAC — своя роль и/или доступ к отдельным движкам
Если владелец теряет доступКлюч тоже теряет доступБез изменений. Принадлежит организации
ПланЛюбой тарифЛюбой план. Для настраиваемых ролей и ограничений требуется RBAC в плане Enterprise
Типичное использованиеЛокальная разработка, MCP, разовые скриптыCI/CD-пайплайны, продакшен-интеграции

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

Создание ключа#

Откройте страницу Ключи API в Настройках. Личные ключи и ключи организации находятся на отдельных вкладках. Оба типа доступны на всех планах. Для создания ключа организации нужно разрешение Управление ключами API (org:manage_api_keys).

Нажмите Новый персональный ключ, задайте имя (например, «Local MCP» или «Staging-ключ Макса») и скопируйте ключ, когда он появится на экране. Ключ наследует вашу текущую роль RBAC и права доступа к конкретным движкам.

Видимость ключа

Полный API-ключ показывается только один раз — в момент создания. Скопируйте его и сохраните в надёжном месте: после закрытия окна получить его повторно уже не получится.

Организационные ключи и RBAC#

Без RBAC обычные ключи организации дают доступ к чтению и переводу во всей организации. RBAC в плане Enterprise позволяет сузить полномочия:

  • Только роль: разрешения роли действуют во всей организации. Допускаются только engine:read и engine:translate.
  • Без роли + отдельные движки: ключ даёт доступ к указанным в нём движкам.
  • Роль + отдельные движки: доступ по роли и доступ к движкам складываются. Список движков не отменяет более широкие разрешения роли.
  • Ни то ни другое: пока RBAC включён, ключ не даёт доступа к движкам.

Для создания ключа организации нужно разрешение Управление ключами API. Чтобы назначить или изменить роль, предоставить доступ к движкам или настроить область доступа к контенту, также требуется RBAC. Роль должна принадлежать организации. Вы можете предоставить доступ только к тем движкам, с которыми можете переводить. В области доступа к контенту вы можете указать глоссарии, тональности бренда и наборы правил, которые можете редактировать.

Перед отключением RBAC

Если отключить RBAC, обычные ключи организации снова получат доступ к чтению и переводу во всей организации. Сохранённые ограничения по ролям и движкам больше не будут ограничивать этот доступ. Если эти ограничения нужны, отзовите или замените ключи перед отключением RBAC. Это относится к обычным сервисным ключам. Для учётных данных специального назначения, например ключей SCIM, действуют отдельные требования к доступу.

Использование ключа#

Передавайте API-ключ в заголовке X-API-Key при каждом запросе — формат одинаков для обоих типов ключей:

bash
curl -X POST https://api.lingo.dev/process/localize \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"engineId": "eng_abc123", "sourceLocale": "en", "targetLocale": "de", "data": {"greeting": "Hello"}}'

Один и тот же ключ подходит и для API локализации, и для MCP-сервера.

Безопасность#

  • Ключи хранятся в виде хешей — Lingo.dev не может восстановить ключ после создания. Для ротации удалите его и создайте заново.
  • Персональные ключи в реальном времени следуют разрешениям своего создателя. Если роль создателя понижается или доступ к движку отзывается, ключ потеряет тот же доступ при следующем запросе.
  • Личный ключ работает, только пока его создатель остаётся участником организации. Если автоматизация должна продолжать работать после ухода коллеги, используйте ключ организации.
  • Организационные ключи имеют собственные права. Изменение роли или области действия вступает в силу сразу; удаление ключа отзывает его.
  • Количество ключей на организацию не ограничено.

Что дальше#