/responses पर चैट फ़्लो, और दूसरे एंडपॉइंट के लिए एक टेस्टर होगा।
सैंपल Phaseo के OAuth एंडपॉइंट खुद ढूँढता है, लौटते समय state और iss जाँचता है, टोकन सुरक्षित तरीके से रीफ़्रेश करता है, और व्यक्ति के साइन आउट करने पर कुंजी रद्द कर देता है।
किसी कोडिंग एजेंट से यही ऐप शुरू से बनवाने के लिए, यह प्रॉम्प्ट पेस्ट करें:
OAuth और यूनिफ़ाइड Phaseo प्रॉक्सी के साथ साइन-इन वाला Next.js वर्कबेंच बनाएँ।
सैंपल कैसे बना है
सैंपल examples/oauth-client-nextjs में है:
साइन-इन को गेटवे कॉल से अलग रखने का मतलब है कि साइन-इन की समस्या कभी मॉडल की समस्या जैसी नहीं दिखती, और हर एंडपॉइंट टोकन संभालने वाली एक ही जगह साझा करता है।
इसे चलाएँ
आपको Node.js, रीडायरेक्ट URI के रूप मेंhttp://localhost:3000/auth/callback (या आपका अपना कॉलबैक) वाला एक OAuth ऐप, और एक लंबा रैंडम सत्र सीक्रेट चाहिए। OAuth ऐप सेटिंग्स → OAuth ऐप्स में या OAuth clients API से बनाएँ।
1
इंस्टॉल करें
2
.env.local बनाएँ
सैंपल इन सभी को सिर्फ़ सर्वर पर पढ़ता है। क्लाइंट सीक्रेट या सत्र सीक्रेट को कभी किसी
NEXT_PUBLIC_ वेरिएबल में न रखें।सैंपल अधिकृत करने, टोकन, रद्द करने और userinfo के एंडपॉइंट https://api.phaseo.app/.well-known/oauth-authorization-server से ढूँढता है, और openid email profile gateway:access माँगता है। gateway:access से टोकन Gateway को कॉल कर सकता है।3
डेव सर्वर शुरू करें
http://localhost:3000 खोलें, साइन इन करें, और डैशबोर्ड खोलें।जाँचें कि यह काम कर गया
- साइन-इन आपके कॉलबैक URL पर लौटता है और एक सत्र बनाता है।
- डैशबोर्ड
/api/gateway/modelsके ज़रिए मॉडल सूचीबद्ध करता है। /api/gateway/responsesके ज़रिए चैट का एक टर्न जवाब पाता है, और किसी भी ब्राउज़र अनुरोध में एक्सेस टोकन नहीं जाता।- प्रॉक्सी अनुमति-सूची से बाहर का पाथ अस्वीकार हो जाता है।
टोकन की अवधि
टोकन एंडपॉइंट दो टोकन लौटाता है:- हर रीफ़्रेश पर बदलें। हर रीफ़्रेश एक नया एक्सेस टोकन और एक नया रीफ़्रेश टोकन लौटाता है। दोनों सहेजें और पुराने हटा दें: पुराना एक्सेस टोकन तुरंत काम करना बंद कर देता है, और पुराना रीफ़्रेश टोकन दोबारा इस्तेमाल नहीं हो सकता।
- समय खत्म होने के बाद रीफ़्रेश करें। एक्सेस टोकन की अवधि खत्म होने के बाद भी आप रीफ़्रेश कर सकते हैं, जब तक रीफ़्रेश टोकन की अवधि खत्म नहीं हुई है।
- रीफ़्रेश टोकन कभी दोबारा इस्तेमाल न करें। किसी को दूसरी बार इस्तेमाल करने से साइन-इन खत्म हो जाता है। Phaseo इसे लीक हुआ टोकन मानता है और उस साइन-इन का एक्सेस टोकन और हर रीफ़्रेश टोकन रद्द कर देता है, इसलिए व्यक्ति को फिर से साइन इन करना पड़ता है।
- स्कोप सिर्फ़ घटते हैं। रीफ़्रेश कभी स्कोप नहीं जोड़ता। यह वही स्कोप रखता है जो व्यक्ति ने मंज़ूर किए थे, उनमें से वे घटाकर जो उसने बाद में हटा दिए।
- जब रीफ़्रेश विफल हो। जब व्यक्ति आपके ऐप को रद्द करता है, उसकी कुंजी रद्द या बंद करता है, कुंजी को ज़रूरी कोई स्कोप (जैसे
gateway:access) हटाता है, या वर्कस्पेस छोड़ देता है, तो रीफ़्रेश विफल हो जाता है।gateway:accessहटाने से कुंजी भी रद्द हो जाती है, इसलिए उसका एक्सेस टोकन तुरंत काम करना बंद कर देता है। स्कोप फिर से देने से रीफ़्रेश टोकन वापस नहीं आता। व्यक्ति को फिर से साइन-इन से गुज़ारें। - फिर से साइन इन करने पर कुंजी नवीनीकृत होती है। यह नई कुंजी जोड़ने के बजाय उसी कुंजी को नवीनीकृत करता है, चाहे आप
resource=https://api.phaseo.app/v1भेजें या नहीं। आपको नया एक्सेस टोकन और रीफ़्रेश टोकन मिलता है, पिछले काम करना बंद कर देते हैं, और कुंजी इस महीने का खर्च बनाए रखती है। उसकी मासिक खर्च सीमा वही हो जाती है जो व्यक्ति ने अभी मंज़ूर की। पिछले साइन-इन का रीफ़्रेश टोकन बस अस्वीकार कर दिया जाता है, और उसे टोकन या revoke एंडपॉइंट पर भेजने से नया साइन-इन खत्म नहीं होता। - रोकी गई कुंजी साइन-इन रोकती है। अगर उस व्यक्ति और वर्कस्पेस के लिए आपके ऐप की कोई भी कुंजी रोकी गई है, चाहे उसका resource कुछ भी हो, तो टोकन एंडपॉइंट
invalid_grantलौटाता है, जब तक कोई सेटिंग्स → API कुंजियाँ में कुंजी फिर से चालू नहीं करता। नवीनीकरण सिर्फ़ तब काम करता है जब कुंजी रद्द न हुई हो: साइन-आउट या किसी और रद्दीकरण के बाद, साइन इन करने पर नई कुंजी जारी होती है, और उसकी सीमाएँ और खर्च शून्य से शुरू होते हैं। - revoke से साइन आउट करें। रीफ़्रेश टोकन
https://api.phaseo.app/oauth/revokeपर भेजें। इससे कुंजी और उस साइन-इन का हर रीफ़्रेश टोकन रद्द हो जाता है, उस टोकन समेत जो किसी रीफ़्रेश ने कुछ ही पल पहले जारी किया था।
खर्च सीमाएँ
सहमति स्क्रीन पर व्यक्ति आपके ऐप के लिए एक मासिक खर्च सीमा तय करता है: डिफ़ॉल्ट रूप से $20.00, कोई दूसरी राशि, या कोई सीमा नहीं। जब कुंजी किसी कैलेंडर महीने में उतना खर्च कर लेती है, तो गेटवे अनुरोध अगले महीने तक, या जब तक व्यक्ति सेटिंग्स → API कुंजियाँ में सीमा नहीं बढ़ाता,key_limit_exceeded के साथ 429 लौटाते हैं।
उसके पास कोई भी स्कोप हो, आपका ऐप API के ज़रिए उस सीमा को हटा या उससे बच नहीं सकता। वह सिर्फ़ API कुंजियों का नाम बदल या उन्हें मिटा सकता है। वह कुंजियाँ बना या रोटेट नहीं कर सकता, किसी कुंजी की सीमाएँ, स्टेटस या समाप्ति नहीं बदल सकता, मैनेजमेंट कुंजियाँ या भरोसेमंद वर्कलोड नहीं बना सकता, सदस्य नहीं जोड़ सकता, बजट, गार्डरेल, रेट लिमिट या खर्च नियम नहीं बदल सकता, और न ही रूटिंग के लिए वर्कस्पेस की मूल्य सीमाएँ या उसका BYOK से क्रेडिट पर फ़ॉलबैक बदल सकता है।
इसे शिप करने से पहले
- अनुमति-सूची छोटी करें।
lib/gateway.tsउन पाथ की अनुमति देती है जिन्हें वर्कबेंच कॉल करता है, साथ हीvideos/औरmusic/generate/के नीचे जॉब स्टेटस की भी। सिर्फ़ वे पाथ रखें जिन्हें आपका प्रोडक्ट कॉल करता है। - इंस्टेंस के बीच रीफ़्रेश साझा करें।
lib/oauth.tsसमानांतर अनुरोधों के बीच एक ही रीफ़्रेश को मेमोरी में साझा करती है। अगर आप एक से ज़्यादा सर्वर इंस्टेंस चलाते हैं, तो इसे साझा स्टोरेज में ले जाएँ, वरना दो इंस्टेंस एक ही टोकन से रीफ़्रेश करके साइन-इन खत्म कर सकते हैं। - पूरी बातचीत भेजें। Gateway प्रतिक्रियाएँ सहेजता नहीं है और
previous_response_idअस्वीकार करता है, इसलिए पिछले टर्नinputमें दोबारा भेजें। - टेस्टर बदलें। वर्कबेंच को आंतरिक QA के लिए रखें और एंड यूज़र के लिए खास मकसद वाले फ़्लो बनाएँ।