ऑथेंटिकेशन और API कुंजियाँ (Keys)

पब्लिक API spk_ से शुरू होने वाली Bearer API कुंजियों का उपयोग करता है।

Authorization: Bearer spk_...

ब्रांड स्कोपिंग (Brand Scoping)

प्रत्येक API कुंजी एक ही ब्रांड तक सीमित (scoped) होती है। /v1/brand/* एंडपॉइंट्स द्वारा लक्षित ब्रांड स्वयं कुंजी द्वारा निर्धारित किया जाता है, और आप अनुरोध बॉडी (body) में एक अलग ब्रांड निर्दिष्ट नहीं कर सकते हैं।

केवल ब्रांड के मालिक ही API कुंजियाँ उत्पन्न और जारी कर सकते हैं।

स्कोप और अनुमतियाँ (Scopes & Permissions)

एंडपॉइंट के आधार पर, निम्नलिखित स्कोप की जांच की जाती है:

brands:read, brands:write
connections:read
publishing:read, publishing:write
comments:read, comments:write, comments:moderate
analytics:read
webhooks:read, webhooks:write

यदि किसी API कुंजी में आवश्यक स्कोप की कमी है, तो सर्वर 403 insufficient_scope लौटाता है।

बिना ऑथेंटिकेशन वाले एंडपॉइंट्स (Unauthenticated Endpoints)

/
/v1/health
/v1/docs
/v1/openapi.json

प्लान कोटा (Plan Quotas)

Free ब्रांडों को प्रति कैलेंडर माह (UTC) में 1 सक्रिय API कुंजी और 1,000 गणना किए गए API अनुरोधों की अनुमति है। Growth ब्रांड कई सक्रिय कुंजियों का समर्थन करते हैं और फेयर-यूज़ नीति (fair-use policy) के तहत काम करते हैं।

वैध ऑथेंटिकेशन के बाद किए गए सफल और असफल दोनों अनुरोध Free कोटा में गिने जाते हैं। हेल्थ चेक, API दस्तावेज़, OpenAPI स्कीमा अनुरोध और अमान्य कुंजी अनुरोधों को गणना से बाहर रखा गया है।

सुरक्षा अनुशंसाएं (Security Recommendations)

कुंजियों को एनवायरनमेंट वेरिएबल्स (environment variables) या सीक्रेट मैनेजमेंट सर्विस में स्टोर करें।
क्लाइंट-साइड ब्राउज़र कोड में कभी भी कुंजियाँ शामिल न करें।
लॉगिंग आउटपुट में कुंजियों को मास्क (mask) करें।
अप्रयुक्त कुंजियों को निष्क्रिय करें और उन्हें नई कुंजियों के साथ रोटेट करें।
एक्सेस लॉग को अलग करने के लिए प्रति स्वचालित स्क्रिप्ट अलग कुंजियाँ रखें।