API को लोकली टेस्ट करना
डिप्लॉय करने से पहले डेवलपमेंट मशीन पर डिवाइस callback कैसे प्राप्त करें और Postman से REST कमांड कैसे टेस्ट करें।
लोकल टेस्टिंग (सर्वर पर डिप्लॉय किए बिना)
प्रोडक्शन सर्वर पर डिप्लॉय किए बिना अपनी लोकल डेवलपमेंट मशीन से callback इंटीग्रेशन टेस्ट करने के लिए, आपको अपनी लोकल मशीन को इंटरनेट से पहुँच-योग्य बनाना होगा ताकि Cams Protocol Engine उस पर callback डेटा POST कर सके।
विकल्प A: सार्वजनिक IP + पोर्ट फ़ॉरवर्डिंग
यदि आपके इंटरनेट कनेक्शन में सार्वजनिक (स्टैटिक) IP पता है, तो आप किसी बाहरी पोर्ट को अपने लोकल एप्लिकेशन पर फ़ॉरवर्ड कर सकते हैं।
अपना सार्वजनिक IP पता खोजें
whatismyip.com पर जाएँ या अपने टर्मिनल में curl ifconfig.me चलाएँ। अपना सार्वजनिक IP पता नोट कर लें।
अपने राउटर पर पोर्ट फ़ॉरवर्डिंग सेट करें
अपने राउटर के एडमिन पैनल में लॉग इन करें। किसी बाहरी पोर्ट (जैसे 8080) को अपनी लोकल मशीन के आंतरिक IP और उस पोर्ट पर फ़ॉरवर्ड करें जिस पर आपका एप्लिकेशन चल रहा है (जैसे 3000, 5000, 8080)।
Callback URL कॉन्फ़िगर करें
API Monitor में अपना Callback URL इस प्रकार सेट करें:http://YOUR_PUBLIC_IP:8080/callback
टेस्ट करें
बायोमेट्रिक डिवाइस पर पंच करें। Cams Protocol Engine callback डेटा आपके सार्वजनिक IP पर POST करेगा, जिसे आपका राउटर आपके लोकल एप्लिकेशन तक फ़ॉरवर्ड करेगा।
विकल्प B: टनलिंग टूल (सार्वजनिक IP की आवश्यकता नहीं)
यदि आपके पास सार्वजनिक IP नहीं है या आप पोर्ट फ़ॉरवर्डिंग कॉन्फ़िगर नहीं कर सकते, तो अपने लोकल सर्वर को इंटरनेट पर उपलब्ध कराने के लिए टनलिंग सेवा का उपयोग करें।
| टूल | कमांड | टिप्पणियाँ |
|---|---|---|
| ngrok | ngrok http 3000 | फ़्री टियर उपलब्ध। तुरंत एक सार्वजनिक HTTPS URL देता है। |
| Cloudflare Tunnel | cloudflared tunnel --url localhost:3000 | फ़्री। क्विक टनल के लिए खाते की आवश्यकता नहीं। |
| localhost.run | ssh -R 80:localhost:3000 ssh.localhost.run | इंस्टॉलेशन की आवश्यकता नहीं। SSH के ज़रिए काम करता है। |
अपना लोकल एप्लिकेशन शुरू करें
अपना callback सर्वर लोकली चलाएँ (जैसे php -S localhost:8080 या node server.js या python app.py)।
टनल शुरू करें
टनलिंग टूल चलाएँ। यह https://abc123.ngrok-free.app जैसा सार्वजनिक URL आउटपुट करेगा।
Callback URL कॉन्फ़िगर करें
API Monitor में Callback URL को टनल URL पर सेट करें:https://abc123.ngrok-free.app/callback
टेस्ट करें
पंच करें। Callback टनल के माध्यम से रियल-टाइम में आपकी लोकल मशीन तक पहुँचेंगे।
URL टेस्टिंग
लाइव जाने से पहले Postman से अपने एंडपॉइंट सत्यापित करें। हम सभी 27 RESTful ऑपरेशन पहले से कॉन्फ़िगर किए हुए एक तैयार कलेक्शन देते हैं।
Postman कलेक्शन
डाउनलोड करके Postman में इम्पोर्ट करें। अपने base_url, stgid और auth_token वेरिएबल सेट करें — फिर तुरंत टेस्टिंग शुरू करें।
कलेक्शन इम्पोर्ट करें
Postman खोलें → Import → डाउनलोड की गई .json फ़ाइल को ड्रैग और ड्रॉप करें। सभी 27 RESTful ऑपरेशन श्रेणी के अनुसार समूहबद्ध दिखाई देंगे।
अपने वेरिएबल सेट करें
कलेक्शन के Variables टैब में जाएँ और सेट करें:
base_url = आपका RESTful एंडपॉइंट URL (API Monitor से)
stgid = आपके डिवाइस की Service Tag ID
auth_token = आपके डिवाइस का AuthToken
रिक्वेस्ट भेजें
कोई भी ऑपरेशन चुनें, JSON बॉडी में अपने मान डालें और Send दबाएँ। जाँचें कि रिस्पॉन्स ऊपर दिए गए अपेक्षित फ़ॉर्मेट से मेल खाता है।
Postman उदाहरण
नीचे Postman में कॉन्फ़िगर किए गए एक सैंपल API रिक्वेस्ट का स्क्रीनशॉट है। मेथड को POST पर सेट करें, ?stgid= के साथ अपना RESTful एंडपॉइंट URL पेस्ट करें और raw JSON बॉडी का उपयोग करें।
{"status":"done"} लौटाता है।