API загальнодоступних відомостей
Відомості про продукт і документація
API публічної інформації Vox.md надає відомості й посилання на документацію. Читання безкоштовне й не потребує облікового запису, ключа API, OAuth чи оплати. Точки повертають інформацію, вже доступну на публічному сайті. Прочитайте Контракт OpenAPI 3.1 для типізованих схем відповідей, ID операцій, помилок і описів.
Отримати відомості продукту
GET https://vox.isolated.tech/api/v1/product повертає назву, опис, підтримувані ОС, сторінку App Store, 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 із запитаннями.