POST isteğidir.
Yoklama yapmana gerek yoktur.
Olaylar hafiftir. Nesne ID’sini, yeni durumu, bir revizyonu ve okunacak url adresini taşırlar.
Asla laboratuvar değerleri veya kişisel veriler taşımazlar. Verileri almak için url adresini
API anahtarınla oku.
Hızlı kurulum
POSTkabul eden ve 15 saniye içinde2xxyanıtı veren bir HTTPS uç noktası oluştur.- Bunu Webhook oluştur ile kaydet.
Yanıttaki
secretdeğerini sakla. Aniva bunu yalnızca bir kez gösterir. - Her isteğin imzasını doğrula.
- Bir test olayı gönder. Sonucu Teslimatları listele üzerinden kontrol et.
webhooks_manage kapsamına ihtiyacı vardır. Bunu eklemesini Aniva’dan iste. Bir
webhook kendisini oluşturan API anahtarına aittir ve bir anahtar en fazla 5 webhook’a sahip
olabilir.
Olaylar
Yalnızca API anahtarının eşleşenGET uç noktasıyla okuyabildiği nesneler için olay alırsın.
Türleri enabled_events ile seç. Sonradan eklenenler dahil her türü almak için ["*"] gönder.
- Bir durum olayı, geri dönüşler dahil o duruma her geçişte tetiklenir. Örneğin
dispatcheddurumundan tekrarpendingdurumuna dönen bir kithome_kit_order.pendinggönderir. - Tek bir değişiklik aynı
status_revisionile iki olay gönderebilir; örneğinappointment.confirmedveappointment.rescheduled. results.updated, sonuçlardaki her değişiklikte tetiklenir: yeni bir değer, düzeltme, hata, yeni veya değiştirilmiş bir belge ya da nesneden ayrılan bir numune. Son değişiklikten birkaç dakika içinde ulaşır.results.completedveresults.faulther zaman aynıresults_revisiondeğerine sahip birresults.updatedile birlikte gelir. Sonuçlar yeniden açılıp tekrar tamamlanabilir, bu yüzden ikinci birresults.completedalabilirsin.
results.updated olayına, yalnızca kesin sonuçlara göre işlem
yapmak için results.completed olayına abone ol.
results.completed PDF’i değil, sonuç değerlerini takip eder. Rapor PDF’i değerlerden önce veya
sonra ulaşabilir. Bazı laboratuvarlar önce bir ön rapor PDF’i gönderir ve daha sonra bunu aynı belge
id değeri altında kesin raporla değiştirir. Değiştirme işlemi results.updated gönderir. İkisini
ayırt etmek için documents[].original_file_name alanını oku: Labor Quade ön raporu (Vorbefund)
_V ile, kesin raporu (Endbefund) _E ile bitirir; örneğin 7642100312_B0012_FA_E.pdf.
Konum, profil ve gönderi olayları birkaç dakika içinde ulaşır. Aniva, nesne 2 dakika boyunca
değişmeyene kadar bekler; böylece art arda yapılan düzenlemeler tek bir olay gönderir. Şu kurallar
da geçerlidir:
- Anonim profiller olay göndermez.
- Bir gönderiye erişimini kaybettiğinde gönderi olay göndermez.
- Bir gönderi durumu değişikliği, aynı
revisiondeğeriyleshipment.updatedveshipment.<status>olayını gönderir.
Veri yükü
Durum olayı verileri
appointment.confirmed
Sonuç olayı verileri
home_kit_order.results.completed
Belge silme olayı verileri
document.deleted, object (document), id, previous_results_status ve results_revision
alanlarını taşır. Okunacak bir şey kalmadığı için url içermez.
document.deleted
Konum, profil ve gönderi olayı verileri
shipment.in_transit
ping, data.object olarak webhook ve data.id olarak webhook kimliğini taşır.
İmzayı doğrula
Olaylar veri taşımaz ama yine de her birini doğrulamalısın. Geçerli bir imza, olayın Aniva’dan geldiğini kanıtlar. Her istekwebhook-id, webhook-timestamp (Unix saniyesi) ve
webhook-signature başlıklarını taşır.
- Ham istek gövdesini al. JSON’ı ayrıştırmadan önce doğrula.
- İmzalanan içeriği
{webhook-id}.{webhook-timestamp}.{raw body}biçiminde oluştur. - Gizli anahtarının
whsec_sonrasındaki kısmını base64 ile çöz. Bunu anahtar olarak kullan. - İmzalanan içeriğin HMAC-SHA256 değerini hesapla ve base64 olarak kodla.
- Bunu
webhook-signatureiçindeki herv1,<signature>girdisiyle sabit zamanda karşılaştır. Girdiler boşluklarla ayrılır. Tek bir eşleşme yeterlidir. webhook-timestampsaatinden 5 dakikadan fazla farklıysa isteği reddet.
Node.js
Gizli anahtarı yenile
Yeni bir gizli anahtar almak için Gizli anahtarı döndür çağrısını yap. Aniva 24 saat boyunca hem eski hem de yeni gizli anahtarla imzalama yapar; bu yüzden yenisini bu süre içinde devreye al. Bir sızıntı sonrasında eski gizli anahtarı hemen durdurmak içinrevoke_current_secret_now: true gönder.
Teslimat
- 15 saniye içinde
2xxyanıtı ver. Olayı sakla veya kuyruğa al ve işlemi daha sonra yap. - Herkese açık bir sunucuda 443 portunda bir
httpsURL’si kullan. Aniva yönlendirmeleri takip etmez:3xxyanıtı başarısız sayılır. - Teslimat en az bir kez ve sırasız yapılır.
webhook-iddeğerine göre yinelenenleri atla. Daha eski bir olayı yoksaymak için revizyonları kullan. - Olayları durdurmak için
410 Goneyanıtı ver. Aniva webhook’u hemen devre dışı bırakır. - Aniva teslimatları 30 gün boyunca saklar. Bu süreden sonra bunları listeleyemez veya yeniden gönderemezsin.
Yeniden denemeler
2xx dışındaki bir yanıt, zaman aşımı veya ağ hatası yeniden denemeyi başlatır. Her olay için yaklaşık üç gün boyunca
en fazla 10 deneme yapılır:
Teslimat, 10. denemeden sonra
failed olur.
Teslimatı yeniden gönder ile tekrar gönder. Aynı webhook-id korunur.
Hata bildirimleri
24 saat boyunca hiçbir teslimat başarılı olmadığında, bir olayfailed durumuna geçtiğinde ve webhook devre dışı
bırakıldığında Aniva, webhook’un alert_emails adreslerine e-posta gönderir. Başarılı bir teslimat olmadan 5 gün
geçtikten sonra Aniva webhook’u devre dışı bırakır. Devre dışı bırakılan bir webhook yeni olay almaz ve bekleyen
teslimatları iptal edilir.
Yeniden başlamak için uç noktanı düzelt ve Webhook’u güncelle ile
status: "enabled" gönder. Kaçırılan olaylar kendiliğinden tekrar
gönderilmez. Bunları yeniden gönder veya GET uç noktalarıyla mevcut durumu oku.
Tekrarlanan okumalar
Aniva bazıGET uç noktalarının yanıtını kısa bir süre saklar. API anahtarın bu süre içinde aynı
isteği tekrar gönderdiğinde saklanan yanıtı alırsın. Hata almazsın ve gövde aynı
biçimde olur.
- Tek bir kayıt (bir gönderi, bir evde test kiti siparişi, bir randevu ve son ikisinin sonuçları): Aniva her çağrıda kaydın değişmediğini kontrol eder. Değiştiyse yeni bir yanıt alırsın.
- Bir liste, kayıtlarından en fazla 5 dakika daha eski olabilir.
- Aynı istek; aynı API anahtarı, aynı uç nokta ve aynı sorgu parametreleri anlamına gelir. Bir listenin başka bir sayfası farklı bir istektir ve kendi yanıtını alır.
- Aniva yalnızca
200yanıtını saklar. Bir hata hiçbir zaman saklanmaz. - Süre, Aniva yanıtı sakladığında başlar. Daha sonraki bir çağrı bu süreyi uzatmaz.
- API anahtarın bir şey oluşturduktan, güncelledikten, etkinleştirdikten veya iptal ettikten sonra bir sonraki okuman güncel olur. Bu kaydın başka bir API anahtarınla yapılan bir sonraki okuması da güncel olur.
- Saklanan bir gönderi yanıtında
synced_atveupdated_atalanları yeni bir yanıttakinden daha eski olabilir. Durum, takip ve adresler günceldir. - Saklanan bir sonuç yanıtında, Aniva kataloğunu değiştirdikten sonra bir biyobelirteç adı, bir birim veya dönüştürülmüş bir değer en fazla 60 dakika eski olabilir. Ölçülen değerler günceldir.
- Aniva webhook’un için bir webhook olayı oluşturduktan sonra o kaydın, sonuçlarının ve listelerinin bir sonraki okuması güncel olur. Dolayısıyla bir olayı izleyen okuma her zaman değişikliği gösterir.
Yanıt başlıkları
Bu uç noktaların geçerli bir API anahtarına verdiği her yanıtta şu başlıklar yer alır:En iyi uygulamalar
- Yinelenenleri atla.
webhook-iddeğerini zaten işlediğin bir olayı atla. - Revizyonları kullan. Nesne başına en yüksek
status_revision,results_revisionverevisiondeğerlerini sakla. Daha düşük değerli bir olayı yoksay. urladresini getir. Olay bir şeyin değiştiğini söyler.GETuç noktası ise neyin değiştiğini söyler.- Hızlı yanıt ver. Olayı kuyruğa al ve işlemeden önce
2xxyanıtı ver. - Eşitle. Açık nesneleri
GETuç noktalarıyla okuyan düzenli bir görev çalıştır. Yoklama geçerli bir yedek yöntem olmayı sürdürür. Tekrarlanan bir okuma saklanan bir yanıt alabilir, bkz. Tekrarlanan okumalar. - Her dağıtımdan sonra test et. Test olayı gönder uç noktasını kullan.