Храните приватные учетные данные вашего приложения в Atoms Cloud → Ключи, чтобы их значения не попадали в Chat и исходный код, а также чтобы управлять отдельными значениями для Test и Production.

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

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

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

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

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

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

Добавление Test-ключа

1. Откройте проект на настольном устройстве.
2. На той же панели инструментов рабочего пространства, где находится Просмотр приложений , выберите Atoms Cloud.
3. Выберите Ключи на боковой панели Atoms Cloud.
4. Откройте Test Ключи, затем выберите In This Project.
5. Выберите New Key.
6. Заполните обязательные поля:
   • Name: Введите понятное ссылочное имя, например RESEND_API_KEY. Используйте буквы, цифры и символы подчеркивания; имя должно начинаться с буквы или символа подчеркивания.
   • Value: Введите учетные данные точно в том виде, в котором их предоставил поставщик.
   • Description: Укажите, для чего нужен ключ, например Used to send account emails. Не включайте значение учетных данных.
7. Если вы хотите повторно использовать ключ в других проектах, выберите Save to Library.
8. Выберите Add. Когда ключ будет сохранен, Atoms покажет Key added successfully.

Добавление Test-ключа

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

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

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

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

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

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

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

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

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

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

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

Что хранит Atoms

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выбор окружения

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

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

Вариант	Когда использовать
In This Project	Выбирайте этот вариант для ключа, который должен использоваться только текущим проектом.
Key Library	Выбирайте этот вариант, если вы намеренно хотите повторно использовать ключ в нескольких проектах. При добавлении или обновлении Test-ключа выберите Save to Library, чтобы сделать его доступным в библиотеке.

Окружение и место хранения не зависят друг от друга. Сохранение Test-ключа в Key Library делает его доступным для повторного использования, но не превращает его в значение Production.

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

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

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

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

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

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

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

Обновление или ротация учетных данных

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

1. Откройте Atoms Cloud → Ключи → Test Ключи.
2. Откройте In This Project или Key Library в зависимости от того, где была сохранена запись.
3. Выберите Value или Description ключа, введите обновленную информацию, затем выберите Update.
4. Дождитесь сообщения Save success, затем снова протестируйте затронутый сценарий.

Плановая ротация ключа

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

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

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

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

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

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

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

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

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

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

FAQ

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

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

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

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

• Ссылку на проект или live URL
• Имя затронутого ключа и указание, связано ли это со значением Test или Production
• Полную ошибку от нижестоящего сервиса
• Очищенный от чувствительных данных скриншот страницы конфигурации
• Была ли конфигурация ключа сохранена до или после публикации

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