Legalesign (Önizleme)

Uyumluluk odaklı yasal ve operasyon ekipleri için tasarlanan Legalesign bağlayıcısı, belge ve alıcı iş akışlarını tetikleme, anımsatıcı gönderme, PDF'leri getirme ve form verilerini ortaya çıkarma amacıyla Microsoft power platformunu Legalesign eSignature ile ilişkilendirmektedir. API kullanımı için onaylanmış etkin bir Legalesign aboneliği gerektirir.

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	API desteği
URL	https://legalesign.com/contact/
E-posta	sales@legalesign.com

Bağlayıcı Meta Verileri
Publisher	Yasal atama
Legalesign hakkında daha fazla bilgi edinin	https://docs.microsoft.com/connectors/legalesign
Web sitesi	https://legalesign.com
Gizlilik Politikası	https://legalesign.com/opn/privacy/
Kategoriler	İçerik ve Dosyalar; Verimli -lik

Legalesign eSignature REST Bağlayıcısı

Legalesign REST API, eSignature iş akışlarını destekler. Bu bağlayıcı tam API erişimi ve gerçek zamanlı tetikleyiciler sunarak Microsoft Power Automate, Logic Apps ve ilgili platformlarla sorunsuz tümleştirme sağlar.

Önkoşullar

Başlamak için bir Legalesign hesabına ve API anahtarına ihtiyacınız vardır: 1. Ücretsiz deneme sürümüne kaydolun. 2. Bir grup oluşturun (tek bir ortam; örneğin, geliştirme için bir ortam ve üretim için başka bir ortam). 3. Destek bileti oluşturarak API anahtarı isteyin. Destek'in kimliğinizi doğrulayabilmesi için kullanım örneğinizi, şirketinizi ve rolünüzü ekleyin. 4. Doğrulandıktan sonra anahtarınızı almak için API Panosu'nda oturum açın.

Dağıtım

Yeni hesaplar şu sınırlamalarla korumalı alan modunda başlar: • Belgeler yalnızca API Panosu'nda yapılandırdığınız e-posta adreslerini test etmek için gönderilebilir. • İstekler 100/dakika olarak azaltılır.

Canlı yayına hazır olduğunuzda, hesabınızı korumalı alandan üretime geçmek için bir destek bileti oluşturun . Bu noktada kısıtlamalar kaldırılacaktır. Ayrıntılar için dağıtım kılavuzuna bakın.

Triggers

Bağlayıcı iki gerçek zamanlı tetikleyiciyi destekler:

• Belge olayları (örn. oluşturuldu, reddedildi, imzalandı, son PDF oluşturuldu)
• Alıcı olayları (ör. tamamlandı, reddedildi, e-posta açıldı, geri döndü, anımsatıcılar gönderildi)

Grup veya olay türüne göre filtre uygulanmış tüm belge veya alıcıları alabilirsiniz. İlişkili tüm Legalesign web kancaları API Panosu'nda yönetilebilir ve izlenebilir.

Operations

Yasal atama REST API işlemleri desteklenir. En yaygın olarak imzalı PDF indirme, şablonları, belgeleri, alıcıları ve alan yerleşimini yönetme sayılabilir. Tam belirtim için tam API belgelerine bakın.

Legalesign'da karşıya yüklenen bir belge 'şablon' olarak adlandırılır. Bir şablon bir veya daha fazla alıcıya gönderildiğinde bir 'belge' olur. Genellikle bir şablonu karşıya yükler, tanımlayıcısını kurtarır ve bir veya daha fazla alıcıya gönderirsiniz.

Yaygın işlemler şunlardır:

Şablonlar

• Create PDF template - bir şablonu (PDF, Word veya resim gibi herhangi bir dosya türü) karşıya yükleyin.
• Get PDF embeddable link - şablon düzenleyicisini kullanıcıya göstermek için tek kullanımlık bağlantı

Documents

• Location to download PDF - imzalı bir belgenin PDF ikili dosyasını döndürür
• Create signing document - belge gönderme (şablon ve alıcı seçme)
• Void/archive signing document - belgenin imzalanmasını durdurma
• Permanently delete signing document - belgeyi sonsuza kadar kaldırma

Alıcılar (imzalayanlar)

• Send signer reminder email - alıcıya belgenizi tamamlamasını anımsatma
• Get signer rejection reason - belge reddedilirse neden

Alan yerleşimi

Legalesign,alanları olan gelişmiş bir form sistemine sahiptir. İmzalayanlarınız varsa, her imzacının en az bir imza alanı olmalıdır.

Şablonunuzdaki alanları tanımlamanın dört yolu vardır:

1. Eklenmiş alanları olan bir PDF'yi karşıya yükleyin (Legalesign tarafından otomatik olarak dönüştürülür).
2. Legalesign metin etiketlerini kullanın.
3. x/y koordinatlarını tanımlayın.
4. Legalesign form düzenleyicisini kullanın (ekleme bağlantısı veya web uygulaması aracılığıyla).

Kılavuz için buraya tıklayın

Sorgular ve destek

