Yapılandırma seçenekleri
Web kancasını yapılandırmak için beş öğenin tanımlanması gerekir:
- Ad: Diğer yöneticilerin kolayca anlayabileceği sezgisel bir ad önerilir.
- Kapsam: Web kancasının yakalayacağı ağ genişliği nedir? Hesap ve Grup, arabirimde mevcuttur.
- API; Hesap, Grup, Kullanıcı ve Kaynak kapsamlarını destekler.
- Her web kancası için yalnızca bir Kapsam tanımlanabilir.
- URL: Adobe Sign'ın JSON yükünü ilettiği hedef URL.
- Olaylar: Adobe Sign'ın JSON oluşturma ve URL'ye gönderme işlemini tetikleyen durumlar.
- Her olay, tetikleyici olayla ilgili farklı bir yük oluşturur.
- Tek bir web kancasına birden fazla Olay eklenebilir.
- Bildirim Parametreleri: Bildirim Parametreleri, Olay JSON yükünün bölümlerini tanımlar. Bu şekilde yalnızca bu web kancası için önemli olan Olay bölümlerini seçebilirsiniz (böylelikle URL'nize gönderilen gereksiz veriler azaltılır).
Web kancası tam olarak tanımlandıktan sonra Kaydet'i tıklatın; yeni web kancası tetiklenen olaylara anında yanıt vermeye başlayacaktır.
Lütfen web kancası URL'nizi, yukarıda açıklanan doğrulama protokolüne göre web kancası doğrulama ve web kancası bildirim isteklerine yanıt verecek şekilde yapılandırın. Acrobat Sign web uygulamasından oluşturulan web kancalarına gönderilecek istemci kimliği (Uygulama Kimliği) UB7E5BXCXY olacaktır.
Kapsamlar
- Hesap: Hesapta meydana gelen tüm abone olunan olaylar gönderme işlemini tetikler.
- Hesap yöneticileri, hesap için tanımlanan tüm web kancalarını ve bu hesap içerisindeki tüm grupları görme yetkisine sahiptir.
- Grup: Hesapta meydana gelen tüm abone olunan olaylar gönderme işlemini tetikler. NOT: Grup kapsamı bulunan web kancaları yalnızca o grup için mevcuttur.
- Grup yöneticileri yalnızca kendi gruplarına ayrılmış web kancalarını görür. Hesap düzeyinde web kancalarını veya diğer gruplara bağlı web kancalarını göremezler.
- Birden Fazla Gruptaki Kullanıcılar seçeneğinin etkin olduğu hesaplarda, kapsamın uygulanması gereken grubu belirleme seçeneği görünür.
- Kullanıcı Hesabı: Bir kullanıcı hesabı için abone olunan tüm olaylar gönderme işlemini tetikler. Kullanıcı düzeyinde web kancaları yalnızca API aracılığıyla oluşturulabilir.
- Kaynak düzeyinde web kancası: Belirli bir kaynak için oluşturulur. Bu kaynağa özel olaylar, web kancası URL'sine gönderilir. Kaynak düzeyinde web kancaları yalnızca API aracılığıyla oluşturulabilir.
URL
Web kancası URL'si, olaylar meydana geldiğinde tetiklenen, gelen HTTPS POST bildirim mesajlarını dinleyen bir sunucudur.
Olaylara yönelik web kancanıza abone olmak için bu URL'ye ihtiyacınız vardır.
- İstemcide, Acrobat Sign'ın GÖNDERİM yapabileceği bir HTTPS URL'si olmalıdır. Bu URL herkese açık internette bulunmalıdır.
- Örneğin, 127.0.0.1 olduğunda yerel ana makine URL'leri çalışmayacaktır.
- URL uç noktası 443 veya 8443 numaralı bağlantı noktasını dinliyor olmalıdır (geri çağırma URL'sini tanımlarken müşteri tarafından belirlenir).
- Web kancasının, gelen olay bildirimleri için POST isteklerini ve doğrulama isteği için GET isteklerini desteklediğinden emin olun.
- URL, güvenlik duvarı tarafından engellenmemelidir.
Olaylar
Aşağıda, nesneye göre gruplandırılmış ve kullanıcı arabirimindeki sıraya göre listelenmiş web kancası URL'sine push işlemini tetikleyebilecek olaylar yer almaktadır.
Soldaki değer Acrobat Sign kullanıcı arabiriminde göreceğiniz değerdir. Sağdaki değer API'deki web kancası adıdır.
Web kancaları ve yükleriyle ilgili tüm ayrıntılar için Acrobat Sign geliştirici kılavuzuna bakın.
Sözleşmeler:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Sözleşme tüm olaylar | AGREEMENT_ALL |
| Sözleşme oluşturuldu | AGREEMENT_CREATED |
| Sözleşme gönderildi | AGREEMENT_ACTION_REQUESTED |
| Sözleşme katılımcısı tamamlandı | AGREEMENT_ACTION_COMPLETED |
| Sözleşme iş akışı tamamlandı | AGREEMENT_WORKFLOW_COMPLETED |
| Sözleşmenin süresi doldu | AGREEMENT_EXPIRED |
| Sözleşme silindi | AGREEMENT_DOCUMENTS_DELETED |
| Sözleşme iptal edildi | AGREEMENT_RECALLED |
| Sözleşme reddedildi | AGREEMENT_REJECTED |
| Sözleşme paylaşıldı | AGREEMENT_SHARED |
| Sözleşme paylaşımdan kaldırıldı | AGREEMENT_UNSHARE |
| Sözleşme otomatik olarak paylaşımdan kaldırıldı | AGREEMENT_UNSHARE_AUTO |
| Sözleşme delege edildi | AGREEMENT_ACTION_DELEGATED |
| Sözleşme katılımcısı değiştirildi | AGREEMENT_ACTION_REPLACED_SIGNER |
| Sözleşme değiştirildi | AGREEMENT_MODIFIED |
| Sözleşmenin değiştirilmesi teyit edildi | AGREEMENT_USER_ACK_AGREEMENT_MODIFIED |
| Sözleşme e-postası görüntülendi | AGREEMENT_EMAIL_VIEWED |
| Sözleşme e-postası geri döndü | AGREEMENT_EMAIL_BOUNCED |
| Sözleşme WhatsApp mesajı geri döndü | AGREEMENT_WHATSAPP_BOUNCED |
| Sözleşme SMS'i geri döndü | AGREEMENT_SMS_BOUNCED |
| Sözleşme belgesi görüntülendi | AGREEMENT_DOCUMENTS_VIEWED |
| Belgeyi görüntülemek için bir parola uygulandığında sözleşme belgesi görüntülendi | AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED |
| Sözleşme oluşturulamadı | AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| Sözleşme çevrimdışı olay sonrasında senkronize edildi | AGREEMENT_OFFLINE_SYNC |
| Sözleşme kasaya koyuldu | AGREEMENT_VAULTED |
| Sözleşme katılımcısının sosyal kimliği doğrulandı | AGREEMENT_WEB_IDENTITY_AUTHENTICATED |
| Sözleşme katılımcısının kimliği KBA yöntemiyle doğrulandı | AGREEMENT_KBA_AUTHENTICATED |
| Sözleşme katılımcısının kimliği, E-posta ile OTP üzerinden doğrulandı |
AGREEMENT_EMAIL_OTP_AUTHENTICATED |
| Sözleşme sona erme tarihi güncellendi | AGREEMENT_EXPIRATION_UPDATED |
| Sözleşme hatırlatıcı gönderildi | AGREEMENT_REMINDER_SENT |
| İmzalayan, sözleşme imzalayan adını değiştirdi | AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER |
| Sözleşme hatırlatıcı başlatıldı | AGREEMENT_REMINDER_INITIATED |
| Sözleşme Web kancaları yalnızca API üzerinden kullanılabilir | |
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| NA |
AGREEMENT_READY_TO_NOTARIZE |
| NA |
AGREEMENT_READY_TO_VAULT |
Toplu Halde Gönder:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Toplu Hâlde Gönder tüm olaylar | MEGASIGN_ALL |
| Toplu Halde Gönder ile oluşturulanlar |
MEGASIGN_CREATED |
| Toplu Halde Gönder ile paylaşılanlar |
MEGASIGN_SHARED |
| Toplu Halde Gönder ile geri çağırılanlar |
MEGASIGN_RECALLED |
| Toplu Hâlde Gönder hatırlatıcısı gönderildi | MEGASIGN_REMINDER_SENT |
| Toplu Hâlde Gönder hatırlatıcısı başlatıldı | MEGASIGN_REMINDER_INITIATED |
Web Formları:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Web Formuyla ilgili tüm olaylar | WIDGET_ALL |
| Web Formu oluşturuldu |
WIDGET_CREATED |
| Web Formu etkinleştirildi |
WIDGET_ENABLED |
| Web Formu devre dışı bırakıldı |
WIDGET_DISABLED |
| Web Formu değiştirildi |
WIDGET_MODIFIED |
| Web Formu paylaşıldı |
WIDGET_SHARED |
| Web Formu oluşturulamadı |
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM |
Kitaplık şablonları (Yalnızca API):
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| NA | LIBRARY_DOCUMENT_ALL |
| NA | LIBRARY_DOCUMENT_CREATED |
| NA | LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| NA | LIBRARY_DOCUMENT_MODIFIED |
Bildirim Parametreleri
Bildirim Parametreleri, JSON yükünü yalnızca olayın belirli öğelerine göre özelleştirmenizi sağlar.
Örneğin Sözleşme katılımcısı değiştirildi olayında, Belge Bilgilerini dışarıda bırakarak ve web kancası URL'nize gönderilen toplam JSON boyutunu azaltarak yalnızca Sözleşme Bilgilerini ve Katılımcı Bilgilerini isteyebilirsiniz.
- Sözleşme
- Sözleşme Bilgileri: Tetikleyici olay sırasında sözleşmenin durumuna göre ayrıntılı sözleşme bilgileri.
- Sözleşme Belgesi Bilgileri: Olay sonucunda oluşturulan tüm belge bilgilerini içerir.
- Sözleşme Katılımcısı Bilgileri: Olayın bir sonucu olarak tüm katılımcı bilgilerini içerir.
- Sözleşme İmzalı Belge: İmzalanan PDF'yi sağlar.
- Sözleşme İş Akışı Tamamlandı ve Sözleşme Tüm Olaylar için geçerlidir.
- Toplu Halde Gönder
- Toplu Halde Gönder Bilgileri: Olayı tetikleyen Toplu Halde Gönder nesnesi hakkında ayrıntılı bilgiler.
- Web Formu
- Widget Bilgileri: Olayı tetikleyen web formu hakkında ayrıntılı bilgiler.
- Widget Belge Bilgileri: Web formuyla ilişkili belge bilgileri.
- Widget Katılımcı Bilgileri: Web formunda tanımlanan katılımcılar hakkında bilgiler.
Acrobat Sign ile işinizi kolaylaştırın
Belgeleri çevrimiçi olarak hızlı ve kolay şekilde yönetin ve imzalayın.