API-ключи

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

6 мин чтения

Ключи API позволяют машинам действовать с вашей учетной записью Cache Rocket: плагин WordPress, веб-хук развертывания из вашего CI или ваши собственные сценарии, вызывающие общедоступный API.

Они находятся в разделе Аккаунт → Аккаунт, в разделе Ключи API.

Ключевая пара

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

Оба отправляются вместе при каждом аутентифицированном машинном запросе, обычно в виде заголовков X-Public-Key и X-Secret-Key.

Генерация ключей

  1. 1

    Откройте Аккаунт → Аккаунт

    Прокрутите до раздела Ключи API.

  2. 2

    Нажмите Создать новые ключи API.

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

  3. 3

    Сразу нажмите Показать ключ.

    Это ваш единственный шанс узнать секрет. Он извлекается один раз, а затем навсегда скрывается.

  4. 4

    Храните секрет в безопасном месте

    Менеджер паролей или зашифрованное хранилище секретов вашего провайдера CI. Не текстовый файл на рабочем столе и не сообщение в чате.

Секрет раскрывается ровно один раз

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

Генерация ограничена по скорости

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

Срок действия

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

Использование ваших ключей

С плагином WordPress

Вставьте оба ключа в экран настроек плагина после его активации. См. плагин WordPress.

С развертыванием веб-перехватчиков

Отправьте их как заголовки запроса вебхука:

bash
curl -X POST https://api.cacherocket.com/web/v1/public/webhooks/vercel \
  -H "Content-Type: application/json" \
  -H "X-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Secret-Key: YOUR_SECRET_KEY" \
  -d '{"hostname":"www.example.com"}'

Полная настройка каждой платформы находится в разделе [Развертывание триггеров] (/documentation/deploy-triggers).

Запуск теплого напрямую

Некоторые конечные точки принимают ключи в теле запроса вместо заголовков:

bash
curl -X POST https://cacherocket.com/api/wordpress/triggerWarm \
  -H 'Content-Type: application/json' \
  -d '{"publicKey":"YOUR_KEY","secretKey":"YOUR_SECRET","hostname":"example.com"}'

Храним ключи в безопасности

  • Никогда не сохраняйте секрет в хранилище, даже в частном. Используйте переменные среды или хранилище секретов вашего провайдера CI.
  • Не вставляйте его в заявку в службу поддержки, вопрос или чат. Никому в Cache Rocket не нужен ваш секретный ключ, чтобы помочь вам.
  • Не помещайте это в код внешнего интерфейса. Все в пакете браузера является общедоступным, независимо от того, насколько оно запутано.
  • Поворачивайте немедленно, если разоблачение вообще возможно. Создание новой пары занимает секунды; очистка после утечки учетных данных не помогает.

Вращающиеся клавиши без простоев

Создание новой пары сразу делает недействительной старую, поэтому окно перекрытия отсутствует. Планируем замену:

  1. 1

    Перечислите все, что использует текущую пару

    Обычно плагин WordPress развертывает веб-перехватчики на каждой хостинговой платформе, а также любые задания или сценарии CI.

  2. 2

    Сгенерируйте новую пару и раскройте секрет

    Прежде чем нажать, откройте менеджер паролей.

  3. 3

    Обновите каждого потребителя

    Работайте по списку. Интеграции, все еще хранящие старые ключи, на данном этапе уже дают сбой, поэтому действуйте как можно скорее.

  4. 4

    Подтвердите, что каждый из них работает

    Пересохраните настройки плагина WordPress, запустите хук тестового развертывания и убедитесь, что действительно начинается теплый запуск.

Распространенные проблемы

Я получаю 401 или «неавторизованный» от веб-перехватчика.
Ключи неправильные, срок их действия истек или они были заменены новой парой. Проверьте наличие пробелов или усеченного значения при копировании секрета, а затем подтвердите дату истечения срока действия в своей учетной записи.
Я потерял секретный ключ.
Его невозможно восстановить. Создайте новую пару и обновите каждую интеграцию.
Ключ раскрытия ничего не делает или говорит, что он уже раскрыт.
Секрет этой пары уже был показан один раз и не может быть показан снова. Создайте новую пару.
Могу ли я иметь несколько пар ключей для разных интеграций?
В аккаунте одновременно используется одна активная пара. Чтобы разделить доступ между клиентами или средами, используйте отдельные рабочие области — см. Команды и роли.
Остановит ли создание новых ключей мой warmers?
Нет. Warmers, запланированное внутри Cache Rocket, продолжает работать в обычном режиме. Затрагиваются только внешние интеграции, которые проходят аутентификацию со старыми ключами.