Ваш API-ключ PushEngage аутентифицирует запросы API для сайта, поэтому все, что вызывает API PushEngage, использует его. Вы можете просматривать, копировать и перегенерировать ключ в настройках вашего сайта, и у каждого сайта есть свой ключ. Это руководство показывает, как найти ваш API-ключ и как безопасно его сменить.
Прежде чем начать
- Вы должны быть вошли в панель управления PushEngage с доступом к сайту, которым вы хотите управлять.
- Немедленная перегенерация ключа заменяет старый. Любая интеграция, которая все еще использует старый ключ, перестает работать, пока вы не обновите ее новым ключом, поэтому планируйте обновление ваших интеграций сразу после смены ключа.
- API-ключ специфичен для сайта. Если вы управляете несколькими сайтами, сначала переключитесь на нужный сайт.
Где найти ваш API-ключ
В панели управления PushEngage перейдите в раздел Настройки сайта » Сведения о сайте и прокрутите до раздела API-ключ.
Сгенерируйте ваш первый API-ключ
Если у сайта еще нет API-ключа, нажмите Сгенерировать новый API-ключ. PushEngage создаст ключ и подтвердит это сообщением «API-ключ успешно сгенерирован».
Скопируйте ваш API-ключ
Когда ключ существует, он отображается в замаскированном виде для безопасности. Нажмите Копировать, чтобы скопировать полный ключ в буфер обмена, а затем вставьте его туда, где он нужен. Ключ на экране всегда отображается только в замаскированном виде, поэтому используйте кнопку Копировать, а не пытайтесь его прочитать.
Смените (перегенерируйте) ваш API-ключ
Смена ключа заменяет его новым, что является правильным решением, если ключ мог быть скомпрометирован, или в качестве периодической гигиены.
- В разделе API-ключ нажмите Перегенерировать API-ключ.
- В окне подтверждения «Вы хотите перегенерировать API-ключ?» нажмите Да, перегенерировать.
- PushEngage выдаст новый ключ и подтвердит, что он был сгенерирован.
- Скопируйте новый ключ и обновите все интеграции, которые использовали старый.
Часто задаваемые вопросы
Сломает ли перегенерация ключа мои интеграции?
Да, пока вы их не обновите. Старый ключ перестает работать в момент перегенерации, поэтому любое приложение, плагин или скрипт, использующий его, перестанет работать, пока вы не замените его новым ключом. Меняйте ключ в то время, когда вы сможете сразу же обновить свои интеграции.
Является ли API-ключ одинаковым для всех моих сайтов?
Нет. У каждого сайта есть свой API-ключ. Если вы управляете несколькими сайтами, убедитесь, что вы находитесь на нужном сайте, прежде чем копировать или перегенерировать ключ.
Почему я вижу только замаскированный ключ?
Ключ отображается на экране в замаскированном виде для безопасности. Используйте кнопку Копировать, чтобы скопировать полный ключ в буфер обмена.
Когда следует менять мой API-ключ?
Поверните его, если считаете, что ключ был раскрыт, когда уходит кто-то, имеющий к нему доступ, или по расписанию в рамках надлежащей практики безопасности. Помните, что при каждом изменении ключа необходимо обновлять интеграции с новым ключом.
Если у вас возникнут какие-либо проблемы, пожалуйста, свяжитесь с нами, нажав здесь. Наша служба поддержки сможет вам помочь.