Ek destek veya sorgular için Legalesign hesabınızda oturum açın ve bir destek bileti oluşturun.

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
API anahtarı	securestring	Bu API için api_key	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

Alıcı anımsatıcı e-postası gönder	Alıcıya anımsatıcı e-postası gönderin.
Alıcı bağlantısını alma	Alıcının imzalama sayfalarına gitmesi için tek kullanımlık bağlantı.
Alıcı form alanlarını alma	Belirli bir alıcıdaki form alanlarını döndürür.
Alıcı reddetme nedenini alma	belgeyi reddetmek için imzalayanın verdiği nedeni döndürür.
Alıcıyı alma	Tek bir alıcının durumunu ve ayrıntılarını alın.
Belge alanlarını alma	Belgedeki alanlar.
Belge denetim günlüğü indirme	Yalnızca belge denetim günlüğü PDF'si.
Belge gönder	İmza veya onay için belge gönderme.
Belgeleri alma	Arşivlenmemiş imzalama belgelerini listeleyin.
Belgeyi al	Belirli bir belgeyi döndürür.
Belgeyi geçersiz kılma ve arşivle	Durumu 40 olan bir belgeyi ayarlar ve arşivler.
Belgeyi kalıcı olarak silme	Verileri ve dosyaları kalıcı olarak siler.
Ek alma	Ek alın.
Eki silme	Eki silme.
Ekleri alma	Ekleri listeleyin.
Grubun üyesi	Bir grup içindeki belirli bir kullanıcının ayrıntıları.
Grupları alma	Kullanıcının ait olduğu API gruplarını listeleyin.
Grupların üyeleri	Gruplarınızın tüm üyelerinin listesi.
Kullanıcı alma	Kullanıcı ayrıntılarını alın.
PDF eklenebilir bağlantı alma	PDF düzenleyicisi eklemek için tek kullanımlık bir bağlantı döndürür.
PDF eklerini karşıya yükleme	Alıcı e-postasına eklemek için pdf dosyasını kaydedin.
PDF şablonlarını alma	PDF şablonlarını listeleme
PDF şablonu alma	Belirli bir PDF şablonunun ayrıntıları
PDF şablonunu karşıya yükleme	İmzalanması için göndermek istediğiniz PDF belgesini karşıya yükleyin.
PDF’yi İndir	İmzalama belgesinin durumuna bağlı olarak taslak veya son PDF dosyasını alın. 200 veya 302 yanıtının mümkün olduğunu unutmayın.

Alıcı anımsatıcı e-postası gönder

İşlem Kimliği:

PostSignerReminder

Alıcıya anımsatıcı e-postası gönderin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alıcı Kimliği	recipientId	True	uuid	Alıcı Kimliği
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.	text		string	Özel ileti metni

Alıcı bağlantısını alma

İşlem Kimliği:

GetSignerLink

Alıcının imzalama sayfalarına gitmesi için tek kullanımlık bağlantı.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alıcı Kimliği	recipientId	True	uuid	Alıcı Kimliği

Alıcı form alanlarını alma

İşlem Kimliği:

GetSignerFields

Belirli bir alıcıdaki form alanlarını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alıcı Kimliği	recipientId	True	uuid	Alıcı Kimliği

Döndürülenler

Name	Yol	Tür	Description
		array of object
label	label	string	Etiket
label_extra	label_extra	string	Ek etiket
state	state	boolean	Devlet
alan sırası	fieldorder	integer	Alan sırası
value	value	string	Alan bir imzalayan dosyasıysa, bu değer kısa süreli bir indirme URL'si olacaktır.

Alıcı reddetme nedenini alma

İşlem Kimliği:

GetSignerRejection

belgeyi reddetmek için imzalayanın verdiği nedeni döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alıcı Kimliği	recipientId	True	uuid	Alıcı Kimliği

Döndürülenler

Name	Yol	Tür	Description
statü	status	integer	Alıcı heykelleri.
sebep	reason	string	Reddetme nedeni.

Alıcıyı alma

İşlem Kimliği:

GetRecipient

Tek bir alıcının durumunu ve ayrıntılarını alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alıcı Kimliği	recipientId	True	uuid	Alıcı Kimliği

Döndürülenler

Alıcı ayrıntıları

Body

SignerResponse

Belge alanlarını alma

İşlem Kimliği:

GetDocumentFields

Belgedeki alanlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge kimliği

Döndürülenler

Name	Yol	Tür	Description
		array of object	Belge alanlarının listesi
element_type	element_type	string	Öğe türü
alan sırası	fieldorder	integer	Alan sırası
label	label	string	Etiket
label_extra	label_extra	string	Ek etiket
imzalayan	signer	integer	Recipient
state	state	boolean
Doğrulama	validation	integer	Doğrulama tanımlayıcısı
value	value	string	Değer

Belge denetim günlüğü indirme

İşlem Kimliği:

GetDocumentAuditLog

Yalnızca belge denetim günlüğü PDF'si.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge Kimliği

Döndürülenler

response

file

Belge gönder

İşlem Kimliği:

PostDocument

