Herkese Açık Bilgi API'si
Ürün bilgilerini ve belgeleri keşfedin
Vox.md Herkese Açık Bilgi API'si ürün bilgilerini ve yayımlanmış belgelere bağlantıları sunar. Okumak ücretsizdir; hesap, API anahtarı, OAuth akışı veya ödeme gerekmez. Bu uç noktalar, herkese açık bu sitede zaten bulunan bilgileri döndürür. Şunu okuyun: OpenAPI 3.1 sözleşmesi türlü yanıt şemaları, işlem tanımlayıcıları, hatalar ve açıklamalar için.
Ürün bilgilerini alın
GET https://vox.isolated.tech/api/v1/product ürün adını, açıklamayı, desteklenen işletim sistemlerini, App Store sayfasını, belge URL'sini ve destek URL'sini döndürür. Derleme bu bilgileri ana sayfanın yapılandırılmış verisinden türetir.
curl https://vox.isolated.tech/api/v1/product
Ürün JSON verisini görüntüleyin
Belge bulun
GET https://vox.isolated.tech/api/v1/documents herkese açık sayfa başlıklarını, özetlerini ve URL'lerini listeler. İçeriği istemeden önce ilgili özellik kılavuzunu, politikayı, blog makalesini veya destek sayfasını bulmak için kullanın.
curl https://vox.isolated.tech/api/v1/documents
Belge dizini JSON verisini görüntüleyin
Sayfayı Markdown olarak okuyun
Listelenen herhangi bir sayfayı şununla isteyin: Accept: text/markdown ana içeriği için. Şunu içeren istekler: Accept: text/html HTML almaya devam eder. Her iki gösterim şunları içerir: Vary: Accept. ajan kılavuzu hangi kullanım alanlarının Vox.md'ye uyduğunu açıklar ve özellik ayrıntılarına yönlendirir.
curl -H 'Accept: text/markdown' https://vox.isolated.tech/docs/
Hatalar, önbellekleme ve yöntemler
JSON uç noktaları GET ve HEAD yöntemlerini destekler. Bilinmeyen API yolları HTTP 404 ile birlikte şunu döndürür: application/problem+json, kararlı bir code, açıklama ve kurtarma ipucu. Desteklenmeyen yöntemler HTTP 405 ve şunu döndürür: Allow: GET, HEAD. Herkese açık meta veri yanıtları kaynaklar arası okumaya izin verir ve beş dakikalık önbellek ömrü bildirir. Kimlik bilgileri veya kullanıcıya özel veri söz konusu değildir.
Yüklü uygulamayı otomatikleştirin
Yakalama, ses dökümü, yerel kasa erişimi ve not yazma yüklü Apple uygulamasında çalışır. Belgelenmiş şunu kullanın: Kestirmeler ve URL şeması entegrasyonları cihaz sahibinin izniyle. Herkese açık bilgi API'si yakalama eylemlerini, kayıtları, dökümleri, özel notları veya hedef klasörleri açığa çıkarmaz. İletişim: Vox.md desteği sorularınız için.