Neler yapabilirsin
- Profil yönetimi — Hasta demografik profilleri oluştur, getir ve güncelle.
- Randevu planlama — Aniva test konumlarında kan alma randevuları al.
- Panel yönetimi — Mevcut bir randevuya laboratuvar test panelleri ekle veya randevudan çıkar.
- Tekil biyobelirteçler — Bir panel seçmeden randevuya tekil biyobelirteçler ekle veya randevudan çıkar.
- Evde test kiti siparişleri — Hastaya eve gönderilen bir test kiti yolla, kargolarını takip et ve örneğin ne zaman alındığını bildir.
- Panel kataloğu — Panel ID’lerini ve içerdikleri biyobelirteçleri görmek için
GET /api/v1/panelsile mevcut panellere göz at. - Biyobelirteç kataloğu — ID’leri bulmak için bir konumda veya evde test kitinde sipariş edebileceğin biyobelirteçlere
GET /api/v1/biomarkersile göz at. - Kan alma onayı — Laboratuvar sipariş akışını tetiklemek için kan alma işleminden sonra laboratuvar kodunu (veya kodlarını) gönder.
- Laboratuvar sonuçları — Klinik ve genetik sonuçları getir ve laboratuvar raporu PDF’lerini indir.
- Konum keşfi — Hastalara sunmak için mevcut test konumlarını listele.
- Gönderi lojistiği — Kurye gönderi siparişleri oluştur, takip et, düzenle ve iptal et.
- Webhook’lar — Bir randevu, evde test kiti siparişi, sonuçları, bir konum, bir profil veya bir gönderi değiştiğinde HTTPS çağrısı al. Webhook’lar sayfasına bak.
Dokümanları keşfet
Kimlik doğrulama
İsteklerin kimliğini iş ortağı API anahtarınla doğrula.
Hızlı başlangıç
Adım adım örneklerle dakikalar içinde ilk API çağrını yap.
Profiller
Hasta profillerinin nasıl çalıştığını ve hangi verileri tuttuğunu öğren.
Randevular
Planlamadan onaya kadar randevu yaşam döngüsünü anla.
Evde test kiti siparişleri
Hastanın evine bir test kiti gönder ve örnek laboratuvara ulaşana kadar takip et.
API sürümleme
Güncel API sürümü v1. Tüm uç noktalar/api/v1/ ön ekiyle başlar. Temel URL https://anivahealth.com adresidir.
Tarihler ve saat dilimleri
Aktarılan tüm zaman noktaları UTC ISO 8601 (Z son eki) biçimindedir. Yalnızca takvim alanları duvar saati
bileşenleri (YYYY-MM-DD, HH:MM) kullanır.
Özel notlar:
- Tarih-saat alan girdiler (ör.
POST/PATCH /api/v1/appointmentsüzerindekischeduled_at) bir saat dilimi belirteci içermelidir — yaZya da+02:00gibi açık bir saat farkı. Saat dilimi olmayan tarih-saat değerleri400ile reddedilir. Her iki biçim de aynı zaman noktasını ifade eder; yanıtscheduled_atalanını her zaman UTCZolarak döndürür. Zaman noktasını gösterirken yerel duvar saatine biçimlendirmek için konumuntimezonealanını (veya başka bir IANA tanımlayıcısını) kullan. - Duvar saati girdileri hedefledikleri kaynağın saat diliminde yorumlanır: uygunluk tarihleri
timezonesorgu parametresini kullanır (varsayılan olarak konumun saat dilimi); gönderipickup_date/pickup_time_*alanları çıkış konumunun saat diliminde yorumlanır. - Yalnızca tarih içeren yanıt alanları (ör.
tested_at, uygunlukavailability[].date) saat dilimi olmayan takvim tarihleridir.
Erişim alma
API anahtarları Aniva tarafından her iş ortağı için ayrı olarak verilir.İş ortağı API anahtarını almak için Aniva ile iletişime geç.