सार्वजनिक जानकारी API
उत्पाद के तथ्य और दस्तावेज़ जानें
Vox.md सार्वजनिक जानकारी API उत्पाद की जानकारी और प्रकाशित दस्तावेज़ों के लिंक देता है। इसे पढ़ना मुफ़्त है और इसके लिए खाता, API कुंजी, OAuth प्रक्रिया या भुगतान आवश्यक नहीं। ये एंडपॉइंट वही जानकारी लौटाते हैं जो इस सार्वजनिक वेबसाइट पर पहले से उपलब्ध है। पढ़ें OpenAPI 3.1 अनुबंध टाइपयुक्त प्रतिक्रिया स्कीमा, ऑपरेशन पहचानकर्ता, त्रुटियों और विवरणों के लिए।
उत्पाद की जानकारी लें
GET https://vox.isolated.tech/api/v1/product उत्पाद का नाम, विवरण, समर्थित ऑपरेटिंग सिस्टम, App Store लिस्टिंग, दस्तावेज़ URL और सहायता URL लौटाता है। बिल्ड ये तथ्य मुखपृष्ठ के संरचित डेटा से लेता है।
curl https://vox.isolated.tech/api/v1/product
दस्तावेज़ ढूँढ़ें
GET https://vox.isolated.tech/api/v1/documents सार्वजनिक पृष्ठों के शीर्षक, सारांश और URL सूचीबद्ध करता है। सामग्री का अनुरोध करने से पहले संबंधित सुविधा गाइड, नीति, ब्लॉग लेख या सहायता पृष्ठ खोजने के लिए इसका उपयोग करें।
curl https://vox.isolated.tech/api/v1/documents
दस्तावेज़ अनुक्रमणिका JSON देखें
पृष्ठ को Markdown में पढ़ें
किसी भी सूचीबद्ध पृष्ठ का अनुरोध इसके साथ करें: Accept: text/markdown उसकी मुख्य सामग्री के लिए। इनके साथ किए गए अनुरोध: Accept: text/html को HTML मिलता रहता है। दोनों रूपों में शामिल हैं Vary: Accept. यह एजेंट गाइड बताती है कि किन उपयोगों के लिए Vox.md उपयुक्त है और सुविधाओं के विवरण तक पहुँचाती है।
curl -H 'Accept: text/markdown' https://vox.isolated.tech/docs/
त्रुटियाँ, कैशिंग और विधियाँ
JSON एंडपॉइंट GET और HEAD का समर्थन करते हैं। अज्ञात API पथ HTTP 404 लौटाते हैं, साथ में application/problem+json, एक स्थिर code, एक स्पष्टीकरण और पुनर्प्राप्ति का संकेत। असमर्थित विधियाँ HTTP 405 और यह लौटाती हैं: Allow: GET, HEAD. सार्वजनिक मेटाडेटा प्रतिक्रियाएँ क्रॉस-ऑरिजिन पठन की अनुमति देती हैं और पाँच मिनट की कैश अवधि बताती हैं। इनमें कोई क्रेडेंशियल या उपयोगकर्ता-विशिष्ट डेटा शामिल नहीं होता।
इंस्टॉल किए ऐप को स्वचालित करें
कैप्चर, लिप्यंतरण, स्थानीय वॉल्ट ऐक्सेस और नोट लिखना इंस्टॉल किए Apple ऐप में चलते हैं। दस्तावेज़ित सुविधा इस्तेमाल करें: शॉर्टकट्स और URL स्कीम एकीकरण डिवाइस के मालिक की अनुमति से। सार्वजनिक जानकारी API कैप्चर ऐक्शन, रिकॉर्डिंग, ट्रांसक्रिप्ट, निजी नोट या गंतव्य फ़ोल्डर उजागर नहीं करता। संपर्क करें Vox.md सहायता प्रश्नों के लिए।