Bağlayıcı eSignatures
Connective eSignatures, çok büyük miktarda imza yöntemi ve en sıkı (inter)ulusal düzenlemelere uyumluluk sunan ünlü bir dijital imza çözümüdür. eSignatures, kağıt tabanlı işlemleri benzersiz bir kullanıcı deneyimiyle uçtan uca dijital akışa dönüştürmenizi sağlar. İmzalama işlemini tam olarak istediğiniz gibi düzenleyin ve doğrudan sık kullandığınız iş uygulamalarından tüm belge türlerini gönderin, imzalayın ve izleyin. 500'den fazla memnun müşteriye katılın.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Bağlanıcı Destek |
| URL | https://connective.eu/contact-support/ |
| E-posta | service@connective.eu |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Bağ |
| Web sitesi | https://www.connective.eu |
| Gizlilik ilkesi | https://connective.eu/privacy-policy/ |
| Kategoriler | BT İşlemleri; Verimli -lik |
Dijital imzalar, kimlik hizmetleri ve akıllı belge oluşturma alanında uzman olan Connective, Power Automate için Connective eSignatures Bağlayıcısı'nı kullanıma sunmunu sağladı. Bağlayıcı, şirketlerin dijital imza gerektiren belgeleri doğrudan Microsoft Teams'den Word, SharePoint, Dynamics, OneDrive ve diğer birçok microsoft 365 uygulamasından iletmesine olanak tanır.
Bağlayıcıyı kullanmaya başlama
Bağlayıcıyı kullanmaya başlamak için Connective'deki İlişki yöneticinize ulaşın veya kimlik bilgilerini almak için web sitemizdeki iletişim sayfamıza gidin.
Bu sayfa, kullanılabilir farklı eylemleri daha ayrıntılı olarak ayrıntılı olarak inceleyecek ve bu eylemlerin uygulanabileceği farklı yöntemler hakkında içgörü sağlayacaktır.
Daha fazla bilgi için belge web sitemize göz atmaktan veya destek ekibine destek iletişim formu veya destek posta kutusu aracılığıyla ulaşmaktan çekinmeyin: service@connective.eu
Bu belge içinde kullanılan farklı terimleri açıklamak için bir sözlük mevcuttur
Eylemler
Connective eSignatures bağlayıcısı, eSignatures API v3'lerini temel alır. eSignatures API,dış uygulamaların imzalama akışları oluşturup yönetmek için bu belgede listelenen özelliklerle tümleştirilmesine ve bu özellikleri kullanmasına olanak tanıyan bir REST API'dir.
Kullanılabilir eylemler farklı gruplar halinde gruplandırılabilir
| Eylem Grubu | Kullanılabilir Eylemler |
|---|---|
| Belgeleri karşıya yükleme | Paket Oluştur |
| Pakete Belge Ekle | |
| İmzalama Konumlarını Alma | |
| İşlem Bilgilerini Ayarla | |
| Paket Durumunu Ayarla | |
| Hızlı Paket Oluşturma | |
| Belgenin durumunu alma | Paket Durumunu Al |
| Paket Listesini Al | |
| Çeşitli eylemler | İmzalayanları Atla |
| Paketi İndir | |
| Paket Süre Sonu Uzantısı | |
| Paket Anımsatıcısı Gönder | |
| Paketi Sil | |
| Denetim Kanıtı Alma | Paket Denetim Kanıtlarını Alma |
| Belge Denetim Kanıtlarını Alma | |
| Bağıntı Kimliği ile Paket Denetim Kanıtlarını Alma | |
| Bağıntı Kimliği ile Belge Denetim Kanıtlarını Alma | |
| Dış Kaynaktan Kanıt Ekleme |
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| Bağlayıcı eSignatures ortam url'si | String | Connective eSignatures ortamınızın URL'si, örneğin. esignatures.connective.eu | Doğru |
| API kullanıcı adı | securestring | API'ye erişmek için API kullanıcı adı | Doğru |
| API parolası | securestring | API'ye erişmek için API parolası | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Belge Bağıntı Denetim Kanıtı İndirme |
Bağıntı kimlikleri, eSignatures uygulamasından geçen birkaç geçişte paketleri veya belgeleri izlemek için kullanılır. |
| Belge kimliğiyle Paket Denetim Kanıtı |
Paket tam olarak imzalandığında paketin denetim kanıtı xml'i alınabilir. Aynı durum bir belge için de geçerlidir: yalnızca içeren paket tam olarak imzalandığında çalışır. |
| Belgeyi Paketten İndir |
Paketteki imzalı belgeler, bu çağrı kullanılarak bir dış sistem tarafından tek tek indirilebilir. Her belge, DocumentType parametresinin değerine bağlı olarak PDF veya XML dosya akışı olarak indirilir. |
| Dış Kaynaktan Kanıt Ekleme |
Bu çağrı, API kullanıcılarının dış kaynaktan belgedeki bir konuma ek kanıt eklemesine olanak tanır. |
| Hızlı Paket Oluşturma |
Bu çağrı, içinde tek bir belge bulunan bir paket oluşturur ve hemen imzalamaya hazırlar |
| İmzalama Konumlarını Alma |
Bu çağrı, bir paket içindeki belgelerin içindeki tüm imzalama konumlarına genel bir bakış sağlar. |
| İmzalayanları Atla |
Bu çağrı, henüz imzalanmamış tüm imzalayanları atlar ve durumlarını "Atlandı" olarak ayarlar ve bu da paketin tamamının "Tamamlandı" olarak işaretlenmesine neden olur. |
| İşlem Bilgilerini Ayarla |
Bu web hizmeti yöntemi, sürece dahil olan kişileri (paydaşlar) güncelleştirir ve onlara izlenmesi gereken adımları atar. |
| Paket Anımsatıcıları Gönder |
Şirket ilkesi, belgenin belirli bir zaman aralığı içinde işlenmesini gerektirebilir. "Anımsatıcı gönder" çağrısı tetiklendiğinde, imzalamamış olan herkes aranacak ve anımsatıcı olarak ek bir bildirim gönderilecektir. |
| Paket Bağıntı Denetim Kanıtı İndirme |
Bağıntı kimlikleri, eSignatures uygulamasından geçen birkaç geçişte paketleri veya belgeleri izlemek için kullanılır. |
| Paket Denetim Kanıtı |
Paket tam olarak imzalandığında paketin denetim kanıtı xml'i alınabilir. Aynı durum bir belge için de geçerlidir: yalnızca içeren paket tam olarak imzalandığında çalışır. |
| Paket Durumunu Al |
Paketin ve belgelerinin geçerli durumunu alır. |
| Paket Durumunu Ayarla |
Paket Durumunu Ayarla çağrısıyla bir paketin durumunu değiştirebilirsiniz. |
| Paket Listesi |
Geçerli durumlarına sahip paketlerin listesini alma |
| Paket Oluştur |
Bu çağrı boş bir paket oluşturarak belgelerin bu pakete eklenmesini sağlar |
| Pakete belge ekleme |
Bu çağrı, var olan bir pakete belge ekler. |
| Paketi İndir |
İmzalanan belgeleri içeren paket, bu çağrı kullanılarak bir dış sistem tarafından indirilebilir. |
| Paketi Sil |
eSignatures, son duruma ulaştıktan sonra paketleri veritabanından otomatik olarak silmez. Bunlar süresiz olarak depolanır. Kullanıcılar, veritabanından paketleri silmek için Paketi Sil çağrısını kullanabilir. |
| Süre Sonu Zaman Damgası |
Paket Oluşturma çağrısında bir paket ExpiryTimestamp parametresi için bir değer geçirildiğinde paket süresi doldu durumuna sahip olabilir. Böyle bir paket artık imzalanamaz. |
Belge Bağıntı Denetim Kanıtı İndirme
Bağıntı kimlikleri, eSignatures uygulamasından geçen birkaç geçişte paketleri veya belgeleri izlemek için kullanılır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bağıntı tanımlayıcısı.
|
correlationId | True | string |
Bağıntı tanımlayıcısı. |
Döndürülenler
- Body
- Content
Belge kimliğiyle Paket Denetim Kanıtı
Paket tam olarak imzalandığında paketin denetim kanıtı xml'i alınabilir. Aynı durum bir belge için de geçerlidir: yalnızca içeren paket tam olarak imzalandığında çalışır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
packageId | True | string |
Paketin Benzersiz Kimliği |
|
Belgenin Benzersiz Kimliği
|
documentId | True | string |
Belgenin Benzersiz Kimliği |
Döndürülenler
- Body
- Content
Belgeyi Paketten İndir
Paketteki imzalı belgeler, bu çağrı kullanılarak bir dış sistem tarafından tek tek indirilebilir. Her belge, DocumentType parametresinin değerine bağlı olarak PDF veya XML dosya akışı olarak indirilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmzalama paketi için benzersiz kimlik
|
id | True | string |
İmzalama paketi için benzersiz kimlik |
|
Pakette bulunan belgenin benzersiz kimliği
|
documentId | True | string |
Pakette bulunan belgenin benzersiz kimliği |
Döndürülenler
- response
- binary
Dış Kaynaktan Kanıt Ekleme
Bu çağrı, API kullanıcılarının dış kaynaktan belgedeki bir konuma ek kanıt eklemesine olanak tanır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin benzersiz kimliği
|
packageId | True | string |
Paketin benzersiz kimliği |
|
Content
|
Content | string |
Kanıtın gerçek içeriği. |
|
|
LocationId
|
LocationId | string |
Kanıt içeriğinin oluşturulduğu imzanın konumu. |
|
|
İsim
|
Name | string |
Kanıtın adı. |
|
|
Türü
|
Type | string |
Makine tarafından okunabilir bir "tür" anahtarı. Serbestçe seçilebilir. |
|
|
Description
|
Description | string |
Kanıtın insan tarafından okunabilen kısa açıklaması. |
|
|
IP Adresi
|
IpAddress | string |
Kanıtın eklendiği dış kaynağın son kullanıcısının IP adresi. |
Hızlı Paket Oluşturma
Bu çağrı, içinde tek bir belge bulunan bir paket oluşturur ve hemen imzalamaya hazırlar
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Belge
|
Document | byte |
Base64 kodlanmış biçimde ekli belge. Çok parçalı biçim kullanılmadığı sürece gereklidir. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
İmza metinlerinde kullanılacak dil. Şu anda desteklenmektedir: en, nl, de, fr, es. |
|
|
Belge Adı
|
DocumentName | string |
eSignatures Portalı'nda gösterilecek belgenin ve paketin adı. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
Kayıtlı kullanıcının e-posta adresi |
|
|
Türü
|
Type | string |
İmzalayan / Alıcı |
|
|
OrderIndex
|
OrderIndex | integer |
Bu sayı, aktörlerin eylemlerini hangi sırayla yürütmesi gerektiğini belirtir. |
|
|
PageNumber
|
PageNumber | integer |
İmzalama konumu eklenecek sayfanın sayısı |
|
|
Genişlik
|
Width | string |
Genişlik |
|
|
Yükseklik
|
Height | string |
Yükseklik |
|
|
Sol
|
Left | string |
Sayfanın solundan konum |
|
|
Yukarı
|
Top | string |
Sayfanın en üstünden konum |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
İmzalama alanına, metin işaretçisine veya metin alanına benzersiz başvuru. |
|
|
SigningType
|
SigningType | string |
Bu aktörün oturumunda kullanılan imzalama türü. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Taahhüt türlerinin bir veya daha fazla OID'i. Yalnızca imza ilkesi kullanıldığında geçirilebilir. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Diğer akıllı kart veya onunme imzalama oturumu sırasında yürütülecek doğrulama türü. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Bu oturum sırasında hangi eID'nin veya diğer akıllı kartların imzalamasına izin verilip verilmediğini tanımlar. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
İmza için imzalama ilkesi ayrıntıları. |
|
|
Telefon numarası
|
Phonenumber | string |
SMS OTP almak için telefon numarası. |
|
|
RedirectUrl
|
RedirectUrl | string |
İmzalamadan sonra son kullanıcının yeniden yönlendirildiği URL. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures, imzalama izni olan tüm kişilere e-posta gönderebilir. |
|
|
UserRoles
|
UserRoles | array of string |
İmzalayanın rolü veya işlevi. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Yasal Uyarı |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Önceden tanımlanmış üç yasal bildirimden hiçbirinin geçerli olmaması durumunda özel yasal bildirim metni. |
|
|
E-posta Adresi
|
EmailAddress | string |
E-posta Adresi |
|
|
İlk İsim
|
FirstName | string |
İlk İsim |
|
|
Soyadı
|
LastName | string |
Soyadı |
|
|
Doğum tarihi
|
BirthDate | string |
Doğum tarihi |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
Bu paket için her eylem tamamlandığında çağrılacak REST API URL'si |
|
|
CorrelationId
|
CorrelationId | string |
Hangi paketlerin veya belgelerin bağıntılı olduğunu gösteren kimlik |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Belgenin gösterilmesi gereken belge grubunu tanımlayan 'Kod'. |
|
|
ThemeCode
|
ThemeCode | string |
Pakete uygulanması gereken tema |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Bu parametre, paketlerin imzalamadan önce WYSIWYS'den indirilip indirilemeyeceğini belirler |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Bu parametre, paketlerin WYSIWYS'den başka bir onaylayana/imzalayana yeniden atanıp atanamayacağını belirler. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Bu parametre, kullanılmadığında eylem URL'lerinin kaç gün sonra süresinin dolması gerektiğini belirler. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Çağrı uygulaması tarafından verilen başvuru. Bu parametre eSignatures Portalı tarafından kullanılmaz |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Çağrı uygulaması tarafından verilen başvuru, bu parametre eSignatures Portalı tarafından kullanılmaz |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Çağrı uygulaması tarafından verilen başvuru, bu parametre eSignatures Portalı tarafından kullanılmaz |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Tüm alanlar 'yüz yüze' imzalama ile imzalandıktan veya tüm alanlar reddedildikten sonra son kullanıcının yeniden yönlendirildiği URL. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Son kullanıcı bildirim almak istediğinde çağrılacak REST API URL'si. URL sağlanmazsa geri arama yapılmaz |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Küçük kusurlar içeren PDF'lerle başa çıkma |
|
|
Temsil
|
Representation | string |
Base64 biçiminde ekli gösterim belgesi |
|
|
RepresentationType
|
RepresentationType | string |
Gösterim belgesi türü, Gösterim doldurulduğunda mevcut olmalıdır. Yalnızca "uygulama/pdf" desteklenir. |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
Portalda yapılandırılan şablon tüm gerekli bilgileri sağlar |
|
|
HedefTürü
|
TargetType | string |
TargetType, imzalamadan önce PDF/A'ya ek dönüştürme yapılması gerekip gerekmediğini tanımlar |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Paketin benzersiz tanımlayıcısı. |
|
CreationTimestamp
|
CreationTimestamp | string |
Paketin sunucuya göre oluşturulduğu tarih ve saat. |
İmzalama Konumlarını Alma
Bu çağrı, bir paket içindeki belgelerin içindeki tüm imzalama konumlarına genel bir bakış sağlar.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmzalama alanının kimliği
|
Id | True | string |
İmzalama alanının kimliği |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
Belgenin benzersiz kimliği |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Tanımlama için dış başvuru. Benzersiz bir değer kullandığınızdan emin olun. |
|
Yerleşimler
|
Documents.Locations | array of object |
İmza için olası bir konumu temsil eder |
|
Kimlik
|
Documents.Locations.Id | string |
Bu konumun benzersiz kimliği. |
|
Etiket
|
Documents.Locations.Label | string |
İstek parametresi olarak girdiğiniz değer. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
İmzanın bulunabileceği sayfa sayısı. |
İmzalayanları Atla
Bu çağrı, henüz imzalanmamış tüm imzalayanları atlar ve durumlarını "Atlandı" olarak ayarlar ve bu da paketin tamamının "Tamamlandı" olarak işaretlenmesine neden olur.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin benzersiz kimliği
|
PackageId | True | string |
Paketin benzersiz kimliği |
İşlem Bilgilerini Ayarla
Bu web hizmeti yöntemi, sürece dahil olan kişileri (paydaşlar) güncelleştirir ve onlara izlenmesi gereken adımları atar.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
id | True | string |
Paketin Benzersiz Kimliği |
|
Türü
|
Type | string |
Türü |
|
|
OrderIndex
|
OrderIndex | string |
Bu sayı, aktörlerin eylemlerini hangi sırayla yürütmesi gerektiğini belirtir. |
|
|
LocationId'ler
|
LocationIds | array of string |
İmzanın bu kişi tarafından yerleştirilmesi gereken konum kimlikleri. |
|
|
SigningType
|
SigningType | string |
Bu aktörün oturumunda kullanılan imzalama türü. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Taahhüt türlerinin bir veya daha fazla OID'i. Yalnızca imza ilkesi kullanıldığında geçirilebilir. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Diğer akıllı kart veya onunme imzalama oturumu sırasında yürütülecek doğrulama türü. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Bu oturum sırasında hangi eID'nin veya diğer akıllı kartların imzalamasına izin verilip verilmediğini tanımlar. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
İmza için imzalama ilkesi ayrıntıları. |
|
|
Telefon numarası
|
Phonenumber | string |
SMS OTP almak için telefon numarası. |
|
|
RedirectURL
|
RedirectURL | string |
İmzalama veya reddetme sonrasında son kullanıcının yeniden yönlendirildiği URL. Yeniden yönlendirme, imzaladıktan veya reddedildikten hemen sonra gerçekleşir. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures, eylemi gereken aktörlere imza gibi e-postalar gönderebilir |
|
|
UserRoles
|
UserRoles | array of string |
İmzanın bu kişi tarafından yerleştirilmesi gereken konum kimlikleri. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
3 değeri, uygulamada yerleşik olarak bulunan 3 yasal bildirime işaret eder. Bunlar Yapılandırma Dizininde değiştirilebilir. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Önceden tanımlanmış üç yasal bildirimden hiçbirinin geçerli olmaması durumunda özel yasal bildirim metni |
|
|
E-posta Adresi
|
EmailAddress | string |
E-posta Adresi |
|
|
İlk İsim
|
FirstName | string |
İlk İsim |
|
|
Language
|
Language | string |
Bu paydaşın kullanıcı arabirimi dili. Şu anda desteklenmektedir: en, nl, de, fr, es. |
|
|
Soyadı
|
LastName | string |
Soyadı |
|
|
Doğum tarihi
|
BirthDate | string |
Biçimde doğum tarihi: YYYY-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Çağrı uygulaması tarafından verilen başvuru. Bu parametre eSignatures Portalı tarafından kullanılmaz. |
Paket Anımsatıcıları Gönder
Şirket ilkesi, belgenin belirli bir zaman aralığı içinde işlenmesini gerektirebilir. "Anımsatıcı gönder" çağrısı tetiklendiğinde, imzalamamış olan herkes aranacak ve anımsatıcı olarak ek bir bildirim gönderilecektir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
PackageId | True | string |
Paketin Benzersiz Kimliği |
Paket Bağıntı Denetim Kanıtı İndirme
Bağıntı kimlikleri, eSignatures uygulamasından geçen birkaç geçişte paketleri veya belgeleri izlemek için kullanılır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bağıntı tanımlayıcısı.
|
correlationId | True | string |
Bağıntı tanımlayıcısı. |
Döndürülenler
- Body
- Content
Paket Denetim Kanıtı
Paket tam olarak imzalandığında paketin denetim kanıtı xml'i alınabilir. Aynı durum bir belge için de geçerlidir: yalnızca içeren paket tam olarak imzalandığında çalışır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
packageId | True | string |
Paketin Benzersiz Kimliği |
Döndürülenler
- Body
- Content
Paket Durumunu Al
Paketin ve belgelerinin geçerli durumunu alır.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmzalama paketi için benzersiz kimlik
|
Id | True | string |
İmzalama paketi için benzersiz kimlik |
Döndürülenler
eSignatures Portalı kullanıcısına dosya adı olarak gösterilen Paket için açıklama.
- Body
- PackageStatus
Paket Durumunu Ayarla
Paket Durumunu Ayarla çağrısıyla bir paketin durumunu değiştirebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İmzalama paketi için benzersiz kimlik
|
Id | True | string |
İmzalama paketi için benzersiz kimlik |
|
Statü
|
Status | string |
Beklemede / İptal Edilmiş |
Döndürülenler
eSignatures Portalı kullanıcısına dosya adı olarak gösterilen Paket için açıklama.
- Body
- PackageStatus
Paket Listesi
Geçerli durumlarına sahip paketlerin listesini alma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Döndürülecek sayfayı bilmek için devamlılık belirteci / guid.
|
ContinuationToken | string |
Döndürülecek sayfayı bilmek için devamlılık belirteci / guid. BOŞ OLMALI veya BIR ÖNCEKİ çağrıdan döndürülen belirteç. |
|
|
Maksimum miktarı alır veya ayarlar.
|
MaxQuantity | integer |
Maksimum miktarı alır veya ayarlar. |
|
|
Sıralama alanını alır veya ayarlar.
|
SortField | string |
Sıralama alanını alır veya ayarlar. |
|
|
Sıralama alanını alır veya ayarlar.
|
SortOrder | string |
Sıralama alanını alır veya ayarlar. |
|
|
Oluşturulma tarihinden öncesini alır veya ayarlar.
|
CreatedBeforeDate | string |
Oluşturulma tarihinden öncesini alır veya ayarlar. |
|
|
Durumu alır veya ayarlar.
|
Status | string |
Durumu alır veya ayarlar. |
|
|
Oluşturulduktan sonraki tarihi alır veya ayarlar.
|
createdAfterDate | string |
Oluşturulduktan sonraki tarihi alır veya ayarlar. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
DevamToken
|
ContinuationToken | string |
DevamToken |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Eşya
|
Items | array of Package |
Paket Oluştur
Bu çağrı boş bir paket oluşturarak belgelerin bu pakete eklenmesini sağlar
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
İçerik Türü
|
Content-Type | True | string |
İçerik Türü |
|
Initiator
|
Initiator | string |
Kayıtlı kullanıcının e-posta adresi. |
|
|
PackageName
|
PackageName | string |
eSignatures Portalı'nda ve zip dosyası olarak indirilirken görülen paket adı. |
|
|
CallBackUrl
|
CallBackUrl | string |
Bu paket için her eylem tamamlandığında çağrılan REST API URL'si. |
|
|
CorrelationId
|
CorrelationId | string |
Hangi paketlerin bağıntılı olduğunu gösteren kimlik. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Paketin gösterilmesi gereken bir belge grubunu tanımlayan 'Kod'. |
|
|
ThemeCode
|
ThemeCode | string |
Pakete uygulanması gereken tema |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Bu parametre, paketlerin imzalamadan önce WYSIWYS'den indirilip indirilemeyeceğini belirler. |
|
|
ReassignEnabled
|
ReassignEnabled | boolean |
Bu parametre, paketlerin WYSIWYS'den başka bir onaylayana/imzalayana yeniden atanıp atanamayacağını belirler. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Bu parametre, kullanılmadığında eylem URL'lerinin kaç gün sonra süresinin dolması gerektiğini belirler. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Bu paketin süresinin dolacağı ve artık imzalanamayacakları tarih ve saat. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Çağrı uygulaması tarafından verilen başvuru. Bu parametre eSignatures Portalı tarafından kullanılmaz. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Bu alan gelecekte kullanılmak üzere ayrılmıştır. Müşteriye özgü uzantıların Banka Kartı imzalama gibi üçüncü taraf hizmetlerle tümleştirilmesi için kullanılabilir. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
Tüm alanlar 'yüz yüze' imzalama ile imzalandıktan veya tüm alanlar reddedildikten sonra son kullanıcının yeniden yönlendirildiği URL. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
Son kullanıcı bildirim almak istediğinde çağrılacak REST API URL'si. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Paketin benzersiz tanımlayıcısı. |
|
CreationTimestamp
|
CreationTimestamp | string |
Paketin sunucuya göre oluşturulduğu tarih ve saat. |
Pakete belge ekleme
Bu çağrı, var olan bir pakete belge ekler.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paket tanımlayıcısı.
|
PackageId | True | string |
Paket Benzersiz Kimliği |
|
Belge
|
Document | string |
Base64 kodlanmış biçimde ekli belge. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
İmza metinlerinde kullanılacak dil. |
|
|
Belge Adı
|
DocumentName | string |
eSignatures Portalı'nda gösterilecek belgenin adı. |
|
|
PageNumber
|
PageNumber | integer |
İmzalama konumu eklenecek sayfanın sayısı |
|
|
Genişlik
|
Width | string |
Genişlik |
|
|
Yükseklik
|
Height | string |
Yükseklik |
|
|
Sol
|
Left | string |
Sayfanın solundan konum |
|
|
Yukarı
|
Top | string |
Sayfanın en üstünden konum |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
İmzalama alanına, metin işaretçisine veya metin alanına benzersiz başvuru. |
|
|
CorrelationId
|
CorrelationId | string |
Bu paketteki hangi belgelerin diğer paketlerde geçmişte oturum açmış belgelerle bağıntılı olduğunu gösteren kimlik. |
|
|
DocumentType
|
DocumentType | string |
İmzalanacak belgenin türü. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Çağrı uygulaması tarafından verilen başvuru. |
|
|
ErrorCode
|
ErrorCode | string |
Değişken bilgileriyle hata kodu. |
|
|
Message
|
Message | string |
Hata iletisi ayrıntı metni, yerelleştirilmemiş |
|
|
Temsil
|
Representation | string |
Base64 biçiminde ekli gösterim belgesi. Bu, PDF verileri olmalıdır. |
|
|
RepresentationType
|
RepresentationType | string |
Temsil belgesinin türü. |
|
|
HedefTürü
|
TargetType | string |
TargetType, imzalamadan önce PDF/A'ya ek dönüştürme yapılması gerekip gerekmediğini tanımlar. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Belgenin benzersiz kimliği |
|
CreationTimestamp
|
CreationTimestamp | string |
Akışın oluşturulduğu tarih ve saat. Biçim: YYYY-MM-DDThh:mm:ss+zz:zz |
|
Yerleşimler
|
Locations | array of object |
İmza için olası bir konumu temsil eder |
|
Kimlik
|
Locations.Id | string |
Bu konumun benzersiz kimliği |
|
Etiket
|
Locations.Label | string |
Algılanan veya belirtilen etiket |
|
PageNumber
|
Locations.PageNumber | integer |
Konumun bulunduğu sayfa. |
Paketi İndir
İmzalanan belgeleri içeren paket, bu çağrı kullanılarak bir dış sistem tarafından indirilebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
id | True | string |
Paketin Benzersiz Kimliği |
Döndürülenler
- response
- binary
Paketi Sil
eSignatures, son duruma ulaştıktan sonra paketleri veritabanından otomatik olarak silmez. Bunlar süresiz olarak depolanır. Kullanıcılar, veritabanından paketleri silmek için Paketi Sil çağrısını kullanabilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
id | True | string |
Paketin Benzersiz Kimliği |
Süre Sonu Zaman Damgası
Paket Oluşturma çağrısında bir paket ExpiryTimestamp parametresi için bir değer geçirildiğinde paket süresi doldu durumuna sahip olabilir. Böyle bir paket artık imzalanamaz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Paketin Benzersiz Kimliği
|
id | True | string |
Paketin Benzersiz Kimliği |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Tanımlar
Package
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Kimlik
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Paketteki belgelerin her biri için ayrıntılar
| Name | Yol | Tür | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Belgenin benzersiz kimliği |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Pakete belge ekle çağrısı aracılığıyla geçirildiği için bu belgenin dış başvuruyu döndürür. |
|
Belge Adı
|
DocumentName | string |
Belgenin adı |
|
DocumentType
|
DocumentType | string |
Paket içindeki belgenin türü. |
PackageStatus
eSignatures Portalı kullanıcısına dosya adı olarak gösterilen Paket için açıklama.
| Name | Yol | Tür | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
eSignatures Portalı kullanıcısına dosya adı olarak gösterilen Paket için açıklama. |
|
CreationTimestamp
|
CreationTimestamp | string |
Paketin sunucuya göre oluşturulduğu tarih ve saat. |
|
Initiator
|
Initiator | string |
Oluşturma zamanında geçirildiği için paketin başlatıcı alanı. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Belgenin süresinin dolduğu UTC biçimli saat. Null olabilir. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Oluşturma zamanında geçirildiği için paketin dış başvuru kimliğini döndürür. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Tüm imzalama oturumundan aynı anda seçim yapılmasını sağlayan pakete bağlantı. |
|
PackageStatus
|
PackageStatus | string |
Paketin bir bütün olarak durumu: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Paketteki belgelerin her biri için ayrıntılar. |
|
Proje Katılımcıları
|
Stakeholders | array of object |
Paketle etkileşim kuracak kişilerin her biri için ayrıntılar. |
|
Türü
|
Stakeholders.Type | string |
Paydaş türü: Person, PersonGroup veya ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Kişi grubunun adı. Yalnızca Type istekte PersonGroup olarak ayarlandıysa döndürülür. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Kişi grubunun kodu. Yalnızca Type istekte ContactGroup olarak ayarlandıysa döndürülür. |
|
E-posta Adresi
|
Stakeholders.EmailAddress | string |
İmzalayanın e-posta adresi. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Dış sistemde bu kişiyi tanımlayan dış başvuru. |
|
PaydaşKimliği
|
Stakeholders.StakeholderId | string |
Benzersiz kimlik. |
|
Actors
|
Stakeholders.Actors | array of object |
Atılması gereken tüm adımların ayrıntıları. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
Eylem, paydaş ve belgenin bu birleşimi için benzersiz kimlik. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
Bu kişinin paketle etkileşime geçmek için açabileceği URL. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
PersonGroup veya ContactGroup'un farklı kişilerinin paketle etkileşim kurmak için açabileceği URL dizisi. |
|
E-posta Adresi
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Kişinin e-posta adresi. |
|
Bağlantı
|
Stakeholders.Actors.ActionUrls.Url | string |
Bu kişinin paketle etkileşime geçmek için açabileceği URL. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Taslak (paket taslak durumunda) |
|
Türü
|
Stakeholders.Actors.Type | string |
İmzalayan / Alıcı |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Eylemi tamamlayan son kullanıcının adı. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Bu eylemin tamamlandığı anın zaman damgası. |
|
Reason
|
Stakeholders.Actors.Reason | string |
Bir paketin durumunu son duruma (ör. reddetme) değiştiren kişi tarafından girilen metni döndürür. |
|
Yerleşimler
|
Stakeholders.Actors.Locations | array of object |
İmza için olası bir konumu temsil eder. |
|
Kimlik
|
Stakeholders.Actors.Locations.Id | string |
Bu konumun benzersiz kimliği |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Belgeyi imzalamak için kullanılan imzalama türünü döndürür. |
Content
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Yüklenen
|
uploads | array of object | |
|
karşıya yükle
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
end
|
uploads.upload.end | date-time | |
|
Imza
|
uploads.upload.signatures | array of object | |
|
Delil
|
uploads.upload.signatures.proofs | array of object | |
|
name
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
Dizin
|
uploads.indexes | array of object | |
|
Tanımlayıcı
|
uploads.indexes.index.identifier | boolean | |
|
içerik
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
packageId (paket kimliği)
|
uploads.packageId | string |
ikili
Bu, 'ikili' temel veri türüdür.