/v1 operations को कवर करता है, जो resource के अनुसार समूहित हैं और जिनमें authentication पहले से कॉन्फ़िगर किया गया है।
Download
फ़ाइल उपलब्ध कराए जाने से पहले डाउनलोड लिंक आपसे अपने Living Security खाते से साइन इन करने के लिए कहेंगे।
Living Security API v1 collection
Postman Collection v2.1, जिसमें सभी
/v1 operations शामिल हैं और Basic auth पहले से कॉन्फ़िगर है। Collection baseUrl रिक्त है — अनुरोध भेजने से पहले कोई regional environment चुनें।Collection डाउनलोड करेंProduction (US) environment
baseUrl को https://api.us-east-1.livingsecurity.ai/v1 पर पहले से सेट किया गया है, और भरने के लिए apiKeySecret तथा contractVersion variables रिक्त हैं।US production environment डाउनलोड करेंProduction (EU) environment
baseUrl को https://api.eu-west-1.livingsecurity.ai/v1 पर पहले से सेट किया गया है, और भरने के लिए apiKeySecret तथा contractVersion variables रिक्त हैं।EU production environment डाउनलोड करेंEnvironment template
वही variables, जिनमें
baseUrl रिक्त है, non-production सेटअप के लिए।Environment template डाउनलोड करेंPostman में सेट अप करें
1
फ़ाइलें इम्पोर्ट करें
Postman में Import चुनें और collection फ़ाइल के साथ वह Production (US) या Production (EU) environment डालें जो आपके संगठन से मेल खाता हो। Regions देखें।
2
API key बनाएँ
Dashboard में Settings → Integrations & Developers → Developer Hub खोलें, एक service account बनाएँ और एक API key बनाएँ। Key secret
lsk_live_ से शुरू होता है और केवल एक बार दिखाया जाता है — इसे तुरंत कॉपी कर लें। विवरण के लिए API keys देखें।3
Secret पेस्ट करें
apiKeySecret variable सेट करें — या तो इम्पोर्ट किए गए environment में (अनुशंसित; यह secret-type variable है) या collection के Variables टैब में।4
अनुरोध भेजें
इम्पोर्ट किया गया regional environment चुनें, कोई भी अनुरोध खोलें — उदाहरण के लिए Organization → Retrieve the organization — और Send दबाएँ। Environment चुने जाने तक अनुरोध न भेजें; collection
baseUrl जानबूझकर रिक्त रखा गया है।Authentication पहले से कैसे कॉन्फ़िगर किया गया है
Collection, collection स्तर पर Basic auth सेट करता है, जिसमें usernameapikey और password {{apiKeySecret}} है। API, key secret को किसी भी Basic auth फ़ील्ड में स्वीकार करता है, इसलिए variable सेट होते ही यह बिना किसी बदलाव के काम करता है।
यदि आप bearer authentication को प्राथमिकता देते हैं, तो collection के Authorization type को Bearer Token में बदलें और token के रूप में {{apiKeySecret}} का उपयोग करें — API दोनों तरीकों से उसी secret को स्वीकार करता है।
API key के साथ Bearer header का उपयोग करने के लिए OAuth आवश्यक नहीं है। OAuth का उपयोग करने के लिए, Bearer Token को API key secret के बजाय अपने OAuth access token पर सेट करें। कोई पद्धति चुनने के लिए Authentication और token तथा client सेटअप के लिए OAuth client credentials देखें।
Contract version header
प्रत्येक अनुरोध मेंLiving-Security-Version header होता है, जो {{contractVersion}} पर पहले से सेट है और डिफ़ॉल्ट रूप से अक्षम है। अपने संगठन के pinned contract version का उपयोग करने के लिए इसे अक्षम रहने दें। अनुरोध को किसी विशिष्ट प्रकाशित version से जोड़ने के लिए इसे सक्षम करें — प्रकाशित versions के लिए changelog देखें।
Query parameters और bodies
List-endpoint फ़िल्टर (limit, page_token और resource-विशिष्ट फ़िल्टर) प्रत्येक अनुरोध में शामिल हैं, लेकिन अक्षम हैं, ताकि नया इम्पोर्ट हर endpoint को सफलतापूर्वक कॉल कर सके। जिन्हें आपको चाहिए उन्हें सक्षम करें और भरें — page_token कैसे काम करता है, यह जानने के लिए Pagination देखें। POST operations के request bodies पहले से typed placeholder मानों से भरे होते हैं।
Collection को प्रत्येक contract परिवर्तन पर प्रकाशित OpenAPI spec से पुनः जनरेट किया जाता है — अनुरोधों को अद्यतन रखने के लिए उन्हें संपादित करने के बजाय नई प्रति डाउनलोड करें।