Adobe Acrobat Sign Government
Adobe, dünyanın en güvenilir dijital belge imzalama hizmetidir. Adobe Acrobat Sign ile el ile gerçekleştirilen işlemleri tamamen dijital deneyimlere dönüştürebilirsiniz. Sözleşmelerin durumunu oluşturmak, göndermek ve izlemek için Adobe Acrobat Sign işlevini sık kullandığınız uygulamalara ekleyin.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Power Apps | Standart | ABD Hükümeti (GCC) |
| İletişim | |
|---|---|
| İsim | Adobe Acrobat Sign Desteği |
| URL | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
| E-posta | support@echosign.zendesk.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Adobe Inc. |
| Web sitesi | https://acrobat.adobe.com/us/en/sign.html |
| Gizlilik ilkesi | https://www.adobe.com/privacy/policy.html |
| Kategoriler | Web sitesi |
Adobe Acrobat Sign
Adobe, dünyanın en güvenilir dijital belge imzalama hizmetidir. Adobe Acrobat Sign ile el ile gerçekleştirilen işlemleri tamamen dijital deneyimlere dönüştürebilirsiniz. Sözleşmelerin durumunu oluşturmak, göndermek ve izlemek için Adobe Acrobat Sign işlevini sık kullandığınız uygulamalara ekleyin.
Yayımcı: Adobe, Inc.
Önkoşullar
Adobe Acrobat Sign hesabı gereklidir.
Bağlayıcınızı kullanmaya başlama
Bağlayıcı kullanıcı kılavuzu https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
FAQ
Bağlayıcı kullanıcı kılavuzu https://helpx.adobe.com/sign/integrations/microsoft-powerapps-flow.html
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Belge URL'sinden kitaplık şablonu oluşturma |
Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın |
| Belge URL'sinden sözleşme oluşturma ve imza için gönderme |
Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir. |
| Belgeyi karşıya yükleme ve belge kimliğini alma |
Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir. |
| İmzalama URL'sini alma |
Bu işlem, bir sözleşmenin geçerli imzalayanları için e-imza sayfasının URL'sini alır. |
| İmzalı sözleşmenin PDF'sini alma |
Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın. |
| Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma |
Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın. |
| Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme |
Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir. |
| Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme |
Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir. |
| Sözleşmeden belge alma |
Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir. |
| Sözleşmeden tüm belge kimliklerinin listesini alma |
Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir. |
| Sözleşmenin durumunu alma |
Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir. |
| Sözleşmenin form alanı verilerini alma (Eski) [KULLANIM DIŞI] |
Sözleşmenin etkileşimli form alanlarına girilen verileri alır. |
| Sözleşmenin form alanı verilerini CSV biçiminde alma |
Sözleşmenin etkileşimli form alanlarına girilen verileri alır. |
| Sözleşmenin form alanı verilerini JSON biçiminde alma |
Sözleşmenin etkileşimli form alanlarına girilen verileri alır. |
| Sözleşmeyi iptal etme |
Yolda agreementId ile tanımlanan sözleşmeyi iptal eder. |
| Tüm kitaplık şablonlarının listesini alma |
Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir. |
| Tüm sözleşmelerin listesini alma |
Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir. |
Belge URL'sinden kitaplık şablonu oluşturma
Bu işlem, belge URL'sinden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon Adı
|
name | True | string |
Şablonu tanımlamak için kullanılan Sözleşme Adı |
|
Şablon Türü
|
templateTypes | True | array of string |
Bir veya daha fazla kitaplık şablonu türünün listesi |
|
Paylaşım Modu
|
sharingMode | True | string |
Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir |
|
URL
|
url | True | string |
Ham dosya içeriğini almak için genel olarak erişilebilir bir URL |
|
İsim
|
name | True | string |
Gönderilen belgenin özgün sistem dosya adı |
|
Türü
|
mimeType | True | string |
Başvuruda bulunılan dosyanın mime türü; örneğin, uygulama/pdf |
|
Şablon Durumu
|
state | True | string |
Kitaplık belgesinin durumu. |
Döndürülenler
Kitaplık şablonunu açıklayan bir JSON nesnesi
Belge URL'sinden sözleşme oluşturma ve imza için gönderme
Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Adı
|
name | True | string |
Sözleşmenin adı |
|
URL
|
url | True | string |
Ham dosya içeriğini almak için genel olarak erişilebilir bir URL |
|
İsim
|
name | True | string |
Gönderilen belgenin özgün sistem dosya adı |
|
Türü
|
mimeType | True | string |
Başvuruda bulunılan dosyanın mime türü; örneğin, uygulama/pdf |
|
İmza Türü
|
signatureType | True | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Katılımcı E-postası
|
True | string |
Katılımcının e-posta adresi |
|
|
Authentication
|
authenticationMethod | string |
Varsayılan kimlik doğrulaması: e-posta (Yok) |
|
|
Şifre
|
password | string |
Katılımcı için gereken parola |
|
|
Ülke Kodu
|
countryCode | string |
Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu |
|
|
Telefon No.
|
phone | string |
Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası |
|
|
Sipariş
|
order | True | integer |
1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin. |
|
Rol
|
role | True | string |
Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.). |
|
Message
|
message | string |
Alıcılara eylemlerini isteyen isteğe bağlı bir ileti |
|
|
E-posta
|
string |
Sözleşmenin BILGI e-postası |
||
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z |
|
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Anımsatıcıları ne sıklıkta göndermek istiyorsunuz? |
|
|
Belge Parolası
|
openPassword | string |
İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola |
|
|
İsim
|
fieldName | string |
Alanın adı |
|
|
Değer
|
defaultValue | string |
Alanın varsayılan değeri |
|
|
Yeniden Yönlendirme Gecikmesi
|
redirectDelay | string |
Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak). |
|
|
Yeniden yönlendirme URL'si
|
redirectUrl | string |
İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com |
|
|
İlk E-postalar
|
initEmails | string |
Sözleşme başlatma olayları için bildirim postalarını denetleme. |
Döndürülenler
Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON
Belgeyi karşıya yükleme ve belge kimliğini alma
Bu işlem, Adobe Acrobat Sign hesabınıza bir belge yükler ve bunun için bir belge kimliği döndürür. Bu belge geçici olarak Adobe Acrobat Sign'da depolanır ve belge kimliği sözleşme oluşturma gibi diğer işlemler için kullanılabilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Dosya Adı
|
File-Name | True | string |
Karşıya yüklenecek belgenin adı, uzantılı |
|
Dosya İçeriği
|
File | True | contentOnly |
Karşıya yüklenecek belgenin dosya akışı |
Döndürülenler
Karşıya yüklenen belgenin kimliğini içeren bir JSON
İmzalama URL'sini alma
Bu işlem, bir sözleşmenin geçerli imzalayanları için e-imza sayfasının URL'sini alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Sözleşmeyi oluşturan eylem tarafından sağlanan sözleşme kimliği |
Döndürülenler
- Body
- SigningUrlResponse
İmzalı sözleşmenin PDF'sini alma
Bu işlem, birleştirilmiş veya imzalanmış sözleşmenin PDF dosya akışını getirir. Dosya akışının .pdf dosya uzantısıyla biten bir dosya adıyla depolanması gerektiğini unutmayın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Sözleşmeyi oluşturan eylem tarafından sağlanan sözleşme kimliği |
|
Destekleyici Belgeler eklensin mi?
|
attachSupportingDocuments | boolean |
Doğruysa, imzalanan sözleşme PDF'sine destekleyici belgeler ekleyin |
|
|
Denetim Raporu Eklensin mi?
|
attachAuditReport | boolean |
Doğruysa, imzalanan sözleşme PDF'sine bir denetim raporu ekleyin |
Döndürülenler
Belgenin dosya akışı
- response
- CombinedDocumentResponse
Karşıya yüklenen bir belgeden kitaplık şablonu oluşturma
Bu işlem, karşıya yüklenen bir belgeden Adobe Acrobat Sign kitaplığında bir şablon oluşturur. Sözleşme göndermek için bu şablonu kullanın.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Şablon Adı
|
name | True | string |
Şablonu tanımlamak için kullanılan Sözleşme Adı |
|
Şablon Türü
|
templateTypes | True | array of string |
Bir veya daha fazla kitaplık şablonu türünün listesi |
|
Paylaşım Modu
|
sharingMode | True | string |
Bu kitaplık belgesine kimlerin erişimi olması gerektiğini belirtir |
|
Kimlik
|
transientDocumentId | True | string |
Geçici bir belge karşıya yüklenerek alınan belge kimliği |
|
Şablon Durumu
|
state | True | string |
Kitaplık belgesinin durumu. |
Döndürülenler
Kitaplık şablonunu açıklayan bir JSON nesnesi
Karşıya yüklenen bir belgeden sözleşme oluşturma ve imza için gönderme
Bu işlem, Adobe Acrobat Sign'a yüklenen bir belgeden bir sözleşme oluşturur ve imza için gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Adı
|
name | True | string |
Sözleşmenin adı |
|
Kimlik
|
transientDocumentId | True | string |
Geçici bir belge karşıya yüklenerek alınan belge kimliği |
|
İmza Türü
|
signatureType | True | string |
İstemek istediğiniz imza türü - e-imza veya yazılmış |
|
Katılımcı E-postası
|
True | string |
Katılımcının e-posta adresi |
|
|
Authentication
|
authenticationMethod | string |
Varsayılan kimlik doğrulaması: e-posta (Yok) |
|
|
Şifre
|
password | string |
Katılımcı için gereken parola |
|
|
Ülke Kodu
|
countryCode | string |
Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu |
|
|
Telefon No.
|
phone | string |
Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası |
|
|
Sipariş
|
order | True | integer |
1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin. |
|
Rol
|
role | True | string |
Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.). |
|
Message
|
message | string |
Alıcılara eylemlerini isteyen isteğe bağlı bir ileti |
|
|
E-posta
|
string |
Sözleşmenin BILGI e-postası |
||
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z |
|
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Anımsatıcıları ne sıklıkta göndermek istiyorsunuz? |
|
|
Belge Parolası
|
openPassword | string |
İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola |
|
|
İsim
|
fieldName | string |
Alanın adı |
|
|
Değer
|
defaultValue | string |
Alanın varsayılan değeri |
|
|
Yeniden Yönlendirme Gecikmesi
|
redirectDelay | string |
Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak). |
|
|
Yeniden yönlendirme URL'si
|
redirectUrl | string |
İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com |
|
|
İlk E-postalar
|
initEmails | string |
Sözleşme başlatma olayları için bildirim postalarını denetleme. |
Döndürülenler
Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON
Kitaplık şablonundan sözleşme oluşturma ve imza için gönderme
Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında depolanan bir şablondan bir sözleşme oluşturur ve imza için gönderir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Adı
|
name | True | string |
Sözleşmenin adı |
|
Template
|
libraryDocumentId | True | string |
Kitaplığınızda depolanan şablonlardan bir belge seçin |
|
İmza Türü
|
signatureType | True | string |
İstemek istediğiniz imza türü - e-imza veya yazılmış |
|
Katılımcı E-postası
|
True | string |
Katılımcının e-posta adresi |
|
|
Authentication
|
authenticationMethod | string |
Varsayılan kimlik doğrulaması: e-posta (Yok) |
|
|
Şifre
|
password | string |
Katılımcı için gereken parola |
|
|
Ülke Kodu
|
countryCode | string |
Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu |
|
|
Telefon No.
|
phone | string |
Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası |
|
|
Sipariş
|
order | True | integer |
1 ile başlayan ve imzalama grubunun imzalaması gereken konumu gösteren dizin. |
|
Rol
|
role | True | string |
Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.). |
|
Message
|
message | string |
Alıcılara eylemlerini isteyen isteğe bağlı bir ileti |
|
|
E-posta
|
string |
Sözleşmenin BILGI e-postası |
||
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği süre. Örnek: 2020-12-31T23:59:00Z |
|
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Anımsatıcıları ne sıklıkta göndermek istiyorsunuz? |
|
|
Belge Parolası
|
openPassword | string |
İmzalanan sözleşme PDF'sini şifrelemek için kullanılması gereken parola |
|
|
İsim
|
fieldName | string |
Alanın adı |
|
|
Değer
|
defaultValue | string |
Alanın varsayılan değeri |
|
|
Yeniden Yönlendirme Gecikmesi
|
redirectDelay | string |
Kullanıcı başarı sayfasına alınmadan önceki gecikme (saniye olarak). |
|
|
Yeniden yönlendirme URL'si
|
redirectUrl | string |
İmzalama işlemini tamamladıktan sonra yeniden yönlendirme url'si, örneğin. https://adobe.com |
|
|
İlk E-postalar
|
initEmails | string |
Sözleşme başlatma olayları için bildirim postalarını denetleme. |
Döndürülenler
Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON
Sözleşmeden belge alma
Bu işlem, sözleşmenin belirli bir belgesinin dosya akışını getirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Belgesi gereken sözleşmenin sözleşme kimliği |
|
Belge Kimliği
|
documentId | True | string |
Sözleşmenin belirli bir belgesinin belge kimliği |
Döndürülenler
Belgenin dosya akışı
- response
- DocumentResponse
Sözleşmeden tüm belge kimliklerinin listesini alma
Bu işlem, bir sözleşmenin tüm belgelerinin ve destekleyici belgelerinin kimliklerini getirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Belgeleri gereken sözleşmenin sözleşme kimliği |
|
Destekleyici belgeler - İçerik Türü
|
supportingDocumentContentFormat | string |
Sözleşmenin destekleyici belgelerinin içerik türü |
Döndürülenler
Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri
- Body
- AgreementDocumentsV6
Sözleşmenin durumunu alma
Bu işlem, durum gibi bir sözleşmenin tüm geçerli bilgilerini getirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Bilgileri gereken sözleşmenin sözleşme kimliği |
Döndürülenler
Tam Sözleşme Ayrıntıları
- Body
- AgreementInfoV6
Sözleşmenin form alanı verilerini alma (Eski) [KULLANIM DIŞI]
Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Bilgileri gereken sözleşmenin sözleşme kimliği |
Döndürülenler
- response
- file
Sözleşmenin form alanı verilerini CSV biçiminde alma
Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Bilgileri gereken sözleşmenin sözleşme kimliği |
Döndürülenler
Form Verilerinin içeriği
- Form Veri İçeriği
- binary
Sözleşmenin form alanı verilerini JSON biçiminde alma
Sözleşmenin etkileşimli form alanlarına girilen verileri alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
Bilgileri gereken sözleşmenin sözleşme kimliği |
Döndürülenler
Form Verilerinin içeriği
- Form Veri İçeriği
- object
Sözleşmeyi iptal etme
Yolda agreementId ile tanımlanan sözleşmeyi iptal eder.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sözleşme Kimliği
|
agreementId | True | string |
İptal edilecek sözleşmenin sözleşme kimliği. |
|
Yeşillik Durumu
|
state | string |
Sözleşmenin inmesi gereken eyalet. |
|
|
Comment
|
comment | string |
Alıcılara iptal nedenini açıklayan isteğe bağlı bir açıklama. |
|
|
Diğer
|
notifyOthers | boolean |
Alıcıların bilgilendirilmesini isteyip istemediğiniz. |
Tüm kitaplık şablonlarının listesini alma
Bu işlem, kullanıcının Adobe Acrobat Sign kitaplığında şablon olarak depolanan tüm belgelerin listesini getirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Sayfalarda gezinmek için kullanılır. Sağlanmadıysa, ilk sayfayı döndürür. |
|
|
Sayfa Boyutu
|
pageSize | integer |
Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 100; Maksimum: 10000 |
Döndürülenler
Kitaplık şablonu dizi nesnesini içeren bir JSON
- Body
- LibraryDocuments
Tüm sözleşmelerin listesini alma
Bu işlem, kullanıcının tüm sözleşmelerinin listesini getirir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Sayfalarda gezinmek için kullanılır. Sağlanmadıysa, ilk sayfayı döndürür. |
|
|
Sayfa Boyutu
|
pageSize | integer |
Yanıt sayfasındaki öğe sayısı. Varsayılan olarak: 100; Maksimum: 10000 |
Döndürülenler
Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON
- Body
- userAgreementListV6
Tetikleyiciler
| Bir katılımcıya sözleşme gönderildiğinde |
Bir katılımcıya sözleşme gönderildiğinde yeni bir akış tetikler. |
| Bir olay oluştuğunda |
Bir olay gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega İşaret ve Pencere Öğesi olaylarını kapsar. |
| Bir sözleşme iş akışı başarıyla tamamlandığında |
Sözleşme iş akışı başarıyla tamamlandığında yeni bir akışı tetikler |
| Bir sözleşmenin durumu değiştiğinde |
Sözleşmenin durumu değiştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar. |
| Yeni bir sözleşme oluşturulduğunda |
Yeni bir anlaşma oluşturulduğunda yeni bir akış tetikler. |
Bir katılımcıya sözleşme gönderildiğinde
Bir katılımcıya sözleşme gönderildiğinde yeni bir akış tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İsim
|
name | True | string |
Tetikleyicinin adı |
|
Scope
|
scope | True | string |
Tetikleyicinin kapsamı |
|
Sözleşme Adı/Kimliği
|
resourceId | string |
Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Akışın tetiklenmesi gereken olaylar |
|
Sözleşme Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme KatılımcıSı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme Belge Bilgileri eklensin mi?
|
includeDocumentsInfo | boolean |
Sözleşme belgesi bilgileri bildirimde gönderilsin mi? |
Döndürülenler
- Body
- WebhookPayload
Bir olay oluştuğunda
Bir olay gerçekleştiğinde yeni bir akış tetikler. Tüm Sözleşme, Mega İşaret ve Pencere Öğesi olaylarını kapsar.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İsim
|
name | True | string |
Tetikleyicinin adı |
|
Scope
|
scope | True | string |
Tetikleyicinin kapsamı |
|
Kaynak Türü
|
resourceType | string |
Yalnızca "Kapsam" "Belirli bir kaynak" olduğunda belirtin. Akışın tetiklenmesi gereken kaynak türünü seçin. |
|
|
Kaynak Kimliği
|
resourceId | string |
Yalnızca "Kapsam" "Belirli bir kaynak" olduğunda belirtin. Akışın tetiklenmesi gereken sözleşmeyi veya mega işareti veya pencere öğesi kimliğini girin. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Akışın tetiklenmesi gereken olaylar |
|
Sözleşme Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme KatılımcıSı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme Belge Bilgileri eklensin mi?
|
includeDocumentsInfo | boolean |
Sözleşme belgesi bilgileri bildirimde gönderilsin mi? |
|
|
Sözleşme İmzalı Belge Bilgileri eklensin mi?
|
includeSignedDocuments | boolean |
Sözleşme tamamlandıktan sonra imzalanan belgenin son kopyası bildirimde gönderilmeli mi? |
|
|
MegaSign Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı mega işareti bilgileri bildirimde gönderilmeli mi? |
|
|
Pencere Öğesi Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı pencere öğesi bilgileri bildirimde gönderilmeli mi? |
|
|
Pencere Öğesi Katılımcı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Pencere öğesi katılımcı bilgileri bildirimde gönderilsin mi? |
|
|
Pencere Öğesi Belgeleri Bilgileri eklensin mi?
|
includeDocumentsInfo | boolean |
Pencere öğesi belge bilgileri bildirimde gönderilsin mi? |
Döndürülenler
Bir sözleşme iş akışı başarıyla tamamlandığında
Sözleşme iş akışı başarıyla tamamlandığında yeni bir akışı tetikler
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İsim
|
name | True | string |
Tetikleyicinin adı |
|
Scope
|
scope | True | string |
Tetikleyicinin kapsamı |
|
Sözleşme Adı/Kimliği
|
resourceId | string |
Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Akışın tetiklenmesi gereken olaylar |
|
Sözleşme Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme KatılımcıSı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme Belge Bilgileri eklensin mi?
|
includeDocumentsInfo | boolean |
Sözleşme belgesi bilgileri bildirimde gönderilsin mi? |
|
|
Sözleşme İmzalı Belge Bilgileri eklensin mi?
|
includeSignedDocuments | boolean |
Sözleşme tamamlandıktan sonra imzalanan belgenin son kopyası bildirimde gönderilmeli mi? |
Döndürülenler
Bir sözleşmenin durumu değiştiğinde
Sözleşmenin durumu değiştiğinde yeni bir akış tetikler. Oluşturma, tamamlama vb. gibi en yaygın Sözleşme olaylarını kapsar.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İsim
|
name | True | string |
Tetikleyicinin adı |
|
Scope
|
scope | True | string |
Tetikleyicinin kapsamı |
|
Sözleşme Adı/Kimliği
|
resourceId | string |
Yalnızca "Kapsam" "Belirli bir sözleşme" olduğunda belirtin. Listeden bir sözleşme seçin veya sözleşme kimliğini girin. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
Akışın tetiklenmesi gereken olaylar |
|
Sözleşme Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme KatılımcıSı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme Belge Bilgileri eklensin mi?
|
includeDocumentsInfo | boolean |
Sözleşme belgesi bilgileri bildirimde gönderilsin mi? |
|
|
Sözleşme İmzalı Belge Bilgileri eklensin mi?
|
includeSignedDocuments | boolean |
İmzalanan belgenin son kopyası, sözleşmenin tamamlanmasının bildiriminde gönderilmeli mi? |
Döndürülenler
Yeni bir sözleşme oluşturulduğunda
Yeni bir anlaşma oluşturulduğunda yeni bir akış tetikler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İsim
|
name | True | string |
Tetikleyicinin adı |
|
Scope
|
scope | True | string |
Tetikleyicinin kapsamı |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
Akışın tetiklenmesi gereken olaylar |
|
Sözleşme Bilgileri eklensin mi?
|
includeDetailedInfo | boolean |
Ayrıntılı sözleşme bilgileri bildirimde gönderilmeli mi? |
|
|
Sözleşme KatılımcıSı Bilgileri eklensin mi?
|
includeParticipantsInfo | boolean |
Sözleşme katılımcısı bilgileri bildirimde gönderilmeli mi? |
Döndürülenler
Tanımlar
AgreementCreationResponseV6
Yeni oluşturulan sözleşmenin kimliğini içeren bir JSON
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sözleşme Kimliği
|
id | string |
Durumu sorgulamak ve imzalı belgeleri indirmek için kullanılabilecek sözleşmenin benzersiz kimliği |
AgreementDocumentsV6
Hem belgeleri hem de destekleyici belgeleri içeren bir JSON dizi nesneleri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Documents
|
documents | array of DocumentV6 |
Belgeleri temsil eden nesnelerin listesi |
|
Destekleyici Belgeler
|
supportingDocuments | array of SupportingDocumentV6 |
Destekleyici belgelerin listesi. Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür |
AgreementInfoV6
Tam Sözleşme Ayrıntıları
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Sözleşme Kimliği
|
id | string |
Sözleşmeyi benzersiz olarak tanımlamak için kullanılabilecek benzersiz bir kimlik |
|
Oluşturulma Tarihi
|
createdDate | date |
Sözleşmenin oluşturulduğu tarih |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Anımsatıcıları ne sıklıkta göndermek istiyorsunuz? |
|
Bitiş Tarihi
|
expiration | date |
Sözleşmenin imzalanamayacakları tarih |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkilendirilmiş yerel ayar ; örneğin, en_US veya fr_FR |
|
Message
|
message | string |
Gönderenin sağladığı sözleşmeyle ilişkili ileti |
|
Sözleşme Adı
|
name | string |
Gönderen tarafından belirtilen sözleşmenin adı |
|
Belge Görünürlüğü mü?
|
documentVisibilityEnabled | boolean |
Belge görünürlüğü etkinleştirildi mi? |
|
Katılımcı Kümeleri
|
participantSetsInfo | array of ParticipantSetInfoV6 |
Bu belgenin tüm katılımcı kümeleri hakkında bilgi |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Güvenlik Seçenekleri
|
securityOptions | string |
Belgeyi görüntülemek ve imzalamak için parola gerekip gerekmediğini belirten güvenlik bilgileri |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Gönderen E-postası
|
senderEmail | string |
Gönderenin e-postası |
|
İş Akışı Kimliği
|
workflowId | string |
Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği. |
|
Ccs
|
ccs | array of CcInfo |
Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi. |
CombinedDocumentResponse
DisplayUserInfo
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Şirket
|
company | string |
Varsa, kullanıcının şirketinin adını görüntüler |
|
E-posta
|
string |
Kullanıcının e-postasını görüntüler |
|
|
Adı ve Soyadı
|
fullName | string |
Varsa kullanıcının tam adını görüntüler. |
DisplayUserSetInfo
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kullanıcı Kümesi Bilgilerini Görüntüle
|
displayUserSetMemberInfos | array of DisplayUserInfo |
Kullanıcı kümesi hakkındaki bilgileri görüntüler |
|
Kullanıcı Kümesi Adını Görüntüle
|
displayUserSetName | string |
DocumentV6
Belge hakkındaki bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Belge Kimliği
|
id | string |
Belgenin benzersiz kimliği |
|
Mime Türü
|
mimeType | string |
Belgenin Mime türü |
|
İsim
|
name | string |
Belgenin adı |
|
Sayı Sayfaları
|
numPages | integer |
Belgedeki sayfa sayısı |
DocumentResponse
ParticipantSetInfoV6
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Katılımcı Kümesi Üye Bilgileri
|
memberInfos | array of MemberInfosV6 |
Alıcı kümesinin üyeleri hakkında bilgi |
|
Sipariş
|
order | integer |
İmzalama grubunun imzalaması gereken konumu gösteren dizin. |
|
Rol
|
role | string |
Katılımcı kümesinin geçerli rolleri (imzalayan, onaylayan vb.). |
|
Katılımcı Kümesi Adı
|
name | string |
Katılımcı kümesinin adı |
|
Katılımcı Kümesi Özel Dağınıklığı
|
privateMessage | string |
Kümedeki katılımcılar için özel ileti |
|
Katılımcı Kümesi Görünür Sayfalar
|
visiblePages | array of string |
Katılımcı kümesi tarafından görülebilen sayfalar |
MemberInfosV6
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Katılımcı E-postası
|
string |
Katılımcının e-posta adresi |
|
|
Authentication
|
securityOption.authenticationMethod | string |
Varsayılan kimlik doğrulaması: e-posta (Yok) |
|
Şifre
|
securityOption.password | string |
Katılımcı için gereken parola |
|
Ülke Kodu
|
securityOption.phoneInfo.countryCode | string |
Belgeyi görüntülemek ve imzalamak için gereken alıcının telefon ülke kodu |
|
Telefon No.
|
securityOption.phoneInfo.phone | string |
Sözleşmeyi görüntülemek ve imzalamak için gereken alıcının telefon numarası |
SigningUrl
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İmza URL'si için e-posta
|
string |
Bu imzalama URL'si ile ilişkili imzalayanın e-posta adresi |
|
|
İMZA URL'si
|
esignUrl | string |
Bu imzalama URL'si ile ilişkili imzalayanın URL adresi |
SigningUrlResponse
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İmzalayan kümeleri için URL dizisi
|
signingUrlSetInfos | array of SigningUrlSetInfo |
bu sözleşmede yer alan imzalayan kümeleri için bir url dizisi |
SigningUrlSetInfo
| Name | Yol | Tür | Description |
|---|---|---|---|
|
- İmzalama URL Dizisi
|
signingUrls | array of SigningUrl |
Geçerli imzalayan kümesi için url dizisi |
|
- İMZA URL'si kümesi adı
|
signingUrlSetName | string |
Geçerli imzalayan kümesinin adı |
SupportingDocumentV6
Destekleyici belge hakkındaki bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Destekleyici Belge Adı
|
displayLabel | string |
Destekleyici belgenin görünen adı |
|
Destekleyici Belge Alan Adı
|
fieldName | string |
Destekleyici belge alanının adı |
|
Destekleyici Belge Mime Türü
|
mimeType | string |
Destekleyici belgenin Mime türü |
|
Belge Sayfalarını Destekleme
|
numPages | integer |
Destekleyici belgedeki sayfa sayısı |
|
Destekleyici Belge Kimliği
|
id | string |
Destekleyici belgeyi temsil eden benzersiz kimlik |
TransientDocumentResponse
Karşıya yüklenen belgenin kimliğini içeren bir JSON
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Belge Kimliği
|
transientDocumentId | string |
Karşıya yüklenen belgenin belge kimliği |
UserAgreementV6
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kullanıcı Kümesi Bilgilerini Görüntüle
|
displayParticipantSetInfos | array of DisplayUserSetInfo |
Sözleşme için en uygun kullanıcı kümesi. Sözleşme geçerli kullanıcıdan geliyorsa genellikle bir sonraki imzalayandır veya başka bir kullanıcıdan alınmışsa gönderendir |
|
Görüntüleme Tarihi
|
displayDate | string |
Sözleşmenin görüntüleme tarihi |
|
Esign
|
esign | boolean |
Bu bir e-imza belgesiyse True |
|
Gizli
|
hidden | boolean |
Kullanıcı için sözleşme gizliyse true |
|
Grup Kimliği
|
groupId | string |
Grubun benzersiz tanımlayıcısı |
|
En Son Sürüm Kimliği
|
latestVersionId | string |
Sözleşmenin geçerli sürümünü benzersiz olarak tanımlayan sürüm kimliği |
|
İsim
|
name | string |
Sözleşmenin Adı |
|
Üst Kimlik
|
parentId | string |
MegaSign alt öğesinin üst kimliği VEYA pencere öğesi sözleşmesi örneğinin kaynak kimliği |
|
Sözleşme Kimliği
|
id | string |
Sözleşmenin benzersiz tanımlayıcısı |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Türü
|
type | string |
Sözleşme türü |
userAgreementListV6
Kullanıcı sözleşmesi dizi nesnesini içeren bir JSON
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | page |
Yanıtta gezinmek için sayfalandırma bilgileri |
|
Sözleşme Listesi
|
userAgreementList | array of UserAgreementV6 |
Sözleşme öğeleri dizisi |
page
Yanıtta gezinmek için sayfalandırma bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
nextCursor
|
nextCursor | string |
Sonraki sayfaya gitmek için kullanılır. Döndürülmezse başka sayfa yoktur. |
Web KancasıPayload
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Event
|
event | string |
Kaynakta gerçekleşen olay. |
|
Olay Tarihi
|
eventDate | date |
Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder |
|
Olay Kaynak Türü
|
eventResourceType | string |
Olayın gerçekleştiği kaynak. |
|
Sözleşme Üst Türü
|
eventResourceParentType | string |
Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Pencere Öğesi veya Mega İşaret |
|
Sözleşme Üst Kimliği
|
eventResourceParentId | string |
Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği |
|
Olay Katılımcısı Rolü
|
participantRole | string |
Etkinlik katılımcısının rolü. |
|
Olay Katılımcısı Kimliği
|
participantUserId | string |
Etkinliğin katılımcısının kimliği. |
|
Olay Katılımcısı E-postası
|
participantUserEmail | string |
Katılımcının etkinlik için e-posta adresi. |
|
Olay EylemLi Kullanıcı Kimliği
|
actingUserId | string |
Olayı oluşturan kullanıcının kimliği. |
|
Olay Eylemli Kullanıcı E-postası
|
actingUserEmail | string |
Olayı oluşturan kullanıcının e-postası. |
|
Olay EylemLi Kullanıcı IP Adresi
|
actingUserIpAddress | string |
Olayı oluşturan kullanıcının IP adresi |
|
Kullanıcı Kimliği Başlatan Olay
|
initiatingUserId | string |
Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği. |
|
Kullanıcı E-postası Başlatma Olayı
|
initiatingUserEmail | string |
Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası. |
|
Bildirime Uygun Kullanıcılar
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Bu bildirimin geçerli olduğu kullanıcıların listesi |
|
Agreement
|
agreement | WebhookAgreementInfo |
Sözleşmenin tam bilgileri |
ApplicableUsers
Bu bildirimin geçerli olduğu kullanıcılar hakkındaki bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Bildirime Uygun Kullanıcı Kimliği
|
id | string |
Bu bildirimin geçerli olduğu kullanıcının benzersiz kimliği |
|
Bildirime Uygun Kullanıcı E-postası
|
string |
Bu bildirimin geçerli olduğu kullanıcının e-posta adresi |
|
|
Bildirime Uygun Kullanıcı Rolü
|
role | string |
Bu bildirimin oluşturulduğu iş akışındaki kullanıcının rolü |
|
Yük Geçerli Kullanıcı mı?
|
payloadApplicable | boolean |
Bu bildirimde sağlanan verilerin bu kullanıcı için geçerli olup olmadığı |
WebhookPayloadWithoutNextParticipantSet
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Event
|
event | string |
Kaynakta gerçekleşen olay. |
|
Olay Tarihi
|
eventDate | date |
Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder |
|
Olay Kaynak Türü
|
eventResourceType | string |
Olayın gerçekleştiği kaynak. |
|
Sözleşme Üst Türü
|
eventResourceParentType | string |
Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Pencere Öğesi veya Mega İşaret |
|
Sözleşme Üst Kimliği
|
eventResourceParentId | string |
Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği |
|
Olay Katılımcısı Kimliği
|
participantUserId | string |
Etkinliğin katılımcısının kimliği. |
|
Olay Katılımcısı E-postası
|
participantUserEmail | string |
Katılımcının etkinlik için e-posta adresi. |
|
Olay EylemLi Kullanıcı Kimliği
|
actingUserId | string |
Olayı oluşturan kullanıcının kimliği. |
|
Olay Eylemli Kullanıcı E-postası
|
actingUserEmail | string |
Olayı oluşturan kullanıcının e-postası. |
|
Olay EylemLi Kullanıcı IP Adresi
|
actingUserIpAddress | string |
Olayı oluşturan kullanıcının IP adresi |
|
Kullanıcı Kimliği Başlatan Olay
|
initiatingUserId | string |
Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği |
|
Kullanıcı E-postası Başlatma Olayı
|
initiatingUserEmail | string |
Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası. |
|
Bildirime Uygun Kullanıcılar
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Bu bildirimin geçerli olduğu kullanıcıların listesi |
|
Agreement
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
Sözleşmenin tam bilgileri |
WebhookPayloadWithSignedDocumentForStatusChange
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Event
|
event | string |
Kaynakta gerçekleşen olay. |
|
Olay Tarihi
|
eventDate | date |
Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder |
|
Alt Olay
|
subEvent | string |
Bir kaynakta gerçekleşen alt olay. |
|
Sözleşme Üst Türü
|
eventResourceParentType | string |
Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Pencere Öğesi veya Mega İşaret |
|
Sözleşme Üst Kimliği
|
eventResourceParentId | string |
Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği |
|
Olay Katılımcısı Kimliği
|
participantUserId | string |
Etkinliğin katılımcısının kimliği. |
|
Olay Katılımcısı E-postası
|
participantUserEmail | string |
Katılımcının etkinlik için e-posta adresi. |
|
Olay EylemLi Kullanıcı Kimliği
|
actingUserId | string |
Olayı oluşturan kullanıcının kimliği. |
|
Olay Eylemli Kullanıcı E-postası
|
actingUserEmail | string |
Olayı oluşturan kullanıcının e-postası. |
|
Olay EylemLi Kullanıcı IP Adresi
|
actingUserIpAddress | string |
Olayı oluşturan kullanıcının IP adresi |
|
Eylem Türü
|
actionType | string |
Olayın gerçekleştiği eylem. |
|
Kullanıcı Kimliği Başlatan Olay
|
initiatingUserId | string |
Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği |
|
Kullanıcı E-postası Başlatma Olayı
|
initiatingUserEmail | string |
Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası. |
|
Olay Kaynak Türü
|
eventResourceType | string |
Olayın gerçekleştiği kaynak. |
|
Olay Katılımcısı Rolü
|
participantRole | string |
Etkinlik katılımcısının rolü. |
|
Bildirime Uygun Kullanıcılar
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Bu bildirimin geçerli olduğu kullanıcıların listesi |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
Sözleşmenin tam bilgileri |
WebhookPayloadWithSignedDocument
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Event
|
event | string |
Kaynakta gerçekleşen olay. |
|
Olay Tarihi
|
eventDate | date |
Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder |
|
Sözleşme Üst Türü
|
eventResourceParentType | string |
Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Pencere Öğesi veya Mega İşaret |
|
Sözleşme Üst Kimliği
|
eventResourceParentId | string |
Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği |
|
Olay Kaynak Türü
|
eventResourceType | string |
Olayın gerçekleştiği kaynak. |
|
Olay Katılımcısı Rolü
|
participantRole | string |
Etkinlik katılımcısının rolü. |
|
Olay Katılımcısı Kimliği
|
participantUserId | string |
Etkinliğin katılımcısının kimliği. |
|
Olay Katılımcısı E-postası
|
participantUserEmail | string |
Katılımcının etkinlik için e-posta adresi. |
|
Olay EylemLi Kullanıcı Kimliği
|
actingUserId | string |
Olayı oluşturan kullanıcının kimliği. |
|
Olay Eylemli Kullanıcı E-postası
|
actingUserEmail | string |
Olayı oluşturan kullanıcının e-postası. |
|
Olay EylemLi Kullanıcı IP Adresi
|
actingUserIpAddress | string |
Olayı oluşturan kullanıcının IP adresi |
|
Kullanıcı Kimliği Başlatan Olay
|
initiatingUserId | string |
Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği |
|
Kullanıcı E-postası Başlatma Olayı
|
initiatingUserEmail | string |
Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası. |
|
Bildirime Uygun Kullanıcılar
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Bu bildirimin geçerli olduğu kullanıcıların listesi |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
Sözleşmenin tam bilgileri |
Web KancasıPayloadGeneric
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Event
|
event | string |
Kaynakta gerçekleşen olay. |
|
Olay Tarihi
|
eventDate | date |
Olayın tarihi. Biçim yyyy-MM-dd'T'HH:mm:ssZ olacaktır. Örneğin, örneğin 2016-02-25T18:46:19Z UTC saatini temsil eder |
|
Alt Olay
|
subEvent | string |
Bir kaynakta gerçekleşen alt olay. |
|
Sözleşme Üst Türü
|
eventResourceParentType | string |
Sözleşmenin oluşturulduğu kaynakla ilgili bilgiler. Olası değerler: Pencere Öğesi veya Mega İşaret |
|
Sözleşme Üst Kimliği
|
eventResourceParentId | string |
Bu sözleşmenin oluşturulduğu kaynağın Benzersiz Kimliği |
|
Olay Kaynak Türü
|
eventResourceType | string |
Olayın gerçekleştiği kaynak. |
|
Olay Katılımcısı Rolü
|
participantRole | string |
Etkinlik katılımcısının rolü. |
|
Olay Katılımcısı Kimliği
|
participantUserId | string |
Etkinliğin katılımcısının kimliği. |
|
Olay Katılımcısı E-postası
|
participantUserEmail | string |
Katılımcının etkinlik için e-posta adresi. |
|
Olay EylemLi Kullanıcı Kimliği
|
actingUserId | string |
Olayı oluşturan kullanıcının kimliği. |
|
Olay Eylemli Kullanıcı E-postası
|
actingUserEmail | string |
Olayı oluşturan kullanıcının e-postası. |
|
Kullanıcı Kimliği Başlatan Olay
|
initiatingUserId | string |
Olayı eyleme geçen kullanıcı adına başlatan kullanıcının kimliği |
|
Kullanıcı E-postası Başlatma Olayı
|
initiatingUserEmail | string |
Olayı yürüten kullanıcı adına başlatan kullanıcının e-postası. |
|
Eylem Türü
|
actionType | string |
Olayın gerçekleştiği eylem. |
|
Olay EylemLi Kullanıcı IP Adresi
|
actingUserIpAddress | string |
Olayı oluşturan kullanıcının IP adresi |
|
Bildirime Uygun Kullanıcılar
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Bu bildirimin geçerli olduğu kullanıcıların listesi |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
Sözleşmenin tam bilgileri |
|
Mega İşareti
|
megaSign | WebhookMegaSignInfo |
Mega işaretinin tam bilgileri |
|
Widget
|
widget | WebhookWidgetInfo |
Pencere öğesinin tam bilgileri |
WebhookAgreementInfo
Sözleşmenin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Sözleşmenin benzersiz kimliği |
|
İsim
|
name | string |
Sözleşmenin adı |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Ccs
|
ccs | array of CcInfo |
Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi. |
|
Oluşturma Tarihi
|
createdDate | date |
Sözleşmenin oluşturulduğu tarih |
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği ve imzalanması gereken süre |
|
Dış Kimlik
|
externalId.id | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
Dış Grup
|
externalId.group | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkili yerel ayar |
|
Message
|
message | string |
Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti |
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır |
|
Gönderen E-postası
|
senderEmail | string |
Sözleşme gönderenin e-postası |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
Belge Görünürlüğü mü?
|
documentVisibilityEnabled | boolean |
Belge görünürlüğü etkin mi? |
|
İş Akışı Kimliği
|
workflowId | string |
Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği. |
|
İmza Sonrası Yeniden Yönlendirme Url'si
|
postSignOption.redirectUrl | string |
İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL |
|
Katılımcı Kümeleri
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Katılımcı bilgileri ayarlar |
|
Sonraki Katılımcı Kümeleri
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Sonraki katılımcı bilgileri ayarlar |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Belgeleri temsil eden nesnelerin listesi |
|
Destekleyici Belgeler
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Destekleyici belgelerin listesi |
WebhookAgreementInfoWithoutNextParticipantSet
Sözleşmenin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Sözleşmenin benzersiz kimliği |
|
İsim
|
name | string |
Sözleşmenin adı |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Ccs
|
ccs | array of CcInfo |
Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi. |
|
Oluşturma Tarihi
|
createdDate | date |
Sözleşmenin oluşturulduğu tarih |
|
Belge Görünürlüğü mü?
|
documentVisibilityEnabled | boolean |
Belge görünürlüğü etkin mi? |
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği ve imzalanması gereken süre |
|
Dış Kimlik
|
externalId.id | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
Dış Grup
|
externalId.group | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkili yerel ayar |
|
Message
|
message | string |
Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti |
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır |
|
Gönderen E-postası
|
senderEmail | string |
Sözleşme gönderenin e-postası |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
İmza Sonrası Yeniden Yönlendirme Url'si
|
postSignOption.redirectUrl | string |
İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL |
|
İş Akışı Kimliği
|
workflowId | string |
Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği. |
|
Katılımcı Kümeleri
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Katılımcı bilgileri ayarlar |
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
Sözleşmenin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Sözleşmenin benzersiz kimliği |
|
İsim
|
name | string |
Sözleşmenin adı |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Ccs
|
ccs | array of CcInfo |
Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi. |
|
Oluşturma Tarihi
|
createdDate | date |
Sözleşmenin oluşturulduğu tarih |
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği ve imzalanması gereken süre |
|
Dış Kimlik
|
externalId.id | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
Dış Grup
|
externalId.group | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkili yerel ayar |
|
Message
|
message | string |
Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti |
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır |
|
İmza Sonrası Yeniden Yönlendirme Url'si
|
postSignOption.redirectUrl | string |
İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL |
|
İş Akışı Kimliği
|
workflowId | string |
Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği. |
|
Gönderen E-postası
|
senderEmail | string |
Sözleşme gönderenin e-postası |
|
Belge Görünürlüğü mü?
|
documentVisibilityEnabled | boolean |
Belge görünürlüğü etkin mi? |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
Katılımcı Kümeleri
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Katılımcı bilgileri ayarlar |
|
Sonraki Katılımcı Kümeleri
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
Sonraki katılımcı bilgileri ayarlar |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Belgeleri temsil eden nesnelerin listesi |
|
Destekleyici Belgeler
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Destekleyici belgelerin listesi Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür |
|
İmzalı Belge Bilgileri
|
signedDocumentInfo.document | string |
İmzalanan belgenin base64 kodlanmış dizesi |
WebhookAgreementInfoWithSignedDocument
Sözleşmenin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Sözleşmenin benzersiz kimliği |
|
İsim
|
name | string |
Sözleşmenin adı |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Statü
|
status | string |
Sözleşmenin geçerli durumu |
|
Ccs
|
ccs | array of CcInfo |
Sözleşme işleminde kopyalanacak bir veya daha fazla CC'nin listesi |
|
Oluşturma Tarihi
|
createdDate | date |
Sözleşmenin oluşturulduğu tarih |
|
Belge Görünürlüğü mü?
|
documentVisibilityEnabled | boolean |
Belge görünürlüğü etkin mi? |
|
Süre Sonu Süresi
|
expirationTime | string |
Sözleşmenin sona erdiği ve imzalanması gereken süre |
|
Dış Kimlik
|
externalId.id | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
Dış Grup
|
externalId.group | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkili yerel ayar |
|
Message
|
message | string |
Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti |
|
Anımsatıcı Sıklığı
|
reminderFrequency | string |
Katılımcılara ne sıklıkta anımsatıcı göndermek istediğinizi ayarlayan isteğe bağlı parametre. Belirtilmezse, hesap için ayarlanan varsayılan sıklık kullanılır |
|
Gönderen E-postası
|
senderEmail | string |
Sözleşme gönderenin e-postası |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
İmza Sonrası Yeniden Yönlendirme Url'si
|
postSignOption.redirectUrl | string |
İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL |
|
İş Akışı Kimliği
|
workflowId | string |
Bir sözleşmenin yönlendirme yolunu tanımlayan özel iş akışının kimliği. |
|
Katılımcı Kümeleri
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
Katılımcı bilgileri ayarlar |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Belgeleri temsil eden nesnelerin listesi |
|
Destekleyici Belgeler
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Destekleyici belgelerin listesi Bu, yalnızca sözleşmede herhangi bir destekleyici belge varsa döndürülür |
|
İmzalı Belge Bilgileri
|
signedDocumentInfo.document | string |
İmzalanan belgenin base64 kodlanmış dizesi |
WebhookMegaSignInfo
Mega işaretinin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Megasign'ın benzersiz kimliği |
|
İsim
|
name | string |
Megasign'ın adı |
|
Statü
|
status | string |
Megasign'ın durumu |
|
Ccs
|
ccs | array of MegaSignCcInfo |
Bu megasign üzerinde kopyalamak istediğiniz bir veya daha fazla e-posta adresinin listesi. |
|
Dış Kimlik
|
externalId.id | string |
Sisteminizden rastgele bir değer; gönderme zamanında belirtilebilir ve daha sonra döndürülebilir veya sorgulanabilir |
|
İlk Anımsatıcı Gecikmesi
|
firstReminderDelay | integer |
İlk anımsatıcıyı göndermeden önce saat cinsinden gecikmeyi belirten tamsayı. |
|
Locale
|
locale | string |
Bu sözleşmeyle ilişkili yerel ayar |
|
Message
|
message | string |
Katılımcılara gönderilenleri veya imzalarının neden gerekli olduğunu açıklayan isteğe bağlı bir ileti |
|
İmza Sonrası Yeniden Yönlendirme Url'si
|
postSignOption.redirectUrl | string |
İmzalama işlemi başarıyla tamamlandıktan sonra kullanıcının gönderileceği genel olarak erişilebilir bir URL |
|
Gönderen E-postası
|
senderEmail | string |
Megasign oluşturucusunun e-posta adresi |
|
İmza Türü
|
signatureType | string |
İstenen İmza türünü belirtir - E-imza veya Yazılı |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
Çocuk Sözleşmeleri Dosya Bilgileri
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
MegaSign'ın çocuk sözleşmesine göre bilgilerini içeren dosya bilgileri. |
WebhookWidgetInfo
Pencere öğesinin tam bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Pencere öğesinin benzersiz kimliği |
|
İsim
|
name | string |
Pencere öğesinin adı |
|
Statü
|
status | string |
Pencere öğesinin durumu |
|
Kimlik Doğrulama Hatası Bilgileri
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
Pencere öğesi imzalayanın kimlik doğrulaması başarısız olduktan sonra alınacağı hata sayfasının URL'si ve ilişkili özellikleri |
|
Ccs
|
ccs | array of WidgetCcInfo |
Bu pencere öğesinde kopyalamak istediğiniz bir veya daha fazla e-posta adresinin listesi. |
|
Oluşturma Tarihi
|
createdDate | date |
Pencere öğesinin oluşturulduğu tarih |
|
Tamamlama Bilgileri
|
completionInfo | WidgetCompletionRedirectionInfo |
Pencere öğesinde istenen eylem gerçekleştirildikten sonra pencere öğesi imzalayanın gerçekleştirileceği başarı sayfasının URL'si ve ilişkili özellikleri |
|
Oluşturucu E-postası
|
creatorEmail | string |
Pencere öğesini oluşturanın e-postası |
|
Kasa Etkinleştirildi mi?
|
vaultingInfo.enabled | boolean |
Belge kasası için ayarlanan hesaplar ve sözleşmeye göre etkinleştirme seçeneği için bu, belgenin kasaya alınıp alınmayacağını belirler |
|
Ek Katılımcı Kümeleri Bilgileri
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
Pencere öğesi imzalayıcısı dışında pencere öğesindeki tüm katılımcıların listesi |
|
İlk Katılımcı Kümesi Rolü
|
participantSetsInfo.widgetParticipantSet.role | string |
Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.) |
|
İlk Katılımcı Kümesi Sırası
|
participantSetsInfo.widgetParticipantSet.order | integer |
Sıralı imzalama grubunu gösteren dizin (karma yönlendirme için belirtilir) |
|
Documents
|
documentsInfo.documents | array of WidgetWebhookDocument |
Belgeleri temsil eden nesnelerin listesi |
AuthFailureWidgetRedirectionInfo
Pencere öğesi imzalayanın kimlik doğrulaması başarısız olduktan sonra alınacağı hata sayfasının URL'si ve ilişkili özellikleri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik Doğrulama Hatası Yeniden Yönlendirme Gecikmesi
|
delay | integer |
Kullanıcının sonuç sayfasına alınmasından önceki gecikme (saniye olarak) |
|
Kimlik Doğrulama Hatası Yeniden Yönlendirme Çerçevesini Kaldırma
|
deframe | boolean |
Çerçeveyi kaldırma yanlışsa, sonuç sayfası pencere öğesi çerçevesinin içinde gösterilir |
|
Kimlik Doğrulama Hatası Yeniden Yönlendirme URL'si
|
url | string |
Pencere öğesini başarıyla tamamladıktan sonra kullanıcının gönderileceği genel olarak erişilebilen url |
WidgetCompletionRedirectionInfo
Pencere öğesinde istenen eylem gerçekleştirildikten sonra pencere öğesi imzalayanın gerçekleştirileceği başarı sayfasının URL'si ve ilişkili özellikleri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Tamamlama Yeniden Yönlendirme Gecikmesi
|
delay | integer |
Kullanıcının sonuç sayfasına alınmasından önceki gecikme (saniye olarak) |
|
Tamamlama Yeniden Yönlendirme Çerçevesini Kaldırma
|
deframe | boolean |
Çerçeveyi kaldırma yanlışsa, sonuç sayfası pencere öğesi çerçevesinin içinde gösterilir |
|
Tamamlama Yeniden Yönlendirme Url'si
|
url | string |
Pencere öğesini başarıyla tamamladıktan sonra kullanıcının gönderileceği genel olarak erişilebilen url |
WebhookParticipantSets
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Üye Bilgileri
|
memberInfos | array of MemberInfos |
Katılımcı üyeleri hakkındaki bilgiler |
|
Sipariş
|
order | integer |
İmzalama grubunun imzalaması gereken konumu gösteren dizin. |
|
Rol
|
role | string |
Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.) |
|
Statü
|
status | string |
Kullanıcının bakış açısından sözleşmenin geçerli durumu |
|
Kimlik
|
id | string |
Katılımcı kümesinin kimliği |
|
İsim
|
name | string |
Katılımcı kümesinin adı |
|
Özel İleti
|
privateMessage | string |
Kümedeki katılımcılar için özel ileti |
MegaSignChildAgreementsFileInfo
MegaSign'ın çocuk sözleşmesine göre bilgilerini içeren dosya bilgileri.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Alt Sözleşmeler Dosya Kimliği
|
childAgreementsInfoFileId | string |
megaSign'ın mevcut childAgreementsInfo değeri hakkında bilgi içeren dosyanın kimliği. |
Pencere ÖğesiWebhookDocument
Pencere öğesinin belgesi hakkındaki bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Belgenin benzersiz kimliği |
|
İsim
|
name | string |
Belgenin adı |
Web KancasıDocument
Sözleşme belgesiyle ilgili bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Belgenin benzersiz kimliği |
|
İsim
|
name | string |
Belgenin adı |
Web KancasıSupportingDocument
Destekleyici belge hakkındaki bilgiler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
İsim
|
displayLabel | string |
Destekleyici belgenin görünen adı |
|
Alan Adı
|
fieldName | string |
Destekleyici belge alanının adı |
|
Kimlik
|
id | string |
Destekleyici belgeyi temsil eden benzersiz kimlik |
WidgetCcInfo
Pencere öğesinin BILGI bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta
|
string |
Pencere öğesinin BILGI katılımcısının e-postası |
MegaSignCcInfo
Mega işaretinin BILGI bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta
|
string |
Megasign'ın CC katılımcısının e-postası |
CcInfo
Sözleşmenin BILGI bilgileri
| Name | Yol | Tür | Description |
|---|---|---|---|
|
E-posta
|
string |
Sözleşmenin BILGI e-postası |
|
|
Etiket
|
label | string |
İş akışı açıklamasında döndürülen BILGI listesinin etiketi |
|
Görünür Sayfalar
|
visiblePages | array of string |
CC'ye görünen sayfalar |
WidgetParticipantSetInfo
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Rol
|
role | string |
Rol, kümedeki tüm katılımcılar tarafından varsayılır (imzalayan, onaylayan vb.) |
|
Kimlik
|
id | string |
Katılımcı kümesinin benzersiz tanımlayıcısı |
|
Üye Bilgileri
|
memberInfos | array of MemberInfos |
Katılımcı üyeleri hakkındaki bilgiler |
|
Sipariş
|
order | integer |
Sıralı imzalama grubunu gösteren dizin (karma yönlendirme için belirtilir) |
MemberInfos
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
id | string |
Katılımcının benzersiz kimliği |
|
E-posta
|
string |
Katılımcının e-posta adresi |
|
|
Şirket
|
company | string |
Katılımcının şirketi |
|
İsim
|
name | string |
Katılımcının adı |
|
Özel İleti
|
privateMessage | string |
Katılımcının özel iletisi |
|
Statü
|
status | string |
Katılımcının durumu |
LibraryDocumentCreationResponseV6
Kitaplık şablonunu açıklayan bir JSON nesnesi
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kitaplık Şablonu Kimliği
|
id | string |
Kitaplık şablonuna başvurmak için kullanılabilecek benzersiz kimlik |
LibraryDocument
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kitaplık Şablonu Kimliği
|
id | string |
Kitaplık şablonuna başvurmak için kullanılan benzersiz tanımlayıcı |
|
Gizli
|
hidden | boolean |
Kitaplık Belgesi gizliyse True |
|
Şablon Türleri
|
templateTypes | array of string |
Bir veya daha fazla kitaplık şablonu türünün listesi |
|
Değiştirme Tarihi
|
modifiedDate | date |
Kitaplık şablonunun en son değiştirildiği gün |
|
Kitaplık Şablonu Adı
|
name | string |
Kitaplık şablonunun adı |
|
Şablon Paylaşım Modu
|
sharingMode | string |
Kitaplık şablonunun görünürlüğünün kapsamı |
|
Oluşturucu E-postası
|
creatorEmail | string |
Kitaplık belge oluşturucusunun e-posta adresi. |
|
Grup Kimliği
|
groupId | string |
Kitaplık şablonunun ait olduğu grubun benzersiz tanımlayıcısı. |
|
Statü
|
status | string |
Kitaplık belgesinin durumu |
Kitaplık Belgeleri
Kitaplık şablonu dizi nesnesini içeren bir JSON
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | page |
Yanıtta gezinmek için sayfalandırma bilgileri |
|
Kitaplık Şablonları Listesi
|
libraryDocumentList | array of LibraryDocument |
Kitaplık şablonu öğelerinin listesi |
ikili
Bu, 'ikili' temel veri türüdür.
object
Bu , 'object' türüdür.
file
Bu, 'file' temel veri türüdür.