API కీలు

WordPress ప్లగ్ఇన్ ఉపయోగించే పబ్లిక్ మరియు సీక్రెట్ కీ జతని రూపొందించండి, వెబ్‌హుక్స్‌లను అమలు చేయండి మరియు పబ్లిక్ API.

6 min read

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"}'

ప్లాట్‌ఫారమ్ వారీగా పూర్తి సెటప్ డిప్లాయ్ ట్రిగ్గర్స్లో ఉంది.

నేరుగా ఒక వెచ్చని ట్రిగ్గర్

కొన్ని ముగింపు పాయింట్‌లు హెడర్‌లకు బదులుగా అభ్యర్థన బాడీలోని కీలను అంగీకరిస్తాయి:

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 లేదా “అనధికార” పొందాను.
కీలు తప్పుగా ఉన్నాయి, గడువు ముగిసింది లేదా కొత్త జతతో భర్తీ చేయబడ్డాయి. రహస్యం కాపీ చేయబడినప్పుడు వైట్‌స్పేస్ లేదా కత్తిరించబడిన విలువ కోసం తనిఖీ చేయండి, ఆపై మీ ఖాతాలో గడువు తేదీని నిర్ధారించండి.
నేను రహస్య కీని పోగొట్టుకున్నాను.
దానిని తిరిగి పొందలేము. కొత్త జతని రూపొందించండి మరియు ప్రతి ఇంటిగ్రేషన్‌ను నవీకరించండి.
రివీల్ కీ ఏమీ చేయదు, లేదా ఇది ఇప్పటికే బహిర్గతమైందని చెప్పారు.
ఆ జంట రహస్యం ఇప్పటికే ఒకసారి చూపబడింది మరియు మళ్లీ చూపబడదు. కొత్త జతని రూపొందించండి.
నేను విభిన్న ఏకీకరణల కోసం అనేక కీ జతలను కలిగి ఉండవచ్చా?
ఒక ఖాతా ఒకేసారి ఒక యాక్టివ్ జతని ఉపయోగిస్తుంది. క్లయింట్‌లు లేదా పరిసరాల మధ్య యాక్సెస్‌ను వేరు చేయడానికి, ప్రత్యేక కార్యస్థలాలను ఉపయోగించండి — జట్లు మరియు పాత్రలు చూడండి.
కొత్త కీలను రూపొందించడం వల్ల నా వార్మర్‌లు ఆగిపోతాయా?
సంఖ్య. Cache Rocket లోపల షెడ్యూల్ చేయబడిన వార్మర్‌లు సాధారణంగా రన్ అవుతూ ఉంటాయి. పాత కీలతో ప్రమాణీకరించే బాహ్య అనుసంధానాలు మాత్రమే ప్రభావితమవుతాయి.