Ana içeriğe geç
Vekilaw logosu: Hukuk Bilgi İletişim Sistemi

API ile okuyun, webhook ile olayları alın.

API anahtarı izinli verileri salt okunur sunar. Webhook aboneliği yapılandırıp imzalı test gönderimi başlatabilir, isteğe bağlı olarak seçtiğiniz şubenin dava, duruşma ve belge oluşturma/güncelleme/silme olaylarını otomatik alabilirsiniz. Teslimat en az bir kez yapılır; alıcı tekrarları ayıklamalıdır.

Abonelikte seçilebilen olaylar

Örnek abonelik seçenekleri; otomatik teslimat abonelikte etkinleştirilip şube seçilince çalışır.

Abonelikte seçilebilen olay örnekleri
KaynakOluşturulduGüncellendiSilindi
DavaSeçiliSeçiliSeçili değil
DuruşmaSeçiliSeçiliSeçili
BelgeSeçiliSeçili değilSeçili değil
API anahtarı

API anahtarı dava, müvekkil, duruşma, belge metadata ve fatura verilerine salt okunur erişim verir. Güncel kullanıcı izinleri, şirket ve şube kapsamı ile plan koşulları uygulanır; yazma işlemi veya belge dosyasına sınırsız erişim vaat edilmez.

01/03

Test ve teslimat sonucu.

Yetkili kullanıcının başlattığı test gönderimi ve otomatik teslimat imzalanır; deneme sonucu kayda alınır. Alıcının başarılı yanıtı, ERP işleminin tamamlandığını kanıtlamaz. Otomatik teslimat geçici hatalarda (zaman aşımı, ağ hatası, 408, 429, 5xx) en çok beş denemeyle, artan aralıklarla yeniden denenir; diğer yanıtlar yeniden denenmez.

  1. Test isteği

    Örnek

    Yetkili kullanıcı test başlatır.

  2. Hedef kontrolü

    Doğrulanacak

    Adres ve abonelik koşulları değerlendirilir.

  3. İmzalı test

    Koşullu

    Gönderim güvenlik kontrollerine bağlıdır.

  4. Alıcı yanıtı

    İncelenecek

    Yanıt ERP işleminin tamamlandığını kanıtlamaz.

  5. Test sonucu

    Taslak

    Başarı veya hata günlüğe yazılır; bu gerçek işlem kaydı değildir.

Örnek test akışı; gerçek teslimat veya alıcı işlem kanıtı değildir.

İmzalı
İmzalı isteğin doğrulanması alıcı sisteminizin sorumluluğundadır; imza zaman damgası ve teslimat kimliğini kapsar.
Hata inceleme
Başarısız sonucu inceleyin. Otomatik teslimat geçici hatalarda kendiliğinden yeniden denenir; denemeler tükenirse olay yeniden gönderilmez, test ise yeniden başlatılabilir.
Test
Yetkili kullanıcı gerçek olay beklemeden test gönderimi başlatır; otomatik teslimat gerçek olayla tetiklenir.
Kayıt
Test ve otomatik teslimat denemelerinin sonucu entegrasyon günlüğünden incelenir.

02/03

Abonelik beş adımda kurulur.

Olay seçeneklerini ve hedef adresi yapılandırın. Güvenlik ve yetki kontrolleri uygulanır; otomatik teslimat için abonelikte etkinleştirme, şube seçimi ve imza anahtarı gerekir.

Geliştirici ve hukuk ekibi üyesi webhook akışını not defterinde çiziyor
Webhook planlama

09:20 Adresi ve olayları girin

Örnek kurulum ve test akışı; gerçek teslimat kanıtı değildir.

03/03

Webhook ve API hakkında ne sorulur?

  1. 01/08

    Hangi olaylar için webhook gönderilir?

    Dava, duruşma ve belge için oluşturma, güncelleme ve silme olayları seçilebilir. Seçilen olaylar, aboneliğin otomatik teslimatı etkinleştirildikten sonra seçili şubede oluşan kayıtlar için gönderilir; kaydetmek eski olayları göndermez. Yük yalnız olay adı, kayıt ve teslimat kimlikleri ile zamanı taşır; dava içeriğini taşımaz. Yetkili kullanıcı ayrıca imzalı test isteği başlatabilir.

  2. 02/08

    Bildirimlerin Vekilaw'dan geldiğini nasıl anlarım?

    İmzalı isteği alıcı sisteminizde doğrulayın; doğrulanamayan isteği kabul etmeyin. İmza, anahtarınızla zaman damgası, teslimat kimliği ve gövde üzerinden üretilir ve istek başlığında gelir. Bu örnek sayfa gerçek imza doğrulaması veya teslimat sonucu göstermez.

  3. 03/08

    Bildirim teslim edilemezse ne olur?

    Sonucu günlükten inceleyin. Otomatik teslimat zaman aşımı, ağ hatası, 408, 429 ve 5xx yanıtlarında en çok beş denemeyle, artan aralıklarla yeniden denenir; diğer yanıtlar ve tükenen denemeler sonrası olay yeniden gönderilmez. Test için hedef ve abonelik koşulları uygunsa yetkili kullanıcı yeni test başlatabilir.

  4. 04/08

    API anahtarını nasıl alırım?

    Güncel plan kapsamı ve API anahtarı yönetim izni gerekir. Yetkili kullanıcı Ayarlar bölümünden anahtar oluşturur, yeniler veya iptal eder. Açık anahtar yalnız oluşturma/yenileme sonucunda bir kez gösterilir; plan adı tek başına erişim vermez.

  5. 05/08

    API ile hangi verilere ulaşırım?

    Dava, müvekkil, duruşma, belge metadata ve fatura verilerine salt okunur erişim sağlanır. Oluşturan kullanıcının güncel şirket, şube ve işlem izinleri uygulanır. Yazma işlemi veya belge dosyasına sınırsız erişim yoktur. İzinleri roller ve izinler üzerinden yönetin.

  6. 06/08

    Başka bir büronun verisi adresime ulaşabilir mi?

    Hayır. Her şirketin abonelikleri ve API erişimi yalnızca kendi verisini kapsar. Ayrıntılı veri ayrımı ve güvence modeli güvenlik sayfasında anlatılır.

  7. 07/08

    Webhook ve API ile tipik olarak ne kurulur?

    Salt okunur API ile izinli verileri kurum içi raporlamanızda kullanabilirsiniz. Webhook ile dava, duruşma ve belge değişikliklerinden haberdar olabilir, bağlantıyı imzalı testle doğrulayabilirsiniz; otomatik CRM/ERP kaydı açma veya belge dosyası kopyalama sunulmaz. Diğer durumlar entegrasyonlar sayfasında.

  8. 08/08

    Webhook olaylarının kaynağı olan kayıtlar nerede?

    Dava, duruşma ve belge kayıtları ilgili ürün modüllerinde tutulur. Otomatik teslimat yalnız etkinleştirilmiş abonelik, seçili şube ve yeterli yetki varken çalışır; yetki veya abonelik değişirse bekleyen teslimatlar gönderilmez. Dava yönetimini inceleyin.

Salt okunur erişim ve olay teslimi kapsamını planlayalım.