İmza veya onay için belge gönderme.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup	group	True	string	Grup kaynağı uri'si
İsim	name	True	string	Belgenin adını belirtin
PDF şablonu	templatepdf	True	string	Gönderilecek karşıya yüklenen PDF.
e-posta	email	True	email	E-posta
ilk ad	firstname	True	string	İsim
soyadı	lastname	True	string	Soyadı
attachments	attachments		array of string	Ek kaynağı uris listesi.
Sona eri -yor	expires		date-time	Biçimlendirilmiş tarih saat ISO8601, kullanılıyorsa gönderenin veya saat diliminin TZ'sine ayarlayın
message	message		string	Grup e-posta şablonunun ortasına girilen parti için kişisel mesajınız. Bu şablonu kullanmak için karma simgesiyle önceden oluşturulmuş kaydedilmiş bir e-posta şablonunun adını kullanın. Aynı ada sahip birden fazla şablon varsa, son değiştirilen şablonu seçer.
ilk ad	firstname		string	İsim
soyadı	lastname		string	Soyadı
e-posta	email	True	email	E-posta
include_link	include_link		boolean	Gözden geçirenin imzalamasını sağlayan imzalama sayfalarına bağlantı ekleme
kısa mesaj	sms		string	SMS doğrulaması eklemek için uluslararası biçim numarasını kullanın. Bir tanık veya tanık imzalayan varsa gereklidir.
konu	subject		string	Giden e-posta için konu satırı
timezone	timezone		string	İmzalayanın TZ değeri saat dilimi başına geçerli TZ olmalıdır (bkz. Timezoneenum ayrıntıları için kullanıcı). Boş ise gönderenin tz değeri kullanılır.
İmza türü	signature_type		integer	Yürütülen PDF Sertifikanızı almak için 4 kullanın. Tavsiye edilir. Varsayılan değer 1'tir (belge bütünlüğü için sha256 karması kullanır).
PDF Ekle	append_pdf		boolean	Son PDF'ye Legalesign doğrulama bilgilerini ekleyin.
auto_archive	auto_archive		boolean	İmzalamadan hemen sonra arşive gönder. Web uygulaması dağınıklığı ücretsiz tutar
Legalesign e-postalarını kullanma	do_email		boolean	Bildirim e-postaları göndermek için Legalesign e-postasını kullanın. False, tüm e-postaları gizler.
Tamamlandıktan sonra BILGI	cc_emails		string	İmzalama veya reddetme bildirimi alan virgülle ayrılmış e-posta adresleri dizesi.
Boş gönderen alanlarını ilk alıcı alanlarına dönüştürme	convert_sender_to_signer		boolean	Herhangi bir gönderen alanı boş bırakılırsa, bunları ilk alıcı için alanlara dönüştürün.
PDF parolası	pdf_password		string	Parola ayarlayın. Ascii kodlayabilen olmalıdır, ayrıca signature_type 4 olarak ayarlamanız ve bir pdf_password_type seçmeniz gerekir.
PDF parola ayarları	pdf_password_type		integer	Parolayı depolamak için 1, son imzalamadan sonra kayıtlarımızdan silmek için 2.
pdftext	pdftext		object	PDF gönderen alanlarına değer atayın, şablonun alan etiketini veya uuid değerini nesne anahtarları olarak kullanın. Etiket veya uuid ile ilgili alanları almak için bkz. templatepdf/:id/fields/ ve filter for element_type="admin". Ayrıca bkz. strict_fields.
Yeniden yönlendirme URL'si	redirect		string	İmzalamadan sonra imzalayanı göndermek için URL (indirme sayfası yerine). URL'niz şu kimlik ve durum bilgilerine sahip sorgu parametrelerini içerir: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status]
Anımsatıcı zamanlaması	reminders		string	Grupta varsayılan anımsatıcı zamanlamasını kullanmak istiyorsanız 'varsayılan' yazın (varsayılan zamanlamayı ayarlamak için web uygulamasına gidin)
İade imzalayan bağlantıları	return_signer_links		boolean	Yanıt GÖVDESInde imzalayanlar için belge bağlantılarını döndürün.
sıralama gönderme	signers_in_order		boolean	İmzalayanları sipariş sıralarında bilgilendirin. False ise, tümüne düzgün bir şekilde bildirilir.
signertext	signertext		object	İmzalayan alanlarına özel yer tutucular ekleyin. Nesnede anahtar olarak alan etiketleri veya uuid kullanın (pdftext için olduğu gibi). Etiketleriyle veya uuidleriyle ilgili alanları almak için bkz. templatepdf/:id/fields/ ve element_type = "text" filtresini kullanın.
Alan doğrulamayı zorunlu kılma	strict_fields		boolean	Pdftext doğrulama denetimlerini sessizce başarısız oluyor, doğrulayacak şekilde true olarak ayarlı.
Başvurunuz	tag		string	Etiket
Başvurunuz	tag1		string	Etiket
Başvurunuz	tag2		string	Etiket
user	user		string	Belgeye grupta başka bir kullanıcı atayın.

