Client Portal Guide
क्लाइंट पोर्टल: API इंटीग्रेशन गाइड #
BESTNET-CLOUD का क्लाइंट पोर्टल HTTP REST API प्रदान करता है। अकाउंट जानकारी और अनुबंधित सेवाओं की पुष्टि/संचालन को प्रोग्राम से स्वचालित किया जा सकता है। रिस्पॉन्स सभी JSON में लौटते हैं।
पूर्वापेक्षाएँ #
- क्लाइंट पोर्टल में लॉगिन कर सकते हों
- API उपयोग करने वाले अकाउंट को, लक्ष्य सेवा तक एक्सेस अधिकार हो
- संचार के लिए अवश्य HTTPS का उपयोग करें (प्रमाणीकरण-जानकारी को सादे-पाठ में न भेजें)
API की मूल बातें #
बेस URL
https://hb.bestnetllc.co.jp/api/ के अंतर्गत प्रत्येक मेथड उपलब्ध है।
डेटा प्रारूप
रिक्वेस्ट HTTP (GET / POST / PUT / DELETE), रिस्पॉन्स JSON है।
इंटरैक्टिव रेफ़रेंस
पोर्टल के बाएँ मेनू के “API” से, समस्त मेथड और bash / php / python के कोड-उदाहरण देखे जा सकते हैं।
प्रमाणीकरण #
API Basic प्रमाणीकरण का समर्थन करता है। क्लाइंट-एरिया के ईमेल पते और पासवर्ड को : (कोलन) से जोड़कर, Base64 एन्कोड किए मान को Authorization हेडर में भेजें।
# -u オプションでリクエストごとに認証情報を送信します
curl 'https://hb.bestnetllc.co.jp/api/details' \
-u "your-email@example.com:your-password"टोकन का उपयोग करने पर, POST /login से टोकन प्राप्त करें, POST /token से अपडेट करें, और POST /revoke से रद्द कर सकते हैं।
API रेफ़रेंस खोलना #
1. पोर्टल के बाएँ मेनू का “API” खोलें #
- क्लाइंट पोर्टल में लॉगिन करें।
- बाएँ मेनू के निचले हिस्से के “API” पर क्लिक करें।
- API Reference खुल जाता है। बाएँ मेनू में मेथड चुनें, और दाएँ पैन में आवश्यक पैरामीटर तथा bash / php / python के कोड-उदाहरण देख सकते हैं।
- स्क्रीन के ऊपरी हिस्से के download से Swagger हेतु JSON भी प्राप्त किया जा सकता है।
उपलब्ध प्रमुख मेथड-समूह #
API उपयोग-वार वर्गीकृत लगभग 135 मेथड से बना है।
Clientarea
लॉगिन/टोकन, उपयोक्ता-जानकारी की प्राप्ति/अपडेट, ऑपरेशन-लॉग, संपर्क (कॉन्टैक्ट) प्रबंधन, एफ़िलिएट जानकारी आदि।
Billing
इनवॉइस, भुगतान, क्रेडिट बैलेंस आदि, भुगतान से जुड़ी जानकारी की प्राप्ति।
Services
अनुबंधित सेवाओं की सूची/विवरण की प्राप्ति, सेवा से जुड़े संचालन।
Domains
डोमेन की सूची/विवरण की प्राप्ति, डोमेन-संबंधी संचालन।
SSL Certificates
SSL प्रमाणपत्र की पुष्टि/प्रबंधन।
Support
सपोर्ट टिकट की प्राप्ति/निर्माण/उत्तर।
Cart
नए ऑर्डर (कार्ट) का निर्माण/पुष्टि।
DNS
DNS ज़ोन/रिकॉर्ड की प्राप्ति/प्रबंधन।
रिक्वेस्ट उदाहरण #
प्रतिनिधि एंडपॉइंट के उदाहरण हैं। पूर्ण सूची और पैरामीटर के लिए, पोर्टल का API Reference देखें।
| उद्देश्य | मेथड | पथ |
|---|---|---|
| अकाउंट जानकारी की प्राप्ति | GET | /api/details |
| लॉगिन (टोकन प्राप्ति) | POST | /api/login |
| ऑपरेशन-लॉग की प्राप्ति | GET | /api/logs |
| संपर्क की सूची प्राप्ति | GET | /api/contact |
| संपर्क जोड़ना | POST | /api/contact |
# アカウント情報（details）を取得する例
curl 'https://hb.bestnetllc.co.jp/api/details' \
-u "your-email@example.com:your-password"ध्यान देने योग्य बातें #
HTTPS को अनिवार्य बनाएँ
प्रमाणीकरण-जानकारी की सुरक्षा के लिए, API कॉल अवश्य HTTPS से करें।
अधिकार का दायरा
प्राप्ति/संचालन का दायरा, लॉगिन किए अकाउंट के अधिकार और अनुबंध-सामग्री पर निर्भर करता है।
प्रोडक्शन संचालन पर सावधानी
निर्माण/अपडेट/विलोपन वाले मेथड वास्तविक डेटा में प्रतिबिंबित होते हैं। स्वचालन-स्क्रिप्ट को भली-भाँति सत्यापित करने के बाद उपयोग करें।
समस्या-निवारण #
401 Unauthorized लौटता है
ईमेल पता/पासवर्ड, या Base64 एन्कोड परिणाम सही है या नहीं, इसकी पुष्टि करें। Basic प्रमाणीकरण हेडर का प्रारूप Authorization: Basic <base64> है।
JSON नहीं लौटता / HTML लौटता है
एंडपॉइंट के पथ और HTTPS की पुष्टि करें। लॉगिन आवश्यक मेथड में प्रमाणीकरण-जानकारी अनिवार्य है।
मेथड नहीं मिलता
पथ और पैरामीटर अपडेट हो सकते हैं। पोर्टल के API Reference में नवीनतम परिभाषा की पुष्टि करें।
