API общедоступных сведений
Сведения о продукте и документация
API общедоступных сведений Vox.md предоставляет информацию о продукте и ссылки на опубликованную документацию. Чтение бесплатно, не требует аккаунта, ключа API, OAuth или оплаты. Эти конечные точки возвращают сведения, уже доступные на этом публичном сайте. Прочитайте Контракт OpenAPI 3.1 для типизированных схем ответов, идентификаторов операций, ошибок и описаний.
Получить сведения о продукте
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 с вопросами.