अपनी API कुंजी प्राप्त करें और सुरक्षित रखें

आपकी API कुंजी Scrapeless के लिए अनुरोधों का प्रमाणीकरण करती है। इसे एक गुप्त मानकर रखें: जो कोई भी इसे प्राप्त कर लेता है, वह उस कुंजी के लिए उपलब्ध सेवाओं का उपयोग कर सकता है।

अपनी कुंजी प्राप्त करें

1. Scrapeless डैशबोर्ड में साइन इन करें।
2. API कुंजी सेटिंग्स खोलें और उस कुंजी को कॉपी करें जिसका आप अपने अनुप्रयोग के लिए उपयोग करेंगे। कुछ उत्पाद गाइड इस मान को API टोकन के रूप में संदर्भित करते हैं।
3. इसे अपने स्थानीय वातावरण या अपने तैनाती प्लेटफ़ॉर्म के गुप्त भंडार में संग्रहीत करें।

यदि आप कुंजी सेटिंग्स नहीं ढूंढ पा रहे हैं, तो अपने खाता व्यवस्थापक या Scrapeless समर्थन से संपर्क करें। समर्थन संदेश में अपना पासवर्ड या मौजूदा कुंजी न भेजें।

स्थानीय विकास के लिए इसे संग्रहीत करें

Bash या Zsh के लिए, कुंजी को एक छिपे हुए प्रॉम्प्ट पर पेस्ट करें:

printf 'Scrapeless API key: '
read -rs SCRAPELESS_API_KEY
printf '\n'
export SCRAPELESS_API_KEY

इससे आपके द्वारा टाइप किए गए कमांड में शाब्दिक रूप से कुंजी शामिल होने से बचा जा सकता है। यह चर वर्तमान शेल सत्र के लिए रहता है और उससे शुरू किए गए प्रक्रियाओं द्वारा विरासत में लिया जाता है।

बिना इसका मान प्रिंट किए जांचें कि यह सेट है या नहीं:

if [ -n "${SCRAPELESS_API_KEY:-}" ]; then
  printf 'SCRAPELESS_API_KEY is set\n'
else
  printf 'SCRAPELESS_API_KEY is not set\n'
fi

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

तैनात किए गए अनुप्रयोगों के लिए, अपने होस्टिंग प्लेटफॉर्म या CI/CD गुप्त भंडार में कुंजी कॉन्फ़िगर करें और रनटाइम पर इसे डालें। इस तक पहुंच को उन लोगों और प्रक्रियाओं तक सीमित रखें जिन्हें यह आवश्यकता है।

अपने उत्पाद के लिए प्रमाणीकरण विधि का उपयोग करें

Python और Go SDK विकास में हैं। उनके सेटअप और प्रमाणीकरण निर्देश Python SDK मार्गदर्शिका और Go SDK मार्गदर्शिका में उपलब्ध होंगे। तब तक, जिस REST एंडपॉइंट को आप कॉल करते हैं, उसके लिए दस्तावेज़ीकृत प्रमाणीकरण विधि का उपयोग करें।

उन एंडपॉइंट्स के लिए जो x-api-token का उपयोग करते हैं, Bearer जोड़े बिना कुंजी भेजें:

x-api-token: YOUR_API_KEY

ब्राउज़र कनेक्शन URL में एम्बेड की गई कुंजी अभी भी एक गुप्त है। लॉगिंग, कॉपी करने या URL साझा करने से पहले token मान को हटा दें। MCP क्लाइंट्स के लिए, जिस ट्रांसपोर्ट और क्लाइंट का आप उपयोग करते हैं, उसके लिए कॉन्फ़िगरेशन का पालन करें; वातावरण चर नाम SDK के समान आवश्यक नहीं हैं।

CLI प्रमाणीकरण — जल्द आ रहा है

CLI प्रलेखन में प्रमाणीकरण और कॉन्फ़िगरेशन शामिल होगा। जब CLI उपलब्ध हो, तो अपने टर्मिनल वर्कफ़्लो के लिए प्रमाणन क्रेडेंशियल कॉन्फ़िगर करने के लिए उस मार्गदर्शिका का उपयोग करें। साझा कमांड उदाहरणों, शेल इतिहास और लॉग्स में प्रमाणन क्रेडेंशियल न रखें।

कुंजी की पुष्टि करें

स्क्रैपिंग कार्य सबमिट किए बिना प्रमाणीकरण की जांच करने के लिए दस्तावेज़ीकृत उपयोगकर्ता जानकारी प्राप्त करें एंडपॉइंट का उपयोग करें:

