स्टैट्स, समीक्षाओं, रेटिंग्स और फोन के लिए एक REST JSON API

Astrina के पीछे का डेटा — साइट एनालिटिक्स, समीक्षाएँ, रेटिंग सारांश, और फोन इंटेलिजेंस — अब आपके अपने कोड में सीधे खींचने के लिए उपलब्ध है। डेवलपर API एक REST JSON API है जो इसे एकल कुंजी से वापस देता है।

एक कुंजी, चार एंडपॉइंट

API का संस्करण है /api/v1 और हर एंडपॉइंट साधारण JSON में बात करता है। अपने क्लाइंट को उस संसाधन की ओर इंगित करें जिसकी आपको आवश्यकता है:

• GET /api/v1/stats — एक साइट के लिए एनालिटिक्स जो आपके पास है: आगंतुक, पृष्ठ दृश्य, शीर्ष पृष्ठ, स्रोत, और देश।
• GET /api/v1/reviews — एक विषय के लिए समीक्षाएँ और रेटिंग।
• GET /api/v1/rating — स्टार वितरण के साथ एक रेटिंग सारांश।
• GET /api/v1/phone — फोन इंटेलिजेंस।

इनके अलावा, ऑथ API शक्ति प्रदान करता है "Astrina के साथ लॉगिन", ताकि आप अपनी ऐप में सामाजिक साइन-इन जोड़ सकें बिना खुद से पहचान स्टैक बनाए।

जिस तरह से आपकी स्टैक के लिए उपयुक्त हो, प्रमाणीकरण करें

से एक कुंजी प्राप्त करें /my/api.php, फिर इसे अपने क्लाइंट के लिए सबसे साफ तरीके से भेजें। API तीन रूपों को स्वीकार करता है:

• एक X-Api-Key हेडर।
• एक Authorization: Bearer टोकन।
• एक ?api_key=क्वेरी पैरामीटर।

हेडर-आधारित प्रमाणीकरण सर्वर-साइड कोड के लिए सबसे सुरक्षित डिफ़ॉल्ट है; क्वेरी पैरामीटर त्वरित परीक्षणों और ब्राउज़र-साइड कॉल के लिए सुविधाजनक है। प्रतिक्रियाएँ CORS-खुली हैं, इसलिए आप जब चाहें तब फ्रंट एंड से सीधे API को कॉल कर सकते हैं, और इन्हें चिह्नित किया गया है noindex ताकि आपका डेटा खोज इंजनों में लीक न हो।

कोटा और योजनाएँ

उपयोग प्रति दिन मापा जाता है, और प्रत्येक प्रतिक्रिया आपको बताती है कि आप कहाँ खड़े हैं — प्रत्येक पेलोड में आपके कोटा का उपयोग शामिल है, इसलिए आपको कभी भी यह अनुमान लगाने की आवश्यकता नहीं है कि आपके पास कितने कॉल बचे हैं।

• फ्री टियर: 100 कॉल प्रति दिन।
• API योजना: 10,000 कॉल प्रति दिन €19 प्रति 30 दिन।
• बिजनेस एनालिटिक्स टियर:API एक्सेस शामिल है।

फ्री पर प्रोटोटाइप शुरू करें, फिर जब आपकी इंटीग्रेशन को जगह की आवश्यकता हो, तो ऊपर बढ़ें।

पूर्वानुमानित JSON, पूर्वानुमानित त्रुटियाँ

सफलता और विफलता दोनों JSON के रूप में वापस आती हैं। जब कुछ गलत होता है, तो प्रतिक्रिया में एक errorक्षेत्र और सही HTTP स्थिति होती है, ताकि आपकी त्रुटि हैंडलिंग स्थिति कोड पर शाखा बना सके बजाय कि स्ट्रिंग्स को पार्स करने के।

• 401 — खराब कुंजी।
• 429 — कोटा पार हो गया।
• 400 / 422 — खराब पैरामीटर।

क्योंकि कोटा स्थिति हर प्रतिक्रिया में भेजी जाती है, एक अच्छा व्यवहार करने वाला क्लाइंट 429 देखने से पहले ही पीछे हट सकता है।

शुरू करने के लिए कैसे

1. खोलें /my/api.php और एक API कुंजी बनाएं।
2. एक एंडपॉइंट चुनें — शुरू करें /api/v1/stats उस साइट के लिए जिसे आप स्वामित्व करते हैं।
3. अपनी कुंजी को X-Api-Key हेडर में भेजें और JSON वापस पढ़ें।

पहली कॉल एक एकल पंक्ति है:

curl -H "X-Api-Key: YOUR_KEY" https://astrina.io/api/v1/stats

क्या आप एक बियरर टोकन पसंद करते हैं? हेडर को बदलें:

curl -H "Authorization: Bearer YOUR_KEY" https://astrina.io/api/v1/reviews

या त्वरित जांच के लिए कुंजी को सीधे URL में डालें:

curl "https://astrina.io/api/v1/rating?api_key=YOUR_KEY"

वहाँ से, वही पैटर्न रेटिंग और फोन बुद्धिमत्ता को कवर करता है - एक कुंजी, एक शीर्षक, डेटा के चार स्रोत। अपनी कुंजी प्राप्त करें और आज अपना पहला कॉल करें।