Belgeleri alma

İşlem Kimliği:

GetDocuments

Arşivlenmemiş imzalama belgelerini listeleyin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group	True	string	Gerekli olan belirli bir gruba göre filtreleyin.
Arşivlenmiş belgeleri dahil et	archived		string	Arşivlenmiş duruma göre filtreleyin, varsayılan olarak arşivlenmemiştir, tüm belgeleri sorgulamak için bu parametredeki tümü değerini kullanın.
Alıcı e-postaya göre filtreleme	email		string	Alıcı e-postaya göre filtreleyin.
Sorgu sınırı	limit		integer	Döndürülecek veri kümesinin uzunluğu. Sonuçlar arasında yineleme yapmak için uzaklık sorgusuyla kullanın.
Sorgu uzaklığı	offset		integer	Veri kümesinin başlangıcından uzaklık. Veri kümesinde yineleme yapmak için sınır sorgusuyla kullanın.
Belge durumuna göre filtrele	status		integer	Belge durumuna göre filtreleyin.
Alıcıları yanıttan kaldırma	nosigners		string	Daha hızlı bir sorgu için alıcı bilgilerini kaldırmak için 1 değerini ekleyin.
Bu tarihten sonra oluşturulan için filtre uygula	created_gt		date-time	Belirli bir süre sonra oluşturulan belgeler için filtreleyin.
Bu tarihten sonra değiştirilenler için filtre uygula	modified_gt		date-time	Belirli bir süre sonra değiştirilen belgeler için filtreleyin.

Döndürülenler

Belge listeleri

Body

DocumentListResponse

Belgeyi al

İşlem Kimliği:

GetDocument

Belirli bir belgeyi döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge kimliği

Döndürülenler

Belge ayrıntısı

Body

DocumentResponseDetail

Belgeyi geçersiz kılma ve arşivle

İşlem Kimliği:

UpdateArchiveDocument

Durumu 40 olan bir belgeyi ayarlar ve arşivler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge Kimliği
Alıcıya bildirim e-postası gönderme	email		string	True veya 1 olarak ayarlanırsa, alıcılara belgenin geçersiz olduğu bildirilir.

Belgeyi kalıcı olarak silme

İşlem Kimliği:

DeleteDocument

Verileri ve dosyaları kalıcı olarak siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge Kimliği

Ek alma

İşlem Kimliği:

GetAttachment

Ek alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ek Kimliği	attachId	True	uuid	Ek Kimliği

Döndürülenler

Öğe ekle'ye dokunun.

Body

AttachmentResponse

Eki silme

İşlem Kimliği:

DeleteAttachment

Eki silme.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ek Kimliği	attachId	True	uuid	Ekleme Kimliği

Ekleri alma

İşlem Kimliği:

GetAttachments

Ekleri listeleyin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group		string	Belirli bir gruba göre filtreleyin.
Sorgu sınırı	limit		integer	Sonuçlar arasında yineleme yapmak için uzaklık ile kullanın.
Sorgu uzaklığı	offset		integer	Sonuçlar arasında yineleme yapmak için sınır ile kullanın.

Döndürülenler

Ek Listesi

Body

AttachmentListResponse

Grubun üyesi

İşlem Kimliği:

GetMember

Bir grup içindeki belirli bir kullanıcının ayrıntıları.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Üye Kimliği	memberId	True	uuid	Üye Kimliği

Döndürülenler

Body

MemberResponse

Grupları alma

İşlem Kimliği:

GetGroups

Kullanıcının ait olduğu API gruplarını listeleyin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sorgu uzaklığı	offset		integer	Veri kümesinin başlangıcından uzaklık. Veri kümesinde yineleme yapmak için sınır sorgusuyla kullanın.
Sorgu sınırı	limit		integer	Döndürülecek veri kümesinin uzunluğu. Sonuçlar arasında yineleme yapmak için uzaklık sorgusuyla kullanın.

Döndürülenler

Gruplar listesi

Body

GroupListResponse

Grupların üyeleri

İşlem Kimliği:

GetMembers

Gruplarınızın tüm üyelerinin listesi.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group		string	Belirli bir gruba göre filtreleme
Sorgu sınırı	limit		integer	Sonuçlar arasında yineleme yapmak için uzaklık ile kullanın.
Sorgu uzaklığı	offset		integer	Sonuçlar arasında yineleme yapmak için sınır ile kullanın.

Döndürülenler

Body

MemberListResponse

Kullanıcı alma

İşlem Kimliği:

GetUser

Kullanıcı ayrıntılarını alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kullanıcı Kimliği	userId	True	uuid	Kullanıcı Kimliği

Döndürülenler

Kullanıcının ayrıntıları.

Body

UserDetailResponse

PDF eklenebilir bağlantı alma

İşlem Kimliği:

GetPdfTemplateEditLink