curl --silent --show-error \
  --request GET 'https://api.scrapeless.com/api/v1/me' \
  --header "x-api-token: ${SCRAPELESS_API_KEY:?Set SCRAPELESS_API_KEY first}" \
  --output scrapeless-account.json \
  --write-out 'HTTP status: %{http_code}\n'

स्थानीय रूप से स्थिति और प्रतिक्रिया शरीर का निरीक्षण करें। प्रतिक्रिया में खाता और शेष जानकारी शामिल हो सकती है, इसलिए फ़ाइल को प्रकाशित न करें या अपनी रिपॉजिटरी में प्रतिबद्ध न करें।

सफल प्रमाणीकरण इस बात की पुष्टि करता है कि यह अनुरोध कुंजी का उपयोग कर सकता है। उत्पाद तक पहुँच, शेष राशि और अनुरोध की वैधता की जाँच तब भी करनी होगी जब आप किसी उत्पाद एंडपॉइंट को कॉल करते हैं। Web Unlocker अनुरोध करने के लिए त्वरित शुरुआत के साथ आगे बढ़ें।

कुंजी को जोखिम वाली सतहों से दूर रखें

• विश्वसनीय सर्वर-साइड कोड से प्रमाणित कॉल करें। फ्रंटएंड जावास्क्रिप्ट, मोबाइल एप्लिकेशन बंडल या सार्वजनिक कॉन्फ़िगरेशन में कुंजी एम्बेड न करें।
• एप्लिकेशन लॉग्स और निगरानी घटनाओं से प्रमाणीकरण हेडर, ब्राउज़र कनेक्शन URL और गुप्त वातावरण चर को हटा दें।
• वास्तविक क्रेडेंशियल का उपयोग करते समय विस्तृत HTTP ट्रेस या शेल ट्रेसिंग से बचें। पर्यावरण चर को डीबगिंग उपकरणों और प्रक्रिया निरीक्षण के माध्यम से भी उजागर किया जा सकता है।
• स्क्रीनशॉट, रिकॉर्डिंग, साझा नोटबुक, सहायता टिकट और एआई चैट प्रॉम्प्ट से कुंजियाँ हटा दें।
• जब आवश्यकता हो, तो अपनी टीम द्वारा अनुमोदित गुप्त-साझाकरण विधि का उपयोग करें।

सुरक्षित तरीके से कुंजी बदलें

योजनाबद्ध प्रतिस्थापन के लिए, अपने खाते के लिए उपलब्ध डैशबोर्ड नियंत्रण के माध्यम से या Scrapeless सहायता के माध्यम से प्रतिस्थापन कुंजी प्राप्त करें। अपने गुप्त भंडार और सभी आश्रित अनुप्रयोगों को अद्यतन करें, उन प्रक्रियाओं को पुनरारंभ करें जो आरंभ होने पर गुप्त सूचनाएँ लोड करते हैं, और प्रतिस्थापन के काम करने की पुष्टि करें। फिर पुरानी कुंजी को अमान्य कर दें और पुष्टि करें कि इसे अब स्वीकार नहीं किया जा रहा है।

यदि कुंजी लीक हो सकती है, तो चल रहे अनुप्रयोगों में बाधा डालने के बावजूद तुरंत उजागर क्रेडेंशियल को अमान्य करने पर प्राथमिकता दें। उपलब्ध डैशबोर्ड नियंत्रण का उपयोग करें या सहायता के लिए संपर्क करें, फिर अपने गुप्त भंडार के माध्यम से प्रतिस्थापन वितरित करें।

फ़ाइल से कुंजी को हटाना या सार्वजनिक पोस्ट को हटाना इसे अमान्य नहीं करता है। उजागर होने को नियंत्रित करने के बाद हाल के उपयोग की समीक्षा करें और लॉग और रिपॉजिटरी इतिहास सहित उजागर प्रतियों को साफ़ करें।

प्रमाणीकरण के लिए ट्रबलशूट करें

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

यदि कुंजी सत्यापन एंडपॉइंट पर काम करती है लेकिन उत्पाद अनुरोध विफल होता है, तो उत्पाद त्रुटि प्रतिक्रिया और डैशबोर्ड पहुँच का निरीक्षण करें। सहायता मांगते समय केवल संपादित नैदानिक परिणाम साझा करें।

अगला: अपना पहला अनुरोध करें या उत्पाद चुनें।