API المعلومات العامة
اكتشف معلومات المنتج ووثائقه
تقدّم API المعلومات العامة لـ Vox.md معلومات المنتج وروابط الوثائق المنشورة. قراءتها مجانية ولا تحتاج إلى حساب أو مفتاح 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
اقرأ الصفحة بصيغة 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 للأسئلة.