PDF düzenleyicisi eklemek için tek kullanımlık bir bağlantı döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Pdf Kimliği	pdfId	True	string	Karşıya yüklenen PDF Kimliğini ayarlayın.
İşlenen sayfadan alan listesini gizle	hide_sender_fields		boolean	İşlenen sayfadan alan listesini gizleyin.
Arka plan rengi için karma simgesi hariç onaltılık kod	css_body_backgroundcolor		string	Arka plan rengini değiştirmek için karma simgesi hariç onaltılık kod kullanın.

PDF eklerini karşıya yükleme

İşlem Kimliği:

PostAttachment

Alıcı e-postasına eklemek için pdf dosyasını kaydedin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
group	group	True	string	Grup kaynağı uri'si
pdf_file	pdf_file	True	byte	Base64 kodlanmış PDF dosyası verileri, maksimum boyut varsayılan olarak 5 MB olan bir grup ayarıdır.
filename	filename	True	string	.pdf biten basit alfasayısal ad
user	user		string	Başka bir kullanıcıya atayın.
açıklama	description		string

PDF şablonlarını alma

İşlem Kimliği:

GetPdfTemplates

PDF şablonlarını listeleme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group		string	Tam resource_uri veya yalnızca kimlik olabilir.
Sorgu sınırı	limit		integer	Döndürülecek veri kümesinin uzunluğu. Sonuçlar arasında yineleme yapmak için uzaklık sorgusuyla kullanın.
Sorgu uzaklığı	offset		integer	Veri kümesinin başlangıcından uzaklık. Veri kümesinde yineleme yapmak için sınır sorgusuyla kullanın.

Döndürülenler

Şablon listeleri

Body

TemplatePdfListResponse

PDF şablonu alma

İşlem Kimliği:

GetPdfTemplate

Belirli bir PDF şablonunun ayrıntıları

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Karşıya yüklenen PDF Kimliği	pdfId	True	uuid	Karşıya yüklenen PDF Kimliği

Döndürülenler

Şablon ayrıntıları

Body

TemplatePdfResponse

PDF şablonunu karşıya yükleme

İşlem Kimliği:

PostPdfTemplate

İmzalanması için göndermek istediğiniz PDF belgesini karşıya yükleyin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Göndererek arşivle	archive_upon_send		boolean	Bu karşıya yükleme yalnızca tek kullanımlık olacaksa true değerini ayarlayın.
Grup	group	True	string	Bunun kullanılacağı grubu belirtin.
PDF dosyası	pdf_file	True	byte	Base64 kodlanmış PDF dosyası verileri.
İşlem etiketleri	process_tags		boolean	Dosyada metin etiketleri varsa bunları alanlara dönüştürün.
Başlık	title		string	Bu kaydı adlandır, kullanılmazsa dosya adını kullanır.
User	user		string	Api kullanıcısı değilse grup üyesine atayın.

PDF’yi İndir

İşlem Kimliği:

GetDocumentPdf

İmzalama belgesinin durumuna bağlı olarak taslak veya son PDF dosyasını alın. 200 veya 302 yanıtının mümkün olduğunu unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	docId	True	uuid	Belge Kimliği

Döndürülenler

response

file

Tetikleyiciler

Alıcı olayı	Alıcı olayının gerçekleştiği durumlar için tetikleyici
Belge olayı	Bir belge olayı için tetikleyici oluşuyor

Alıcı olayı

İşlem Kimliği:

RecipientTrigger

Alıcı olayının gerçekleştiği durumlar için tetikleyici

Parametreler

Name	Anahtar	Gerekli	Tür	Description
eventFilter	eventFilter	True	string	Olay filtresi
group	group		string	Grup filtresi

Döndürülenler

Name	Yol	Tür	Description
version	version	string	Sürüm
object	object	string	Nesne
tag	data.tag	string	Etiket
etiket1	data.tag1	string	Etiket1
etiket2	data.tag2	string	Etiket2
UUID (evrensel benzersiz tanımlayıcı)	data.uuid	string	Alıcı Kimliği
e-posta	data.email	string	E-posta
group	data.group	string	Grup
order	data.order	integer	Sipariş
statü	data.status	integer	Statü
belge	data.document	string	Belge
soyadı	data.lastname	string	Soyadı
roleText	data.roleText	string	Rol metni
ilk ad	data.firstname	string	İsim
durum metni	data.statusText	string	Durum metni
emailBounce	data.emailBounce	integer	E-posta geri döndü
resourceUri	data.resourceUri	string	Alıcı kaynak uri'si
belge adı	data.documentName	string	Belge adı
rejectReason	data.rejectReason	string	Reddetme nedeni
groupResourceUri	data.groupResourceUri	string	Grup kaynağı uri'si
emailBounceMessage	data.emailBounceMessage	string	E-posta geri dönen iletisi
documentResourceUri	data.documentResourceUri	string	Belge kaynağı uri'si
created	created	integer	Oluşturuldu
kimlik	id	string	Kimlik
etkinlik	event	string	Event

Belge olayı

İşlem Kimliği:

DocumentTrigger

Bir belge olayı için tetikleyici oluşuyor

Parametreler

Name	Anahtar	Gerekli	Tür	Description
eventFilter	eventFilter	True	string	Olay filtresi
group	group		string	Grup filtresi

