डेवलपर दस्तावेज़
प्रमाणीकरण, अनुमतियाँ और सुरक्षित क्रेडेंशियल
एजेंट के लिए OAuth से साइन इन करें, सर्वर पर निजी एक्सेस टोकन इस्तेमाल करें और हर कॉलर के लिए ज़रूरी अनुमतियाँ चुनें।
Markdown में पढ़ेंSosoAPI टीम द्वारा समीक्षा ·
कॉलर के लिए क्रेडेंशियल चुनें
एजेंट के लिए ब्राउज़र OAuth इस्तेमाल करें: यूज़र साइन इन करके एक्सेस चुनता है और CLI क्रेडेंशियल सहेजता व रिफ़्रेश करता है। बैकएंड स्क्रिप्ट या CI जॉब के लिए VICKY_API_KEY से निजी एक्सेस टोकन दें। क्रेडेंशियल ब्राउज़र कोड, सार्वजनिक रिपॉज़िटरी, प्रॉम्प्ट, स्क्रीनशॉट और साझा लॉग से बाहर रखें।
HTTP उदाहरण Bearer मान के लिए सर्वर-साइड एनवायरनमेंट वेरिएबल SOSOAPI_ACCESS_TOKEN इस्तेमाल करते हैं। यह उदाहरण वेरिएबल है, CLI सेटिंग नहीं। हर ऑपरेशन के क्रेडेंशियल देखें; निजी एक्सेस टोकन API keys प्रबंधित नहीं कर सकते।
npx sosoapi auth loginnpx sosoapi auth statusnpx sosoapi auth logoutदायरा और क्षमताएँ
हर अनुरोध वर्कस्पेस सदस्यता और ऑपरेशन की आवश्यक भूमिका जाँचता है। प्रत्यायोजित OAuth एक्सेस को यूज़र के चुने वर्कस्पेस और क्षमताओं तक भी सीमित करता है। agent:operate पढ़ने और तैयारी, agent:publish निर्धारण और प्रकाशन, तथा agent:engage कम्युनिटी राइट के लिए है। API keys प्रबंधित करने का अधिकार अलग चाहिए।
निजी एक्सेस टोकन अपने मालिक की भूमिका और संग्रहीत क्षमता या वर्कस्पेस प्रतिबंधों से सीमित है। इंटीग्रेशन का ज़रूरी एक्सेस ही चुनें; वैकल्पिक सीमाएँ छोड़ने से key को व्यापक एक्सेस मिल सकता है। Core और full प्रोफ़ाइल दिखाई देने वाले टूल बदलते हैं, अनुमतियाँ नहीं। प्रकाशन एक्सेस अपने अधिकृत दायरे में चलता रहता है, हर पोस्ट के लिए नई ब्राउज़र अनुमति के बिना।
क्रेडेंशियल स्टोरेज और निरस्तीकरण
CLI क्रेडेंशियल उपलब्ध होने पर ऑपरेटिंग सिस्टम की keychain में, अन्यथा केवल मालिक द्वारा पढ़ी जा सकने वाली लोकल फ़ाइल में रखता है। OAuth एक्सेस टोकन एक घंटे चलते हैं और साइन-इन प्रक्रिया उन्हें रिफ़्रेश करती है। क्रेडेंशियल फ़ाइल कॉपी करने के बजाय कनेक्शन जाँचने के लिए auth status इस्तेमाल करें।
Settings → Agents & API Access में डिवाइस या प्राधिकरण निरस्त करें, या वर्तमान लोकल डिवाइस से साइन आउट करने के लिए auth logout चलाएँ। इससे भविष्य का एक्सेस रुकता है। प्रकाशित पोस्ट वापस या SosoAPI के स्वीकृत निर्धारण रद्द नहीं होते; उन्हें अलग जाँचें और प्रबंधित करें।
प्रमाणीकरण की शुरुआती प्रक्रिया के एंडपॉइंट
चार agent-auth एंडपॉइंट साइन-इन प्रोटोकॉल के दस्तावेज़ हैं। समर्थित CLI या रिमोट OAuth क्लाइंट से साइन इन करें; ये api post से उपलब्ध नहीं हैं। Config, request, session और revoke-current अलग क्रेडेंशियल व फ़ील्ड लेते हैं। हर एंडपॉइंट का स्कीमा मानें और सेशन क्रेडेंशियल आउटपुट व लॉग से बाहर रखें।