பொதுத் தகவல் 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 ஆதரவு கேள்விகளுக்கு.