Döndürülenler

Name	Yol	Tür	Description
version	version	string	Sürüm
object	object	string	Nesne
etiket1	data.tag1	string	Etiket
recipients	data.recipients	array of object	Alıcı
UUID (evrensel benzersiz tanımlayıcı)	data.recipients.uuid	string	Alıcı Kimliği
e-posta	data.recipients.email	string	Alıcı e-postası
order	data.recipients.order	integer	Alıcı sipariş numarası
statü	data.recipients.status	integer	Alıcı durumu
soyadı	data.recipients.lastname	string	Alıcı soyadı
roleText	data.recipients.roleText	string	Alıcı rolü metni
ilk ad	data.recipients.firstname	string	Alıcının adı
durum metni	data.recipients.statusText	string	Alıcı durumuMetin
resourceUri	data.recipients.resourceUri	string	Alıcı kaynak uri'si
rejectReason	data.recipients.rejectReason	string	rejectReason
groupResourceUri	data.groupResourceUri	string	Grup kaynağı uri'si
durum metni	data.statusText	string	Belge durum metni
name	data.name	string	Belge adı
tag	data.tag	string	Etiket
resourceUri	data.resourceUri	string	Kaynak uri'si
UUID (evrensel benzersiz tanımlayıcı)	data.uuid	string	Belge Kimliği
etiket2	data.tag2	string	Etiket2
group	data.group	string	Grup
statü	data.status	integer	Belge durumu
created	created	integer	Oluşturuldu
kimlik	id	string	Yaptı
etkinlik	event	string	Event

Tanımlar

İzinlerEnum

İzin seçenekleri

İzin seçenekleri

integer

ListMeta

Listeleme hakkındaki meta bilgiler.

Name	Yol	Tür	Description
limit	limit	integer	En fazla nesne sayısı.
next	next	string	Sonraki nesne kümesinin URL'si.
offset	offset	integer	Sonuç kümesinin başlangıcındaki öğe sayısı.
önceki	previous	string	Önceki nesne kümesinin URL'si.
total_count	total_count	integer	Toplam nesne sayısı.

GroupListResponse

Gruplar listesi

Name	Yol	Tür	Description
Meta	meta	ListMeta	Listeleme hakkındaki meta bilgiler.
nesneleri	objects	array of object
created	objects.created	date-time	Oluşturuldu
is_active	objects.is_active	boolean	Aktif
Değiştirilmiş	objects.modified	date-time	Değiştirildi
name	objects.name	string	İsim
public_name	objects.public_name	string	Ortak ad
resource_uri	objects.resource_uri	string	Kaynak uri'si
sümüklüböcek	objects.slug	string	Benzersiz ad
user	objects.user	string	Oluşturucu kaynak uri'si
xframe_allow	objects.xframe_allow	boolean	Ekleme imzalamaya izin ver
xframe_allow_pdf_edit	objects.xframe_allow_pdf_edit	boolean	Ekleme düzenlemesine izin ver

TemplatePdfListResponse

Şablon listeleri

Name	Yol	Tür	Description
Meta	meta	ListMeta	Listeleme hakkındaki meta bilgiler.
nesneleri	objects	array of TemplatePdfResponse

TemplatePdfResponse

Şablon ayrıntıları

Name	Yol	Tür	Description
created	created	date-time	Oluşturuldu
group	group	string	Grup uri'si
Değiştirilmiş	modified	date-time	Değiştirildi
Parti	parties	string	JSON dizeli belge taraf dizisi.
page_count	page_count	integer	Sayfa sayısı
resource_uri	resource_uri	string	Kaynak uri'si
signer_count	signer_count	integer	İmzalayan sayısı
title	title	string	Başlık
user	user	string	Oluşturucunun kaynak uri'si
UUID (evrensel benzersiz tanımlayıcı)	uuid	uuid	Pdf Kimliği
geçerli	valid	boolean	Gönderilebilir (alanlar doğrulanmıyorsa).

DocumentListResponse

Belge listeleri

