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

    Зберігайте секрет у безпечному місці

    Менеджер паролів або зашифроване сховище секретів вашого постачальника КІ. Не текстовий файл на робочому столі і не повідомлення чату.

Секрет показують рівно один раз

Якщо ви підете до того, як виявите його, або втратите його пізніше, відновити його неможливо. Єдиним виходом є створення нової пари, що робить стару недійсною та означає оновлення кожної інтеграції, яка її використовувала.

Генерація обмежена швидкістю

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

Термін дії

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

Використовуючи свої ключі

З плагіном 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"}'

Безпечне зберігання ключів

  • Ніколи не зберігайте секрет у репозиторії, навіть у приватному. Використовуйте змінні середовища або сховище секретів постачальника КІ.
  • Не вставляйте його в заявку служби підтримки, проблему чи чат. Нікому в Cache Rocket не потрібен ваш секретний ключ, щоб допомогти вам.
  • Не розміщуйте це в інтерфейсному коді. Все, що міститься в пакеті веб-переглядача, є загальнодоступним, незалежно від того, як воно обфусковано.
  • Негайно поверніть, якщо експозиція навіть можлива. Створення нової пари займає секунди; очищення після витоку облікових даних не робить.

Обертові ключі без простоїв

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

  1. 1

    Перерахуйте все, що використовує поточну пару

    Зазвичай це плагін WordPress, розгортання веб-хуків на кожній хостинговій платформі та будь-які завдання або сценарії CI.

  2. 2

    Згенеруйте нову пару і розкрийте секрет

    Перш ніж клацати, відкрийте менеджер паролів.

  3. 3

    Оновіть кожного споживача

    Опрацюйте список. Інтеграції, які все ще зберігають старі ключі, на даний момент вже не працюють, тому негайно рухайтеся.

  4. 4

    Переконайтеся, що кожен з них працює

    Знову збережіть налаштування плагіна WordPress, запустіть тестовий перехоплювач розгортання та перевірте, чи справді почався гарячий запуск.

Загальні проблеми

Я отримую 401 або «неавторизовано» від вебхука.
Ключі неправильні, термін дії минув або їх замінено на новішу пару. Перевірте наявність пробілів або скороченого значення під час копіювання секрету, а потім підтвердьте термін дії в обліковому записі.
Я загубив секретний ключ.
Його неможливо відновити. Створіть нову пару та оновіть кожну інтеграцію.
Ключ Reveal нічого не робить або повідомляє, що його вже було відкрито.
Секрет для цієї пари вже був показаний один раз і не може бути показаний знову. Створіть нову пару.
Чи можу я мати кілька пар ключів для різних інтеграцій?
Обліковий запис використовує одну активну пару одночасно. Щоб розділити доступ між клієнтами або середовищами, використовуйте окремі робочі області — див. Команди та ролі.
Чи зупиняє генерування нових ключів мій warmers?
№ Warmers, запланований всередині Cache Rocket, продовжує роботу в звичайному режимі. Це стосується лише зовнішніх інтеграцій, які автентифікуються за допомогою старих ключів.