API कुंजियाँ

WordPress प्लगइन द्वारा उपयोग की जाने वाली सार्वजनिक और गुप्त कुंजी जोड़ी उत्पन्न करें, वेबहुक और सार्वजनिक API तैनात करें।

6 मिनट पढ़ें

API कुंजियाँ मशीनों को आपके Cache Rocket खाते पर कार्य करने देती हैं: WordPress प्लगइन, आपके CI से एक तैनात वेबहुक, या सार्वजनिक API को कॉल करने वाली आपकी अपनी स्क्रिप्ट।

वे API कुंजी अनुभाग में खाता → खाता के अंतर्गत रहते हैं।

मुख्य जोड़ी

सार्वजनिक कुंजी
आपके खाते की पहचान करता है. क्रिप्टोग्राफ़िक अर्थ में यह कोई रहस्य नहीं है, लेकिन इसे प्रकाशित करने का कोई कारण भी नहीं है। आपके खाते में हमेशा दिखाई देता है.
गुप्त कुंजी
साबित करता है कि अनुरोध वास्तव में आपकी ओर से है। इसे बिल्कुल पासवर्ड की तरह समझें. केवल एक बार दिखाया गया, आपके जेनरेट करने के ठीक बाद।

प्रत्येक प्रमाणित मशीन अनुरोध पर दोनों को एक साथ भेजा जाता है, आमतौर पर X-Public-Key और X-Secret-Key हेडर के रूप में।

कुंजियाँ उत्पन्न करना

  1. 1

    खाता → खाता खोलें

    API कुंजी अनुभाग तक स्क्रॉल करें।

  2. 2

    नई एपीआई कुंजी जेनरेट करें पर क्लिक करें

    तुरंत एक नया जोड़ा बन जाता है. पहले जारी किया गया कोई भी जोड़ा काम करना बंद कर देता है, इसलिए इसे उस समय करें जब आप उस पर निर्भर कुछ भी अपडेट कर सकें।

  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 के अंदर निर्धारित वार्मर सामान्य रूप से चलते रहते हैं। केवल बाहरी एकीकरण जो पुरानी कुंजियों से प्रमाणित होते हैं, प्रभावित होते हैं।