Ключи и секреты

Перед использованием Ключи подключите проект к Atoms Cloud. Если он не подключен, попросите Agent подключить Atoms Cloud или перейдите по ссылке Atoms Cloud.

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

Перед началом

Перед добавлением ключа убедитесь, что:

• вы используете Atoms в настольной веб-версии;
• проект подключен к Atoms Cloud;
• вы являетесь владельцем рабочего пространства. Только владельцы рабочего пространства могут добавлять новые ключи.

Если Ключи или Новый ключ недоступны, убедитесь, что вы открыли нужный проект и что он подключен к Atoms Cloud. Если Новый ключ по-прежнему недоступен, убедитесь, что вы являетесь владельцем рабочего пространства. Если Atoms показывает сообщение о доступности тарифа или использования, следуйте подсказкам на экране о доступности или обновлении тарифа, а затем повторите попытку.

Добавление тестового ключа

1. Откройте проект на настольном устройстве.
2. На той же панели инструментов рабочего пространства, где находится Просмотр приложений, выберите Atoms Cloud.
3. Выберите Ключи на боковой панели Atoms Cloud.
4. Откройте Тестовые ключи, затем выберите В этом проекте.
5. Выберите Новый ключ.
6. Заполните обязательные поля:
   • Имя: Введите понятное ссылочное имя, например RESEND_API_KEY. Используйте буквы, цифры и символы подчеркивания, начиная с буквы или символа подчеркивания.
   • Значение: Введите учетные данные точно в том виде, в котором их предоставил поставщик.
   • Описание: Объясните, для чего нужен ключ, например Используется для отправки писем аккаунта. Не включайте значение учетных данных.
7. Если вы хотите повторно использовать ключ в других проектах, выберите Сохранить в библиотеку.
8. Выберите Добавить. Когда ключ будет сохранен, Atoms покажет Ключ успешно добавлен.

Добавление тестового ключа

Только владельцы рабочего пространства могут добавлять новые ключи. Если вам нужно добавить ключ, обратитесь к владельцу рабочего пространства.

Использование сохраненного ключа в Chat

Ссылайтесь на сохраненный ключ вместо того, чтобы вводить его значение в сообщении.

1. Откройте Chat проекта в настольной версии Atoms и введите #.
2. Выберите Ключи.
3. Найдите сохраненный ключ, затем выберите его имя.
4. Сообщите Agent, для чего нужен ключ и что вы хотите, чтобы делала интеграция.

Меню # добавляет ссылку на сохраненный ключ, не вставляя его значение в ваше сообщение.

Ссылка на сохраненный ключ в Chat

Проверка сохраненного ключа

1. В Просмотр приложений выполните простое действие, использующее ключ.
2. Убедитесь, что оно дает ожидаемый результат, например отправляет тестовое письмо или возвращает тестовые данные.
3. Просмотрите все видимые ошибки или журналы и убедитесь, что они не раскрывают значение ключа.

Если сервис предоставляет отдельные тестовые и рабочие ключи, используйте тестовый ключ при создании приложения. Используйте рабочий ключ только после публикации приложения. Если проверка не удалась, проверьте панель управления поставщика, чтобы убедиться, что ключ активен и имеет разрешение на выполнение запрошенного действия. Никогда не вставляйте значение ключа в Chat при устранении неполадок.

Как работают Ключи

Перед добавлением ключей полезно понять, что хранит Atoms и как защитить ваши учетные данные.

Что хранит Atoms

Atoms Cloud → Ключи хранит учетные данные, которые ваше приложение использует для подключения к внешним сервисам, например ключи API и токены доступа.

Каждый сохраненный ключ имеет имя, описание и приватное значение. Имя и описание помогают Agent понять, когда использовать ключ, а приватное значение остается скрытым от Chat.

Где получить ключ

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

Храните приватные учетные данные в секрете

Никогда не вставляйте приватные учетные данные в Chat, исходный код, код, выполняющийся в браузере, скриншоты, журналы или сообщения в поддержку. Сохраните их в Ключи, а затем ссылайтесь на сохраненную запись по имени.

Если приватное значение уже было раскрыто, считайте его скомпрометированным и отзовите или замените его через поставщика.

Приватные учетные данные и учетные данные, безопасные для браузера

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

Перед тем как решить, где использовать учетные данные, ознакомьтесь с документацией поставщика:

• Используйте значение в коде, доступном браузеру, только если поставщик явно указывает, что его безопасно раскрывать.
• Храните приватные учетные данные в серверной или backend-логике, где они не раскрываются посетителям приложения.

