API thông tin công khai
Khám phá thông tin sản phẩm và tài liệu
API thông tin công khai Vox.md phục vụ thông tin sản phẩm và liên kết tài liệu đã công bố. Đọc miễn phí, không tài khoản, khóa API, OAuth hay thanh toán. Điểm cuối trả thông tin đã có trên web công khai này. Đọc hợp đồng OpenAPI 3.1 để xem lược đồ phản hồi có kiểu, ID thao tác, lỗi và mô tả.
Lấy thông tin sản phẩm
GET https://vox.isolated.tech/api/v1/product trả tên sản phẩm, mô tả, hệ điều hành hỗ trợ, trang App Store, URL tài liệu và hỗ trợ. Bản dựng suy ra từ dữ liệu có cấu trúc trang chủ.
curl https://vox.isolated.tech/api/v1/product
Tìm tài liệu
GET https://vox.isolated.tech/api/v1/documents liệt kê tên, tóm tắt, URL trang công khai. Dùng tìm hướng dẫn, chính sách, bài blog hay hỗ trợ trước khi yêu cầu nội dung.
curl https://vox.isolated.tech/api/v1/documents
Đọc trang dạng Markdown
Yêu cầu trang đã liệt kê bằng Accept: text/markdown cho nội dung chính. Yêu cầu có Accept: text/html vẫn nhận HTML. Cả hai dạng chứa Vary: Accept. Phần hướng dẫn tác nhân giải thích cách dùng hợp Vox.md, chỉ chi tiết tính năng.
curl -H 'Accept: text/markdown' https://vox.isolated.tech/docs/
Lỗi, đệm và phương thức
Các điểm cuối JSON hỗ trợ GET và HEAD. Đường dẫn API không xác định trả HTTP 404 kèm application/problem+json, một giá trị ổn định code, giải thích và gợi ý khôi phục. Phương thức không hỗ trợ trả HTTP 405 và Allow: GET, HEAD. Phản hồi siêu dữ liệu công khai cho đọc khác nguồn, công bố thời gian đệm năm phút. Không có thông tin xác thực hay dữ liệu riêng người dùng.
Tự động hóa ứng dụng cài
Ghi nhanh, chép lời, truy cập kho cục bộ và ghi tệp ghi chú đều chạy trong ứng dụng đã cài trên thiết bị Apple. Sử dụng Tích hợp Shortcuts và lược đồ URL được mô tả trong tài liệu, với sự cho phép của chủ thiết bị. API thông tin công khai không cung cấp quyền truy cập tác vụ ghi nhanh, bản ghi âm, bản chép lời, ghi chú riêng hoặc thư mục đích. Liên hệ hỗ trợ Vox.md nếu có câu hỏi.