Postman के साथ Cato साइट निर्माण API का उपयोग करना

यह लेख बताता है कि Cato प्रबंधन एप्लिकेशन में साइट्स को प्रावधान करने के लिए Postman API क्लाइंट का उपयोग कैसे करें और Cato की APIs को निष्पादित कैसे करें।

Postman को कॉन्फ़िगर करने का अवलोकन

यह Cato की कॉन्फ़िगरेशन API को चलाने और साइट्स को प्रावधान और अपडेट करने के लिए Postman को कॉन्फ़िगर करने का उच्च-स्तरीय अवलोकन है।

Cato प्रबंधन एप्लिकेशन से API कुंजी उत्पन्न करें।
Postman संग्रह और पर्यावरण को डाउनलोड और आयात करें।
पर्यावरण को कॉन्फ़िगर करें।
API को चलाएं और खाते में साइट्स को प्रावधान करें।

Cato प्रबंधन एप्लिकेशन से API कुंजी उत्पन्न करना

API कुंजी एक कोड है जिसका उपयोग API क्लाइंट आपके Cato खाते के साथ प्रमाणीकरण के लिए करता है। आप Cato प्रबंधन एप्लिकेशन में API प्रबंधन स्क्रीन का उपयोग करके संपादन अनुमतियों के साथ API कुंजी उत्पन्न कर सकते हैं।

Cato निर्माण API के लिए API कुंजी उत्पन्न करने के लिए:

नेविगेशन मेनू में, Resources > API Keys पर क्लिक करें।
API Keys टैब पर, New पर क्लिक करें। Create API Key पैनल खुलता है।
Key Name दर्ज करें।
API Permission को Edit पर सेट करें।
हम अनुशंसा करते हैं कि आप एक तारीख सेट करें जब API कुंजी Expire at होगी।
Apply पर क्लिक करें। API कुंजी जोड़ी जाती है और नई API कुंजी युक्त एक पॉपअप विंडो प्रदर्शित होती है।
(कॉपी करें) पर क्लिक करें और Cato प्रबंधन एप्लिकेशन द्वारा उत्पन्न API Key की प्रतिलिपि बनाएँ और उसे सुरक्षित स्थान पर सहेजें।

एक बार जब आप इस विंडो को बंद कर देते हैं, तो आप API कुंजी के मान तक नहीं पहुंच सकते।
पॉप-अप विंडो को बंद करने के लिए OK पर क्लिक करें।

Postman में Cato API संग्रह और पर्यावरण जोड़ना

हमने Cato निर्माण API के साथ साइट्स को प्रावधान करने के लिए एक कस्टम Postman संग्रह और पर्यावरण बनाया है। ये कस्टम फाइलें Cato रिपॉजिटरी में उपलब्ध हैं।

_cato_env_template_.postman_environment.json
कॉन्फ़िगरेशन API के लिए रूपांतरण API फाइलें (जैसे Cato Site Mutation API v1.postman_collection.json)

Postman पर्यावरण में वेरिएबल्स (API URL, CMA अकाउंट आईडी, आदि...) होते हैं और Postman संग्रह में GraphQL रूपांतरण API कॉल्स के उदाहरण होते हैं। उन्हें आयात करने के लिए, “Import” पर क्लिक करें, फ़ाइल को विंडो में छोड़ें और आयात पर क्लिक करें:

Postman में Cato API के लिए संग्रह और पर्यावरण जोड़ने के लिए:

इस KB लेख से आपके डिवाइस पर कस्टम संग्रह और पर्यावरण डाउनलोड करें।
Postman से, File > Import चुनें। Import पॉप-अप विंडो खुलता है।
Upload Files पर क्लिक करें, और फिर चरण 1 में डाउनलोड की गई फ़ाइलों का चयन करें।
Import पर क्लिक करें।

कस्टम पर्यावरण अब Postman Environments में प्रदर्शित होता है:

कस्टम संग्रह अब Postman Collections में प्रदर्शित होता है:

Postman पर्यावरण को कॉन्फ़िगर करना

हम अनुशंसा करते हैं कि आप प्रत्येक Cato टेनेन्ट के लिए एक अलग Postman पर्यावरण का उपयोग करें जहां आप CMA अकाउंट आईडी और API कुंजी संग्रहीत करते हैं।

नया Postman पर्यावरण बनाने के लिए:

Environment टैब से, टेम्पलेट _cat_env_template_ पर राइट-क्लिक करें और Duplicate चुनें।
Environment की कॉपी पर राइट-क्लिक करें और Rename चुनें, फिर Environment का नाम आपके Cato टेनेन्ट के नाम पर रखें।
API Key और CMA Account ID कॉपी करें, और उन्हें पर्यावरण के संबंधित फ़ील्ड्स के Current Value में पेस्ट करें और Save पर क्लिक करें।

आप URL से सीधे CMA अकाउंट आईडी प्राप्त कर सकते हैं:

Cato API कॉल चलाना साइट्स को प्रावधान करने के लिए

Postman के लिए API कुंजी और CMA अकाउंट आईडी को परिभाषित करने के बाद

API कॉल को निष्पादित करने के लिए और साइट्स को प्रावधान करने के लिए:

Collections टैब पर।
ऊपरी-दाएँ कोने में, पिछले चरण में बनाए गए Environment का चयन करें।
Collections टैब से, Cato Mutation API v1 > addSocketSite > _query का विस्तार करें और query_stateCode का चयन करें।
API कॉल निष्पादित करने के लिए Send पर क्लिक करें। उम्मीदित परिणाम 200 OK और कुछ डेटा है।