Выбор среды и места хранения ключа

При добавлении ключа нужно принять два отдельных решения:

• какая среда будет использовать ключ;
• останется ли ключ в этом проекте или будет доступен другим проектам.

Выбор среды

Вариант	Когда используется
Тестовые ключи	Используются при разработке и тестировании вашего приложения в Просмотр приложений. Если вы не добавите отдельное значение для Production, опубликованное приложение также будет использовать тестовое значение.
Ключи Production	Используются опубликованным приложением, когда ему требуются отдельные рабочие учетные данные. Значения Production добавляются в процессе публикации и управляются отдельно от тестовых значений.

Выбор места сохранения ключа

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

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

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

Использование отдельного значения Production

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

Используйте отдельное значение Production, если:

• поставщик предоставляет разные тестовые и рабочие учетные данные;
• вы не хотите, чтобы учетные данные, использовавшиеся во время разработки, применялись в опубликованном приложении.

Значения Production создаются в процессе публикации. Вы не можете создать такое значение, выбрав Новый ключ на вкладке Ключи Production. После того как значение Production будет настроено для опубликованного приложения, вы сможете увидеть его в разделе Atoms Cloud → Ключи → Ключи Production.

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

Обновление или замена учетных данных

Обновление сохраненного тестового значения

1. Откройте Atoms Cloud → Ключи → Тестовые ключи.
2. Откройте В этом проекте или Библиотека ключей в зависимости от того, где была сохранена запись.
3. Выберите Значение или Описание ключа, введите обновленную информацию, затем выберите Обновить.
4. Дождитесь сообщения Сохранение успешно, затем снова проверьте затронутый сценарий.

Плановая замена ключа

Следуйте этим шагам, если существующие учетные данные все еще защищены и вы хотите заменить их без прерывания работы приложения:

1. Создайте новые учетные данные через поставщика услуг.
2. Замените тестовое значение в Atoms, затем проверьте затронутую функцию в Просмотр приложений.
3. Если опубликованное приложение использует отдельное значение Production, замените его и опубликуйте обновление.
4. Проверьте ту же функцию на опубликованном сайте.
5. После подтверждения, что замена работает правильно, отзовите старые учетные данные через поставщика.

Если учетные данные могли быть раскрыты

Считайте учетные данные скомпрометированными и действуйте немедленно:

1. Отзовите или отключите их через поставщика услуг.
2. Создайте новые учетные данные.
3. Обновите соответствующие тестовые значения и значения Production в Atoms.
4. Снова проверьте затронутые функции как в Просмотр приложений, так и в опубликованном приложении.
5. По возможности удалите все раскрытые копии из исходного кода, Chat, скриншотов и журналов.

Удаление ключа или удаление его значения из Atoms не отзывает исходные учетные данные. Вы должны отозвать их через поставщика услуг.

Удаление учетных данных

Перед удалением сохраненного ключа убедитесь, что ваше приложение больше от него не зависит:

1. Удалите функцию, использующую ключ, или замените ее ссылки другим сохраненным ключом.
2. Отзовите исходные учетные данные через поставщика услуг, чтобы их больше нельзя было использовать.
3. Откройте Atoms Cloud → Ключи, найдите неактивную запись, выберите Удалить и подтвердите действие.

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

FAQ

Мой тестовый ключ работает в Просмотр приложений, но не работает после публикации. Почему?

Если ваш тестовый ключ работает в Просмотр приложений, но опубликованное приложение не работает из-за отсутствующего или пустого ключа:

1. Проверьте, было ли соответствующее тестовое значение или значение Production сохранено до или после последней публикации. Если оно было сохранено после, опубликуйте снова, чтобы изменения вступили в силу.
2. Убедитесь, что сохраненный ключ имеет правильное тестовое значение или значение Production. Опубликованное приложение использует тестовое значение, если не настроено отдельное значение Production.
3. Проверьте ошибки нижестоящего сервиса на наличие подсказок. Сообщение “Unauthorized” обычно указывает на пустой или неверный ключ для этой среды.

Если проблема сохраняется, обратитесь в поддержку и приложите:

• ссылку на проект или live URL;
• имя затронутого ключа и указание, связано ли это с тестовым значением или значением Production;
• полный текст ошибки от нижестоящего сервиса;
• очищенный от секретных данных скриншот страницы конфигурации;
• информацию о том, была ли конфигурация ключа сохранена до или после публикации.

Важно: указывайте только имена ключей. НЕ отправляйте секретные значения, пароли или токены.