सामग्री पर जाएँ

सार्वजनिक API

API कुंजी बनाइए और उसके स्कोप चुनिए

कुंजी उसी वर्कस्पेस में बनाइए जहाँ वह काम करेगी, सिर्फ़ वही स्कोप दीजिए जो एकीकरण को चाहिए, और उसे रहस्य की तरह सहेजिए। कुंजी एक ही बार दिखती है — खो जाए तो उसे रद्द कीजिए और नई जारी कीजिए।

चरण

  1. कुंजी उसी वर्कस्पेस के भीतर बनाइए जिसके कोड वह छुएगी। कुंजियाँ वर्कस्पेस पार नहीं करतीं।
  2. वही सबसे सँकरे स्कोप दीजिए जिनसे एकीकरण चल जाए — अगर वह सिर्फ़ पढ़ता है तो सिर्फ़ पढ़ने का।
  3. कुंजी तुरंत अपने रहस्य भंडार में नक़ल कीजिए।
  4. Bearer टोकन से या X-Mosaqo-API-Key हेडर से प्रमाणित कीजिए, जो आपके क्लाइंट को सुहाए।
  5. जहाँ हो सके पते के आधार पर सीमित कीजिए, और तय समय पर बदलते रहिए।

परिणाम कैसे जाँचें

/me जैसा पहचान एंडपॉइंट पुकारिए। उसे वही वर्कस्पेस लौटाना चाहिए जिसकी आप अपेक्षा करते हैं, और इससे यह भी पक्का हो जाता है कि कुंजी कहाँ लागू है।

आम तौर पर क्या गड़बड़ होती है

  • रिपॉज़िटरी में कमिट हो गई या चैट में चिपका दी गई कुंजी।
  • सभी एकीकरणों में साझा एक ही सर्वशक्तिमान कुंजी।
  • ग़लत वर्कस्पेस में बनी कुंजी, जो फिर हर चीज़ पर 403 लौटाती है।
क्या इससे आपका काम बन गया?

इससे मदद नहीं मिली

हमें प्लेटफ़ॉर्म और संस्करण, उठाए गए कदम, अपेक्षित परिणाम और संबंधित वर्कस्पेस या QR कोड के साथ लिखिए। कुछ भी संलग्न करने से पहले हर गोपनीय जानकारी छिपा दीजिए।

सहायता को लिखें