Cato एपीआई से ग्राफक्यूएल प्लेग्राउंड से कनेक्ट करना

यह लेख समझाता है कि GraphQL Playground का उपयोग कैसे करें कुछ नमूना क्वेरी चलाने और Cato Networks API एंडपॉइंट से कनेक्टिविटी का परीक्षण करने के लिए।

GraphQL Playground का अवलोकन

GraphQL Playground आपको API क्वेरी चलाने देता है जो सीधे Cato API सर्वर को भेजा जाता है। तीसरे पक्ष के API क्वेरी सॉफ़्टवेयर जैसे Altair या Postman, API कॉल्स चलाने के लिए शक्तिशाली कार्यक्षमता प्रदान करते हैं। हालांकि, यदि API क्वेरी के साथ कोई कनेक्टिविटी समस्या है, तो आप समस्या के कारण की पहचान करने के लिए Playground का उपयोग कर सकते हैं।

पूर्वशर्तें

GraphQL Playground से Cato API क्वेरी चलाने के लिए, आपके खाते के लिए API कुंजी होनी अनिवार्य है (Resources > API Keys)। API कुंजी के बारे में अधिक के लिए, देखें Generating API Keys for the Cato API।

आपको नमूना क्वेरी में अपने खाते के लिए Cato Management Application (CMA) आईडी दर्ज करनी होगी। आप अधिसूचना जानकारी पृष्ठ में CMA आईडी का पता लगा सकते हैं Account Info page.

एपीआई एंडपॉइंट का यूआरएल स्थान के लिए विशिष्ट होता है जहाँ Cato Management Application (CMA) इंस्टांस होस्ट किया गया है। आपके CMA खाते के लिए और एपीआई एंडपॉइंट पर यूआरएल में जोड़ा गया एक <prefix> मान हो सकता है।

• यदि कोई प्रिफिक्स नहीं है (cc.catonetworks.com), तो निम्नलिखित URL का उपयोग करें: https://api.catonetworks.com/api/v1/graphql2

• यदि कोई प्रिफिक्स है (जैसे cc.us1.catonetworks.com), तो आप निम्नलिखित URL का उपयोग करेंगे: https://api.us1.catonetworks.com/api/v1/graphql2

नमूना Cato API क्वेरी के साथ कनेक्टिविटी का परीक्षण करें

आप Cato API सर्वर के लिए कनेक्टिविटी का परीक्षण करने के लिए एक नमूना API क्वेरी चला सकते हैं। जब accountID तर्क और API कुंजी सही तरीके से कॉन्फ़िगर की जाती हैं, तो नमूना API क्वेरी खाता डेटा लौटता है और परिणाम GraphQL Playground में दिखाता है। यदि क्वेरी आपके खाते के लिए परिणाम नहीं लौटाता है, तो API सर्वर के लिए कनेक्टिविटी समस्या हो सकती है या सर्वर डाउन हो सकता है। निम्नलिखित नमूना API क्वेरी आपको Cato API सर्वर के साथ कनेक्टिविटी का परीक्षण करने में मदद कर सकती है:

• accountMetrics 

• accountSnapshot 

GraphQL Playground में एक नमूना API क्वेरी चलाना

Cato API के लिए GraphQL Playground खोलने के लिए इंटरनेट ब्राउज़र का उपयोग करें। आपके API कुंजी के साथ Playground के लिए HTTP हैडर कॉन्फ़िगर करें। बाएँ पैन में नमूना क्वेरी पेस्ट करें और अपना खाता आईडी दर्ज करें। फिर आप क्वेरी चला सकते हैं और परिणाम प्लेग्राउंड में देख सकते हैं।

1. इस लेख से किसी एक नमूना API क्वेरी को डाउनलोड करें और फाइल को Notepad जैसे टेक्स्ट एडिटर में खोलें।

2. इंटरनेट ब्राउज़र से, Cato API के लिए GraphQL Playground पर जाएँ।

3. बाएँ पैन के नीचे HTTP HEADERS पर क्लिक करें।

4. अपनी API कुंजी इस प्रारूप में दर्ज करें: { "x-api-key" :"<api key>" }।

   निम्नलिखित स्क्रीनशॉट एपीआई कुंजी के साथ कॉन्फ़िगर किए गए HTTP हेडर को दिखाता है AaBbCcDdEeFf0123456789ABCDEF1234:

   

5. नमूना क्वेरी में से किसी एक को कॉपी करें और प्लेग्राउंड के बाएं पैन में पेस्ट करें।

6. क्वेरी के शीर्ष में, accountID पैरामीटर में अपना खाता आईडी दर्ज करें।

   निम्नलिखित स्क्रीनशॉट accountID पैरामीटर को मान 2626 के साथ दिखाता है:

   

7. प्ले बटन पर क्लिक करें।

8. दाएं पैन में API क्वेरी के परिणाम दिखाए जाते हैं। निम्नलिखित स्क्रीनशॉट खाता ID 2626 के लिए नमूना accountMetrics क्वेरी के परिणाम दिखाता है: