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 убудова.

З разгортваннем вэб-хукаў

Адпраўце іх як загалоўкі ў запыце webhook:

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 або «несанкцыянаваны» ад вэб-хука.
Ключы няправільныя, пратэрмінаваны або былі заменены на больш новую пару. Калі сакрэт быў скапіраваны, праверце наяўнасць прабелаў або абрэзанага значэння, затым пацвердзіце дату заканчэння тэрміну прыдатнасці ў сваім акаўнце.
Я страціў сакрэтны ключ.
Гэта немагчыма аднавіць. Стварыце новую пару і абнавіце кожную інтэграцыю.
Ключ Reveal нічога не робіць або паведамляе, што ён ужо быў адкрыты.
Сакрэт для гэтай пары ўжо быў паказаны адзін раз і не можа быць паказаны зноў. Стварыце новую пару.
Ці магу я мець некалькі пар ключоў для розных інтэграцый?
Уліковы запіс выкарыстоўвае па адной актыўнай пары. Каб падзяліць доступ паміж кліентамі або асяроддзямі, выкарыстоўвайце асобныя працоўныя прасторы — гл. [Каманды і ролі] (/documentation/teams-and-roles).
Ці спыняе стварэнне новых ключоў мой warmers?
№ Warmers запланавана ўнутры Cache Rocket працягвайце працаваць у звычайным рэжыме. Закрануты толькі знешнія інтэграцыі, якія праходзяць аўтэнтыфікацыю са старымі ключамі.