Name	Yol	Tür	Description
Meta	meta	ListMeta	Listeleme hakkındaki meta bilgiler.
nesneleri	objects	array of object	Documents
Arşivlenmiş	objects.archived	boolean	Arşivlenmiş
auto_archive	objects.auto_archive	boolean	Gönderdikten sonra arşivle.
cc_emails	objects.cc_emails	string	Tamamlandığında bilgi için virgülle ayrılmış liste e-postaları.
created	objects.created	date-time	Oluşturuldu
do_email	objects.do_email	boolean	Legalesign e-postalarını kullanın.
download_final	objects.download_final	boolean	tamamlandıktan sonra indirilmeye hazır.
group	objects.group	string	Grup kaynağı uri'si.
Değiştirilmiş	objects.modified	date-time	Değiştirildi
name	objects.name	string	Belge adı
pdftext	objects.pdftext	string	Gönderen alanı değerleri
Yönlendirme	objects.redirect	string	İmzaladıktan sonra alıcıyı yeniden yönlendirme URL'si
resource_uri	objects.resource_uri	string	Kaynak uri'si
return_signer_links	objects.return_signer_links	boolean	Yanıta alıcı bağlantıları ekleme
Imzalayanların	objects.signers	array of array	İmzalayan ayrıntılarıyla iç içe diziler
items	objects.signers	array of	Her zaman [imzalayan uri, ad, soyadı, e-posta, sms numarası, has_fields, durum, imzalayan siparişi (0 dizinli)] içerir
signers_in_order	objects.signers_in_order	integer	Alıcıları düzenli veya sıralı olarak e-postayla gönderme
statü	objects.status	DocumentStatusEnum	Belge durumu seçenekleri: 10 - İlk durum, imzalayan kişi durumunu gönderilmiş/gönderilmemiş olarak denetle 20 - Tamamlanan alanlar 30 - İmzalı 40 - Kaldırıldı (imzalamadan önce) 50 - Reddedildi
tag	objects.tag	string	Belgeyi etiketleme
etiket1	objects.tag1	string	Belgeyi etiketleme
etiket2	objects.tag2	string	Belgeyi etiketleme
şablon	objects.template	string	Kullanılırsa şablon kaynak uri'si
templatepdf	objects.templatepdf	string	PDF şablonu kaynak uri'si
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.	objects.text	string	İmzalama metni
user	objects.user	string	Oluşturucu uri'si
UUID (evrensel benzersiz tanımlayıcı)	objects.uuid	uuid	Belge Kimliği

DocumentStatusEnum

Belge durumu seçenekleri:

• 10 - İlk durum, imzalayan kişi durumunu gönderilmiş/gönderilmemiş olarak denetle
• 20 - Tamamlanan alanlar
• 30 - İmzalı
• 40 - Kaldırıldı (imzalamadan önce)
• 50 - Reddedildi

Belge durumu seçenekleri:

• 10 - İlk durum, imzalayan kişi durumunu gönderilmiş/gönderilmemiş olarak denetle
• 20 - Tamamlanan alanlar
• 30 - İmzalı
• 40 - Kaldırıldı (imzalamadan önce)
• 50 - Reddedildi

integer

SignerResponse

Alıcı ayrıntıları

Name	Yol	Tür	Description
belge	document	string	Belge
e-posta	email	string	Alıcı e-postası
ilk ad	first_name	string	Alıcının adı
soyadı	last_name	string	Alıcının soyadı
has_fields	has_fields	boolean	Alıcının alanları var
order	order	integer	Alıcı siparişi
resource_uri	resource_uri	string	Alıcı kaynak uri'si
statü	status	SignerStatusEnum	İmzalayan durum seçenekleri: 4 - kullanılmamış 5 - gönderilmek üzere zamanlanmış 10 - gönderildi 15 - e-posta açıldı 20 - ziyaret edildi 30 - alanlar tamamlandı 35 - alanlar tamamlandı ex imzası 39 - Tanığın tamamlanmasını bekliyor 40 - imzalı 50 - indirildi 60 - reddedildi

SignerStatusEnum

İmzalayan durum seçenekleri:

• 4 - kullanılmamış
• 5 - gönderilmek üzere zamanlanmış
• 10 - gönderildi
• 15 - e-posta açıldı
• 20 - ziyaret edildi
• 30 - alanlar tamamlandı
• 35 - alanlar tamamlandı ex imzası
• 39 - Tanığın tamamlanmasını bekliyor
• 40 - imzalı
• 50 - indirildi
• 60 - reddedildi

İmzalayan durum seçenekleri:

• 4 - kullanılmamış
• 5 - gönderilmek üzere zamanlanmış
• 10 - gönderildi
• 15 - e-posta açıldı
• 20 - ziyaret edildi
• 30 - alanlar tamamlandı
• 35 - alanlar tamamlandı ex imzası
• 39 - Tanığın tamamlanmasını bekliyor
• 40 - imzalı
• 50 - indirildi
• 60 - reddedildi

integer

DocumentResponseDetail

Belge ayrıntısı

