Skip to main content
API-ключ YCloud — это учетные данные уровня аккаунта, используемые для аутентификации запросов к API YCloud. Передавайте его в заголовке запроса X-API-Key из доверенных серверных систем. API-ключ аккаунта может вызывать все API, доступные вашему аккаунту YCloud. Он не ограничен отдельным пользователем, командой или номером телефона WhatsApp Business, поэтому относитесь к нему как к строго конфиденциальным данным.
Никогда не раскрывайте API-ключ в коде браузерных или мобильных приложений, системах контроля версий, логах, скриншотах, тикетах или сообщениях в чатах. Храните его в менеджере секретов и предоставляйте доступ только тем системам и сотрудникам, которым он необходим.

​
Кто может просматривать API-ключ

Только участники аккаунта, чья назначенная роль дает доступ к разделу Developers > API key , могут открыть страницу и отобразить ключ. Проверить роли и права доступа в аккаунте можно в разделе Users and Teams. Для отображения API-ключа требуется двухфакторная аутентификация (2FA). Каждый авторизованный пользователь должен настроить 2FA для своей учетной записи YCloud, прежде чем сможет просмотреть ключ. Чтобы настроить или обновить 2FA, откройте Security settings.

​
Просмотр API-ключа

  1. Войдите в панель управления YCloud.
  2. Перейдите в Developers > API key.
  3. Найдите ключ, который вы хотите использовать.
  4. Нажмите на значок глаза в столбце API key .
  5. Пройдите проверку 2FA при появлении запроса.
  6. Скопируйте ключ и сохраните его в своем менеджере секретов.
По умолчанию ключ скрыт маской. YCloud запрашивает 2FA каждый раз, когда авторизованному пользователю требуется его отобразить.
Страница API-ключей с ключом по умолчанию, скрытым маской, и указанным значком глаза.

The key remains masked. Use the eye icon only when you are ready to complete verification and store the key securely.

​
Ротация скомпрометированного API-ключа

YCloud поддерживает один API-ключ на уровне аккаунта для стандартных интеграций. Если вы считаете, что ключ был скомпрометирован, создайте ключ для замены и аккуратно выполните ротацию в ваших системах.
Создание нового ключа не удаляет и не отключает автоматически предыдущий ключ. Старый ключ остается действительным до тех пор, пока вы не удалите его вручную.
  1. Перейдите в Developers > API key.
  2. Нажмите Add API Key , чтобы сгенерировать ключ для замены.
  3. Надежно сохраните новый ключ.
  4. Замените старый ключ во всех сервисах, средах и хранилищах секретов, используемых вашей организацией.
  5. Протестируйте затронутые интеграции с новым ключом.
  6. Убедившись, что все системы используют новый ключ, удалите старый ключ вручную.
Не удаляйте старый ключ до того, как ваши системы перейдут на новый, иначе запросы к API, которые все еще используют его, будут завершаться с ошибкой.

​
Использование нескольких ключей с кастомными приложениями

Если вашей организации требуются отдельные ключи для нескольких интеграций, используйте кастомные приложения. Каждое кастомное приложение имеет собственный API-ключ и позволяет управлять его разрешениями API, ресурсами WhatsApp и конфигурацией Webhook. Это рекомендуемый подход, когда интеграциям требуются отдельные учетные данные или различные области доступа.