Name	Yol	Tür	Description
Arşivlenmiş	archived	boolean	Arşivlenmiş
auto_archive	auto_archive	boolean	İmzalamadan sonra belge arşivi gönderme.
cc_emails	cc_emails	string	İmzalandığında e-posta bildiriminde gönderenle kim bilgi sahibi olur?
created	created	date-time	Oluşturuldu
do_email	do_email	boolean	Legalesign e-postalarını kullanma
download_final	download_final	boolean	Son PDF'yi indirebilirsiniz
Altbilgi	footer	string	HTML belgeleri - kullanıldıysa alt bilgi metni
footer_height	footer_height	integer	HTMl belgeleri - kullanılıyorsa alt bilginin piksel yüksekliği
group	group	string	Grubun kaynak uri'si
has_fields	has_fields	boolean	Belgenin alanları var
hash_value	hash_value	string	Son belgenin SHA256 sağlama toplamı, son PDF indirmenizi doğrulamak için bunu kullanın
üstbilgi	header	string	HTML belgeleri - kullanıldıysa üst bilgi metni
header_height	header_height	integer	HTMl belgeleri - kullanılıyorsa üst bilginin piksel yüksekliği
Değiştirilmiş	modified	date-time	Değiştirildi
name	name	string	Belge adı
pdf_password	pdf_password	string	PDF parolası
pdf_password_type	pdf_password_type	string	Pdf parolası korunduysa
pdftext	pdftext	string	Bunu yoksay
Yönlendirme	redirect	string	İmzalamadan sonra alıcı yeniden yönlendirme url'si
resource_uri	resource_uri	string	Kaynak uri'si
return_signer_links	return_signer_links	boolean	Yok say
sign_mouse	sign_mouse	boolean	yok saymak
sign_time	sign_time	date-time	İmza zamanı
sign_type	sign_type	boolean	miras
sign_upload	sign_upload	boolean	miras
signature_placement	signature_placement	integer	miras
signature_type	signature_type	integer	eski - her zaman 4
Imzalayanların	signers	array of array	İmzalayan ayrıntılarıyla iç içe diziler
items	signers	array of	Her zaman [imzalayan uri, ad, soyadı, e-posta, sms numarası, has_fields, durum, imzalayan siparişi (0 dizinli)] içerir
signer_objects	signer_objects	array of object	Alıcı listesi
e-posta	signer_objects.email	string	E-posta
ilk ad	signer_objects.firstname	string	İsim
soyadı	signer_objects.lastname	string	Soyadı
tel	signer_objects.tel	string	Tel numarası
order	signer_objects.order	integer	İmzalama sırası
resource_uri	signer_objects.resource_uri	string	Kaynak uri'si
role	signer_objects.role	string	Rol
statü	signer_objects.status	integer	Alıcı durum kodu
UUID (evrensel benzersiz tanımlayıcı)	signer_objects.uuid	string	Alıcı Kimliği
signers_in_order	signers_in_order	boolean	Alıcıları düzenli veya sıralı olarak e-postayla gönderme
statü	status	DocumentStatusEnum	Belge durumu seçenekleri: 10 - İlk durum, imzalayan kişi durumunu gönderilmiş/gönderilmemiş olarak denetle 20 - Tamamlanan alanlar 30 - İmzalı 40 - Kaldırıldı (imzalamadan önce) 50 - Reddedildi
tag	tag	string	Başvurunuz
etiket1	tag1	string	Başvurunuz
etiket2	tag2	string	Başvurunuz
şablon	template	string	Kullanılırsa metin şablonu için kaynak uri'si
templatepdf	templatepdf	string	Kullanılıyorsa pdf şablonu için kaynak uri'si
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.	text	string	Kullanıldıysa belge metni
user	user	string	Kullanıcı kaynağı uri'si.
UUID (evrensel benzersiz tanımlayıcı)	uuid	uuid	Belge Kimliği

MemberListResponse

Name	Yol	Tür	Description
Meta	meta	ListMeta	Listeleme hakkındaki meta bilgiler.
nesneleri	objects	array of MemberResponse

MemberResponse

Name	Yol	Tür	Description
created	created	date-time	Oluşturuldu
group	group	string	Grup kaynağı uri'si
Değiştirilmiş	modified	date-time	Değiştirildi
izin	permission	PermissionsEnum	İzin seçenekleri
resource_uri	resource_uri	string	Kaynak uri'si
user	user	string	Kullanıcı kaynağı uri'si.

AttachmentResponse

Öğe ekle'ye dokunun.

Name	Yol	Tür	Description
created	created	date-time	Oluşturuldu
açıklama	description	string	Description
filename	filename	string	Dosya adı
group	group	string	Grup
resource_uri	resource_uri	string	Kaynak uri'si ekleme
user	user	string	Kullanıcı kaynağı uri'si
UUID (evrensel benzersiz tanımlayıcı)	uuid	uuid	Ekleme Kimliği

AttachmentListResponse

Ek Listesi

Name	Yol	Tür	Description
Meta	meta	ListMeta	Listeleme hakkındaki meta bilgiler.
nesneleri	objects	array of object	Liste
created	objects.created	date-time	Oluşturuldu
açıklama	objects.description	string	Description
filename	objects.filename	string	Dosya adı
group	objects.group	string	Grup
resource_uri	objects.resource_uri	string	Kaynak uri'si
user	objects.user	string	Kullanıcı kaynağı uri'si
UUID (evrensel benzersiz tanımlayıcı)	objects.uuid	uuid	Ekleme Kimliği

UserDetailResponse

Kullanıcının ayrıntıları.

Name	Yol	Tür	Description
date_joined	date_joined	date-time	Katılma tarihi
e-posta	email	email	E-posta
ilk ad	first_name	string	İsim
groups	groups	array of string	Bu kullanıcının katıldığı grupların listesi.
last_login	last_login	date-time	Son oturum açma
soyadı	last_name	string	Soyadı
resource_uri	resource_uri	string	Kaynak uri'si
timezone	timezone	string	Saat dilimi
kullanıcı adı	username	string	Kullanıcı adı

file

Bu, 'file' temel veri türüdür.