Oturum Açma

SignNow, işletmeler, hukuk, İk, sağlık ve finans ekipleri için güvenli, uyumlu ve denetime hazır eSignature iş akışları sağlar. SignNow bağlayıcısını kullanarak imza isteklerini rol tabanlı sırayla gönderin ve izleyin, belge alanlarını önceden doldurun ve belge gruplarını yönetin.

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 :      - 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 Çin bölgeleri      - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri :      - 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 :      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	Yardım Merkezi
URL	https://support.signnow.com/
E-posta	integrations@pdffiller.com

Bağlayıcı Meta Verileri
Publisher	DaDaDocs
Web sitesi	https://signnow.com
Gizlilik ilkesi	https://www.signnow.com/privacy_policy
Kategoriler	Verimli -lik; İnsan Kaynakları

SignNow Bağlayıcısı

SignNow, işletmeler, hukuk, İk, sağlık ve finans ekipleri için güvenli, uyumlu ve denetime hazır eSignature iş akışları sağlar. SignNow bağlayıcısını kullanarak imza isteklerini rol tabanlı sırayla gönderin ve izleyin, belge alanlarını önceden doldurun ve belge gruplarını yönetin.

Pre-requisites

Devam etmek için bir SignNow hesabına ve SignNow API aboneliğine sahip olmanız gerekir.

Örneği dağıtma

İlk olarak, apiProperties.json içindeki clientId değerini kendi değerinizle güncelleştirin.

Aşağıdaki komutları çalıştırın ve istemleri izleyin:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Desteklenen Eylemler ve Tetikleyiciler

Diğer ayrıntılar için belgelere bakın.

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	100	60 saniye

Eylemler

Akıllı Alan Değerlerini Önceden Doldur	Belirtilen belge için Akıllı Alan değerlerini önceden doldurma
Belge Alanlarını Al	Belgedeki doldurulabilir alanlardan değerleri alma
Belge Alanlarını Alma [KULLANIM DIŞI]	Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge Alanlarını Al'ı kullanın. Belge alanı değerlerini alma.
Belge Alanı Değerlerini Önceden Doldur	Belgedeki doldurulabilir alanları belirli değerlerle otomatik olarak doldurma
Belge Alanı Değerlerini Önceden Doldur [KULLANIM DIŞI]	Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belge Alanı Değerlerini Önceden Doldur'a tıklayın . Alan değerlerini ve özelliklerini önceden doldurun.
Belge Bilgilerini Al	Ad, kimlik, oluşturma/güncelleştirme tarihleri gibi belge özelliklerini alın.
Belge Davet Durumunu Al	Bu eylem, her adımın ve eylemin durumu da dahil olmak üzere bir belge daveti hakkındaki bilgileri alır
Belge Davetindeki Alıcıları Değiştirme	Bu eylem, belge davetindeki alıcıların rollerinin yerini alır. Ayrıca kimlik doğrulama türü, son kullanma günleri ve her rol için diğer gelişmiş parametreler gibi davet ayarlarının güncelleştirilmesini sağlar
Belge Eklenmiş Davet Bağlantısı Oluştur	Bu eylem, belge eklenmiş davet için bir bağlantı oluşturur
Belge Eklenmiş Davet Oluşturma	Bu eylem, belge için eklenmiş bir imzalama daveti oluşturur. Davet oluşturulduktan sonra eklenmiş bir imzalama bağlantısı oluşturun
Belge Eklenmiş Daveti Sil	Bu eylem, belge için eklenmiş daveti siler
Belge Eklenmiş Gönderme Bağlantısı Oluştur	Bu eylem, belirli bir belge için ekli bir gönderme bağlantısı oluşturarak üçüncü taraf kullanıcıların belgeyi imza için hazırlamasına ve göndermesine olanak sağlar
Belge Grubu Akıllı Alan Değerlerini Önceden Doldur	Belgelerdeki akıllı alanları belirli değerlerle otomatik olarak doldurma
Belge Grubu Alan Değerlerini Önceden Doldur	Belgelerdeki doldurulabilir alanları belirli değerlerle otomatik olarak doldurma
Belge Grubu Davet Durumunu Alma	Bu eylem, her adımın ve eylemin durumu dahil olmak üzere belge grubu daveti hakkındaki bilgileri alır
Belge Grubu Davetindeki Alıcıları Değiştirme	Bu eylem, bir belge grubu davetindeki alıcıların yerini davet kimliğine göre değiştirir. Ayrıca, her belge için davet süre sonu, anımsatıcılar, yeniden atama izinleri ve reddetme seçenekleri ayarlayabilirsiniz
Belge Grubu Eklenmiş Davet Bağlantısı Oluştur	Bu eylem, belge grubu eklenmiş davet için bir bağlantı oluşturur
Belge Grubu Eklenmiş Davet Oluşturma	Bu eylem, belge grubu için ekli imzalama daveti oluşturur. Davet oluşturulduktan sonra eklenmiş bir imzalama bağlantısı oluşturun
Belge Grubu Eklenmiş Daveti Sil	Bu eylem, belirli bir belge grubu için eklenmiş daveti siler
Belge Grubu Eklenmiş Gönderme Bağlantısı Oluştur	Bu eylem, belirli bir belge grubu için ekli bir gönderme bağlantısı oluşturarak üçüncü taraf kullanıcıların belge grubunu imza için hazırlamasına ve göndermesine olanak sağlar
Belge Grubunu Al	Kullanıcının belge gruplarının listesini alma
Belge Grubunu İmzala'ya Davet Et	Bu eylem, belge grubunu imzalamak için bir davet oluşturur. Farklı alıcıların belge grubu üzerinde farklı aşamalarda işlem yaptığı çok adımlı bir iş akışı yapılandırabilirsiniz
Belge Gruplarını Alma	Kullanıcının belge gruplarının listesini alma
Belge Listesini Al	Kullanıcının belgelerinin listesini alma
Belge şemasını alma [KULLANIM DIŞI]	Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belge şemasını al'ı kullanın. OpenAPI belge şemasını alma
Belgeyi İmzala'ya Davet Et	Bu eylem, belgenin imzalanması için alan daveti oluşturur ve gönderir
Belgeyi İndir	SignNow'dan belge indirme
Belgeyi Karşıya Yükle	SignNow'a belge yükleme
Belgeyi Sil	SignNow'dan belge silme
Birden Çok Dosyadan Belge Grubu Oluşturma	Base64 ile kodlanmış dizeler olarak birden çok dosya yükleyerek belge grubu oluşturma
Daveti iptal et	İmza daveti iptali
Grup Şablonundan Belge Grubu Oluşturma	Seçili grup şablonundan belge grubu oluşturma
İmzalama Bağlantısı Oluştur	Belgenin bağlantısını oluşturma ve belgenin imzalı olması için bu bağlantıyı paylaşma
Kullanım dışı - Belge Grubunu imzalamaya davet et	Eylem kullanım dışı bırakıldı. Belge grubunu doldurmak ve imzalamak için başkalarını davet etme
Kullanım dışı - Gelişmiş Belge Daveti	Eylem kullanım dışı bırakıldı. El ile tanımlanmış şemayla davet isteği. Gelecekte oluşturulacak bir belge için davet ayarlamaya olanak tanır
Kullanım dışı - İmzaya davet et	Eylem kullanım dışı bırakıldı. Diğer kişileri belgeyi doldurmaya ve imzalamaya davet etme
Şablondan Belge Oluştur	Seçili şablondan belge oluşturma

Akıllı Alan Değerlerini Önceden Doldur

İşlem Kimliği:

PrefillSmartFields

Belirtilen belge için Akıllı Alan değerlerini önceden doldurma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_id	True	string	Alanları almak için bir belge şablonu belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin
Alanları	fields		dynamic

Belge Alanlarını Al

İşlem Kimliği:

GetDocFields_V2

Belgedeki doldurulabilir alanlardan değerleri alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_id	True	string	Alanları almak için bir belge şablonu belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin

Döndürülenler

Bu işlemin çıkışları dinamiktir.

Belge Alanlarını Alma [KULLANIM DIŞI]

İşlem Kimliği:

GetDocFields

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge Alanlarını Al'ı kullanın.

Belge alanı değerlerini alma.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_id	True	string	Alanları almak için bir belge şablonu belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin

Döndürülenler

Bu işlemin çıkışları dinamiktir.

Belge Alanı Değerlerini Önceden Doldur

İşlem Kimliği:

UpdateFieldValues_V2

Belgedeki doldurulabilir alanları belirli değerlerle otomatik olarak doldurma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_id	True	string	Alanları almak için bir belge şablonu belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin
Alanları	fields		dynamic

Döndürülenler

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği

Belge Alanı Değerlerini Önceden Doldur [KULLANIM DIŞI]

İşlem Kimliği:

UpdateFieldValues

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belge Alanı Değerlerini Önceden Doldur'a tıklayın .

Alan değerlerini ve özelliklerini önceden doldurun.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_id	True	string	Alanları almak için bir belge şablonu belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin
Alanları	fields		dynamic

Döndürülenler

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği

Belge Bilgilerini Al

İşlem Kimliği:

GetDoc

Ad, kimlik, oluşturma/güncelleştirme tarihleri gibi belge özelliklerini alın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template	True	boolean	Belgelerin veya şablonların alınması gerekip gerekmediğini belirtin
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin veya listeden bir belge seçin

Döndürülenler

Body

DocumentProperties

Belge Davet Durumunu Al

İşlem Kimliği:

GetInviteStatus

Bu eylem, her adımın ve eylemin durumu da dahil olmak üzere bir belge daveti hakkındaki bilgileri alır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği

Döndürülenler

Name	Yol	Tür	Description
Belge Reddedildi	is_document_declined	boolean	Belge imzalayan veya onaylayan tarafından reddedildiyse true, aksi takdirde yanlış
steps	steps	array of object	Steps
İmzalama Sırası	steps.signing_order	integer	İmzalama sırası
Alıcı E-postası	steps.signer_email	string	Alıcı e-posta adresi
Rol Adı	steps.role_name	string	Alıcı rolü adı
Eylem Türü	steps.action_type	string	Belgedeki alıcıdan gereken eylem. Olası değerler: 'Sign', 'View', 'Approve' veya 'FreeFormSign'
Davet Kimliği	steps.invite_id	string	Davet Kimliği
Statü	steps.status	string	İmzalama durumu. Olası değerler: 'created', 'pending', 'fulfilled', 'canceled', 'skipped'
Reddedildi	steps.declined	boolean	Bu adımın alıcısı belgeyi reddettiyse 'true' döndürür
Reddetme Nedeni	steps.decline_reason	string	Belge reddedildiğinde alıcı tarafından sağlanan ileti
Oluşturuldu	steps.created	integer	Adımın oluşturulduğu tarih
Updated	steps.updated	integer	Adım durumunun en son güncelleştirilildiği tarih

Belge Davetindeki Alıcıları Değiştirme

İşlem Kimliği:

ReplaceRecipientsInDocumentInvite

Bu eylem, belge davetindeki alıcıların rollerinin yerini alır. Ayrıca kimlik doğrulama türü, son kullanma günleri ve her rol için diğer gelişmiş parametreler gibi davet ayarlarının güncelleştirilmesini sağlar

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği
Rol	role	True	string	Değiştirilecek alıcının rol adı
Yeni E-posta	email	True	string	Yeni alıcı e-postası
Rol	role	True	string	Ek davet parametreleri gerektiren rol adı
Son Kullanma Günleri	expiration_days		integer	Davetin süresi kaç gün içinde dolar. En fazla 30 gün
İmzaya Göre Reddetmeye İzin Ver	decline_by_signature		boolean	İmza alanlarında İmzaya Reddet seçeneğinin gösterilip gösterilmeyeceğini tanımlar. Doğru: reddetme seçeneğini gösterin; Yanlış: Reddetme seçeneğini gizleme
Hatırlatma	reminder		integer	Alıcıya anımsatıcı göndermek için kaç gün içinde. En fazla 30 gün
Kimlik Doğrulaması Türü	authentication_type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Kimlik Doğrulama Parolası	authentication_password		string	İmzalayan kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Kimlik Doğrulama Telefonu	authentication_phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Kimlik Doğrulaması Sms İletisi	authentication_sms_message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow belge davet kilidini açma kodu: 123456'. Örnek: Belgenizin kilidini açmak için {password} parolasını girin

Döndürülenler

Name	Yol	Tür	Description
Değişiklik	replacements	array of object	Yeni alıcıların ayrıntıları
Yeni Davet Kimliği	replacements.new_invite_id	string	Yeni alan davet kimliği
Rol	replacements.role	string	Değiştirilen alıcının rol adı
Yeni E-posta	replacements.new_email	string	Yeni alıcı e-postası

Belge Eklenmiş Davet Bağlantısı Oluştur

İşlem Kimliği:

GenerateEmbeddedInviteLink

Bu eylem, belge eklenmiş davet için bir bağlantı oluşturur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği
Alan Davet Kimliği	field_invite_id	True	string	'Belge Eklenmiş Davet Oluştur' eyleminden eklenmiş davet kimliği
Bağlantı Süre Sonu	link_expiration		integer	Bağlantının kaç dakika etkin kalacağını belirtir. Geçerli aralık:15-45 dakika
Oturum Süre Sonu	session_expiration		integer	İmzalama oturumunun kaç dakika etkin kalacağını belirtir. Geçerli aralık:15-1440 dakika

Döndürülenler

Name	Yol	Tür	Description
Link	data.link	string	Belge için eklenmiş davet bağlantısı oluşturuldu

Belge Eklenmiş Davet Oluşturma

İşlem Kimliği:

CreateEmbeddedInvites

Bu eylem, belge için eklenmiş bir imzalama daveti oluşturur. Davet oluşturulduktan sonra eklenmiş bir imzalama bağlantısı oluşturun

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği
İmzalayan E-postası	email	True	email	Alıcı e-posta adresi
Rol	role	True	string	Alıcı rolü adı (örneğin, 'İmzalayan 1' (görüntüleyici rolleri desteklenmez)
Sipariş	order	True	integer	İmzalama sırası
Ad Formülü	name_formula		string	Ön ek (herhangi bir metin) ve doldurulabilir alan verileri kullanarak tamamlanmış bir belge adı oluşturmaya yönelik formül. Örnek: 'Sözleşme|signer_name|signed_date'; burada 'Sözleşme' ön ek, 'signer_name' ve 'signed_date' doldurulabilir alanların adlarıdır
Rol	role	True	string	Alıcı rolü adı (örneğin, 'İmzalayan 1' (görüntüleyici rolleri desteklenmez)
Language	language		string	İmzalayan için imzalama oturumunun dilini ve bildirim e-postalarını belirtir. Olası değerler: İngilizce için En, İspanyolca için Es ve Fransızca için Fr. Ayarlanmamışsa, dil SignNow hesabınızın diline göre belirlenir
İlk İsim	first_name		string	Alıcının adı
Soyadı	last_name		string	Alıcının soyadı
Gerekli Önceden Ayarlanmış İmza Adı	required_preset_signature_name		string	İmza alanı için, alıcı tarafından düzenlemeye karşı kilitlenmiş, önceden doldurulmuş metin. 'prefill_signature_name' veya 'force_new_signature' ile kullanılamaz
İmza Adını Önceden Doldur	prefill_signature_name		string	İmzalayan bir imza alanına tıkladığında görüntülenen imza adına sahip bir dize. İmzalayan imzayı düzenleyebilir
Yeni İmza gerektir	force_new_signature		boolean	İmzalayanın kaydedilmiş imzasını kullanıp kullanamayacağını tanımlar. 'true' olarak ayarlanırsa, imzalayanın yeni bir imza eklemesi gerekir. 'false' olarak ayarlanırsa, imzalayan kaydedilen imzayı kullanabilir
Yeniden Yönlendirme Uri'si	redirect_uri		string	İmzalama oturumu tamamlandıktan sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini Reddet	decline_redirect_uri		string	Alıcı belgeyi imzalamayı reddettikten sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini kapat	close_redirect_uri		string	Alıcı, imzalama oturumu sırasında İlerlemeyi Kaydet ve Daha Sonra Bitir'e veya Görünüm modunda kapat'a tıkladığında açılan bağlantı
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar
Kimlik Doğrulaması Türü	authentication_type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Kimlik Doğrulama Parolası	authentication_password		string	İmzalayan kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Kimlik Doğrulama Telefonu	authentication_phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Kimlik Doğrulaması Sms İletisi	authentication_sms_message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow document invite unlock code: 123456' Örnek: Belgenizin kilidini açmak için {password} parolasını girin
Teslim Türü	delivery_type		string	Davetin nasıl gönderileceğini tanımlar
Bağlantı Süre Sonu	link_expiration		integer	E-posta davetinin süresi kaç dakika içinde dolar. Yalnızca 'Teslim türü=e-posta' olduğunda kullanılabilir. Geçerli aralık: 15-43200 dakika
Oturum Süre Sonu	session_expiration		integer	İmzalama oturumunun süresi kaç dakika içinde dolar. Bu davet için bir bağlantı oluşturulursa oturum süre sonu sıfırlanır. Yalnızca 'Delivery type=email' ve 'sign' eylemleri için geçerlidir. Geçerli aralık: 15-1440 dakika
QES İmzası	signature		string	QES türü. Olası değerler: 'Eideasy', 'Nom151'. İmzalayanlardan QES imzaları istemek için kullanılır. Davetteki tüm imzalayanların aynı imza türünü kullanması gerekir. QES ile davet oluşturmak için kullanıcının QES'nin etkin olduğu bir kuruluşa ait olması gerekir

Döndürülenler

Name	Yol	Tür	Description
veriler	data	array of object	Data
Kimlik	data.id	string	Oluşturulan eklenmiş davetin kimliği
E-posta	data.email	string	Alıcı e-postası
Rol Kimliği	data.role_id	string	Alıcı rolü kimliği
Sipariş	data.order	integer	Alıcı imzalama sırası
Statü	data.status	string	Eklenmiş davet durumu

Belge Eklenmiş Daveti Sil

İşlem Kimliği:

DeleteEmbeddedInvites

Bu eylem, belge için eklenmiş daveti siler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği

Belge Eklenmiş Gönderme Bağlantısı Oluştur

İşlem Kimliği:

CreateEmbeddedInviteSettingsLink

Bu eylem, belirli bir belge için ekli bir gönderme bağlantısı oluşturarak üçüncü taraf kullanıcıların belgeyi imza için hazırlamasına ve göndermesine olanak sağlar

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği
Türü	type		string	Bağlantının açılması gereken gönderme adımını belirtir. Olası değerler: 'Davet Et': Kullanıcının imzalayan e-postalar, konu, ileti vb. ekleyebileceği belgenin Davet Gönder sayfasını açar. 'Belge': doldurulabilir alanlar eklemek için belgeyi düzenleyicide açar, ardından Davet Gönder sayfasını açar
Yeniden Yönlendirme Uri'si	redirect_uri		string	Ekli göndermeden sonra açılan sayfa ayarlandı. 'Yeniden yönlendirme hedefi' eklenirse gereklidir
Bağlantı Süre Sonu	link_expiration		integer	Bağlantının kaç dakika etkin kalacağını belirtir. İzin verilen aralık: 15 ila 45 dakika. Yönetici düzeyindeki kullanıcılar en fazla 43200 dakikaya kadar süreyi ayarlayabilir
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar

Döndürülenler

Name	Yol	Tür	Description
Bağlantı	url	string	Ekli belge gönderme bağlantısı

Belge Grubu Akıllı Alan Değerlerini Önceden Doldur

İşlem Kimliği:

UpdateGroupSmartFieldValues

Belgelerdeki akıllı alanları belirli değerlerle otomatik olarak doldurma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_group_id	True	string	Alanları almak için bir belge grubu şablonu belirtin
Belge Grubu Kimliği	doc_group_id	True	string	Benzersiz bir belge grubu kimliği belirtin
Alanları	fields		dynamic

Döndürülenler

Name	Yol	Tür	Description
Belge Grubu Kimliği	id	DocumentGroupId	Benzersiz Belge Grubu Kimliği

Belge Grubu Alan Değerlerini Önceden Doldur

İşlem Kimliği:

UpdateGroupFieldValues

Belgelerdeki doldurulabilir alanları belirli değerlerle otomatik olarak doldurma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template_group_id	True	string	Alanları almak için bir belge grubu şablonu belirtin
Belge Grubu Kimliği	doc_group_id	True	string	Benzersiz bir belge grubu kimliği belirtin
Alanları	fields		dynamic

Döndürülenler

Name	Yol	Tür	Description
Belge Grubu Kimliği	id	DocumentGroupId	Benzersiz Belge Grubu Kimliği

Belge Grubu Davet Durumunu Alma

İşlem Kimliği:

GetDocumentGroupInviteStatus

Bu eylem, her adımın ve eylemin durumu dahil olmak üzere belge grubu daveti hakkındaki bilgileri alır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği

Döndürülenler

Name	Yol	Tür	Description
Belge Grubu Davet Kimliği	document_group_invite_id	string	Belge grubunun Davet Kimliği
Belge Grubu Durumu	status	string	Belge grubu imzalama durumu. Olası değerler: 'created', 'pending', 'fulfilled', 'canceled'
Sahip E-postası	owner_email	string	Belge grubu sahibinin e-posta adresi
Belge Grubu Reddedildi	is_document_declined	boolean	Gruptaki herhangi bir belge imzalayan veya onaylayan tarafından reddedilirse 'true' döndürür; aksi takdirde , 'false' döndürür
steps	steps	array of object	Steps
Adım Kimliği	steps.step_id	string	Belge grubu davetinden adım kimliği
İmzalama Sırası	steps.signing_order	integer	İmzalama sırası
Belge Kimliği	steps.document_id	string	Belge kimliği
Belge Adı	steps.document_name	string	Belge adı
İmzalayan E-postası	steps.signer_email	string	Alıcı e-posta adresi
Rol Adı	steps.role_name	string	Alıcı rolü adı
Eylem Türü	steps.action_type	string	Belgedeki alıcıdan gereken eylem. Olası değerler: 'Sign', 'View', 'Approve' veya 'FreeFormSign'
Adım Davet Kimliği	steps.invite_id	string	Davet adımının kimliği
Statü	steps.status	string	Adımın imzalama durumu
Reddedildi	steps.declined	boolean	Bu adımdaki alıcı belgeyi reddettiyse True
Reddetme Nedeni	steps.decline_reason	string	Belge reddedildiğinde alıcı tarafından sağlanan ileti
Oluşturuldu	steps.created	integer	Adımın oluşturulduğu tarih
Updated	steps.updated	integer	Adım durumunun en son güncelleştirilildiği tarih

Belge Grubu Davetindeki Alıcıları Değiştirme

İşlem Kimliği:

ReplaceRecipientsInDocumentGroupInvite

Bu eylem, bir belge grubu davetindeki alıcıların yerini davet kimliğine göre değiştirir. Ayrıca, her belge için davet süre sonu, anımsatıcılar, yeniden atama izinleri ve reddetme seçenekleri ayarlayabilirsiniz

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği
Davet Kimliği	invite_id	True	string	Belge grubu davet kimliği
Adım Kimliği	step_id		string	Belge grubu davetinden davet adımının kimliği
Değiştirecek Alıcı	recipient_to_update		string	Değiştirecek alıcının e-postası
Yeni Alıcı	new_recipient		string	Yeni alıcının e-postası
Son Kullanma Günleri	expiration_days		integer	Davetin süresi kaç gün içinde dolacak; En fazla 30 gün
Hatırlatma	reminder		integer	İmzalayana kaç gün içinde anımsatıcı gönderebilirsiniz; En fazla 30 gün
Belge Kimliği	document_id	True	string	Belge grubundan belge kimliği
İletilmesine İzin Ver	allow_forwarding		boolean	Alıcıların bu daveti başka bir e-posta adresine yeniden atamasına izin verilip verilmeyeceği. Olası değerler: False - izin verilmez. True - izin verilir.
İmzaya Göre Reddetmeye İzin Ver	decline_by_signature		boolean	İmza alanlarında İmzaya Reddet seçeneğinin gösterilip gösterilmeyeceğini tanımlar. Doğru: reddetme seçeneğini gösterin; Yanlış: Reddetme seçeneğini gizleme

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Alıcı değiştirme durumu

Belge Grubu Eklenmiş Davet Bağlantısı Oluştur

İşlem Kimliği:

GenerateDocGroupEmbeddedInviteLink

Bu eylem, belge grubu eklenmiş davet için bir bağlantı oluşturur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği
Belge Grubu Eklenmiş Davet Kimliği	invite_id	True	string	'Belge Grubu Eklenmiş Davet Oluştur' eyleminden eklenen belge grubu davetinin kimliği
E-posta	email	True	email	Alıcı e-posta adresi
Bağlantı Süre Sonu	link_expiration		integer	Bağlantının kaç dakika etkin kalacağını belirtir. Geçerli aralık:15-45 dakika
Oturum Süre Sonu	session_expiration		integer	İmzalama oturumunun kaç dakika etkin kalacağını belirtir. Geçerli aralık:15-1440 dakika

Döndürülenler

Name	Yol	Tür	Description
Eklenmiş Davet Bağlantısı	link	string	Belge grubu eklenmiş davet bağlantısı

Belge Grubu Eklenmiş Davet Oluşturma

İşlem Kimliği:

CreateDocGroupEmbeddedInvites

Bu eylem, belge grubu için ekli imzalama daveti oluşturur. Davet oluşturulduktan sonra eklenmiş bir imzalama bağlantısı oluşturun

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği
Sipariş	order	True	integer	İmzalama sırası adımı. Belirli order bir adıma atanan tüm imzalayanlar (örneğin, order: 1) davet e-postasını aynı anda alır. Sonraki sipariş adımının e-postaları (örneğin, order: 2) yalnızca önceki sipariş adımındaki tüm eylemler tamamlandıktan sonra gönderilir
E-posta	email	True	string	Alıcı e-posta adresi
Belge Kimliği	id	True	string	Belgenin kimliği
Rol	role		string	Belgedeki alıcı rolü. 'Görünüm' eylemi için roller belirtilmemelidir
Eylem	action	True	string	Belgedeki alıcıdan gereken eylem. İzin verilen değerler: 'sign', 'view'
Sipariş	order	True	string	İmzalama siparişi adımı
E-posta	email	True	string	Alıcı e-posta adresi
Language	language		string	İmzalayan için imzalama oturumunun dilini ve bildirim e-postalarını belirtir. Olası değerler: İngilizce için En, İspanyolca için Es ve Fransızca için Fr. Ayarlanmamışsa, dil SignNow hesabınızın diline göre belirlenir
İlk İsim	first_name		string	Alıcının adı
Soyadı	last_name		string	Alıcının soyadı
Gerekli Önceden Ayarlanmış İmza Adı	required_preset_signature_name		string	İmza alanı için önceden doldurulmuş metin, alıcı tarafından düzenlemeye karşı kilitlendi
Yeniden Yönlendirme Uri'si	redirect_uri		string	İmzalama oturumu tamamlandıktan sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini Reddet	decline_redirect_uri		string	Alıcı belgeyi imzalamayı reddettikten sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini kapat	close_redirect_uri		string	Alıcı, imzalama oturumu sırasında İlerlemeyi Kaydet ve Daha Sonra Bitir'e veya Görünüm modunda kapat'a tıkladığında açılan bağlantı
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar
Teslim Türü	delivery_type		string	Davetin nasıl gönderileceğini tanımlar
Bağlantı Süre Sonu	link_expiration		integer	E-posta davetinin süresi kaç dakika içinde dolar. Yalnızca 'Teslim türü=e-posta' olduğunda kullanılabilir. Geçerli aralık: 15-43200 dakika
Oturum Süre Sonu	session_expiration		integer	İmzalama oturumunun süresi kaç dakika içinde dolar. Bu davet için bir bağlantı oluşturulursa oturum süre sonu sıfırlanır. Yalnızca 'Delivery type=email' ve 'sign' eylemleri için geçerlidir. Geçerli aralık: 15-1440 dakika
Kimlik Doğrulaması Türü	authentication_type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Kimlik Doğrulama Parolası	authentication_password		string	İmzalayanın kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Kimlik Doğrulama Telefonu	authentication_phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Kimlik Doğrulaması Sms İletisi	authentication_sms_message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow belge davet kilidini açma kodu: 123456'. Örnek: Belgenizin kilidini açmak için {password} parolasını girin
QES İmzası	signature		string	QES türü. Olası değerler: 'Eideasy', 'Nom151'. İmzalayanlardan QES imzaları istemek için kullanılır. Davetteki tüm imzalayanların aynı imza türünü kullanması gerekir. QES ile davet oluşturmak için kullanıcının QES'nin etkin olduğu bir kuruluşa ait olması gerekir

Döndürülenler

Name	Yol	Tür	Description
Davet Kimliği	id	string	Oluşturulan eklenmiş davetin kimliği

Belge Grubu Eklenmiş Daveti Sil

İşlem Kimliği:

DeleteDocGroupEmbeddedInvites

Bu eylem, belirli bir belge grubu için eklenmiş daveti siler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği

Belge Grubu Eklenmiş Gönderme Bağlantısı Oluştur

İşlem Kimliği:

CreateDocGroupEmbeddedInviteSettingsLink

Bu eylem, belirli bir belge grubu için ekli bir gönderme bağlantısı oluşturarak üçüncü taraf kullanıcıların belge grubunu imza için hazırlamasına ve göndermesine olanak sağlar

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği
Türü	type		string	Eklenmiş bağlantının açılması gereken gönderme adımını belirtir: 'manage' — Belge grubuna belge ekle sayfasında bağlantıyı açar; 'düzenle': bağlantıyı düzenleyicide açar; 'send-invite': Davet Gönder sayfasındaki bağlantıyı açar
Yeniden Yönlendirme Uri'si	redirect_uri		string	Ekli göndermeden sonra açılan sayfa ayarlandı. 'Yeniden yönlendirme hedefi' eklenirse gereklidir
Bağlantı Süre Sonu	link_expiration		integer	Bağlantının kaç dakika etkin kalacağını belirtir. İzin verilen aralık: 15 ila 45 dakika. Yönetici düzeyindeki kullanıcılar en fazla 43200 dakikaya kadar süreyi ayarlayabilir
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar

Döndürülenler

Name	Yol	Tür	Description
Bağlantı	url	string	Ekli belge grubu gönderme bağlantısı

Belge Grubunu Al

İşlem Kimliği:

GetDocumentGroup

Kullanıcının belge gruplarının listesini alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Şablonu	doc_group_id	True	string	Listeden grup şablonunu seçin
Template	template	True	boolean	Belge grubunun veya grup şablonunun alınacağını belirtin

Döndürülenler

Body

DocumentGroupProperties

Belge Grubunu İmzala'ya Davet Et

İşlem Kimliği:

InviteToSignDocGroupAllOptions

Bu eylem, belge grubunu imzalamak için bir davet oluşturur. Farklı alıcıların belge grubu üzerinde farklı aşamalarda işlem yaptığı çok adımlı bir iş akışı yapılandırabilirsiniz

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Kimliği	id	True	string	Belge grubu kimliği
Sipariş	order	True	integer	İmzalama sırası adımı: 1 - önce alıcılar belge grubunu imzalar, ardından belge grubu 2,3'e vb. gönderilir. Birkaç alıcı aynı imzalama sırasını tutabilir
E-posta	email		string	Alıcı e-posta adresi
E-posta Grubu	email_group		string	Alıcılardan oluşan bir kişi grubu
Rol Adı	role_name	True	string	Belgedeki alıcı rolü adı (belgedeki bu alıcıya atanan alanları tanımlamak için kullanılabilir)
Eylem	action	True	string	Belgeyle izin verilen eylem. Olası değerler: Görüntüle, İmzala, Onayla
Belge Kimliği	document_id	True	string	Bu alıcıdan eylemlerin gerekli olduğu belgenin kimliği
Gerekli Önceden Ayarlanmış İmza Adı	required_preset_signature_name		string	İmza alanı için önceden doldurulmuş metin, alıcı tarafından düzenlemeye karşı kilitlendi
İletilmesine İzin Ver	allow_reassign		boolean	Alıcının daveti başka bir e-posta adresine iletip iletemeyeceğini tanımlar. 'true': alıcı daveti iletebilir; 'false': alıcı daveti iletemiyor
İmzaya Göre Reddetmeye İzin Ver	decline_by_signature		boolean	İmza alanlarında İmzaya Reddet seçeneğinin gösterilip gösterilmeyeceğini tanımlar. Doğru: reddetme seçeneğini gösterin; Yanlış: Reddetme seçeneğini gizleme
Kimlik Doğrulaması Türü	type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Şifre	value		string	İmzalayan kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Telefon	phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Message	message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow belge davet kilidini açma kodu: 123456'
MerchantId	merchant_id		string	Kuruluşunuza eklenen satıcı hesabının kimliği
Para birimi	currency		string	İstenen ödeme para birimi
Miktar	amount		string	İstenen ödeme tutarı
Uri	redirect_uri		string	İstenen tüm alanlar tamamlanıp imzalandığında, imzalayan bu URI'ye yönlendirilir
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar
Yeniden Yönlendirme Uri'sini Reddet	decline_redirect_uri		string	Belge alıcı tarafından reddedildikten sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini kapat	close_redirect_uri		string	İmzalayan, imzalama oturumu sırasında İlerlemeyi Kaydet ve Daha Sonra Bitir'e veya Görünüm modunda kapat'a tıkladığında açılan bağlantı
Son Yeniden Yönlendirme İptal Edildi mi	is_finish_redirect_canceled		boolean	Kuruluş için tamamlama yeniden yönlendirme ayarının iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Kapatma Yeniden Yönlendirme İptal Edildi	is_close_redirect_canceled		boolean	Kayıt ilerleme durumu yeniden yönlendirme ayarının kuruluş için iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Reddetme Yeniden Yönlendirme İptal Edildi mi?	is_decline_redirect_canceled		boolean	Kuruluş için reddetme yeniden yönlendirme ayarının iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Language	language		string	İmzalayan için imzalama oturumunun dilini ve bildirim e-postalarını belirtir. Olası değerler: İngilizce için En, İspanyolca için Es ve Fransızca için Fr. Ayarlanmamışsa, dil SignNow hesabınızın diline göre belirlenir
Sipariş	order	True	integer	İmzalama sırası adımı: 1 - önce alıcılar belge grubunu imzalar, ardından belge grubu 2,3'e vb. gönderilir. Birkaç alıcı aynı imzalama sırasını tutabilir
E-posta	email	True	string	Alıcının e-posta adresi
E-posta Grubu	email_group		string	Alıcılardan oluşan bir kişi grubu
Konu	subject		string	Alıcı için özel e-posta konusu
Message	message		string	Alıcı için özel e-posta iletisi
Süresi Dolana Kadar Geçen Gün Sayısı	expiration_days		integer	X gün içinde davetin süresi dolar (3 ila 180 gün)
X Gün içinde Anımsatıcı Gönder	remind_after		integer	Davetten X gün sonra, bir alıcı bir anımsatıcı e-postası alır (1 ila 179 gün). Süre Sonu Günlerinden küçük olmalıdır
Süre Dolmadan X Gün Önce Anımsatıcı Gönder	remind_before		integer	Süre dolmadan X gün önce, bir alıcı bir anımsatıcı e-postası alır (1 ila 179 gün). Süre Sonu Günlerinden küçük olmalıdır
Her X Günde Bir Anımsatıcı Gönder	remind_repeat		integer	Davet gönderildikten her x gün sonra (1 ila 7 gün) bir alıcı bir anımsatıcı e-postası alır
Kimlik	id		string	E-posta grubunun kimliği. Önceden oluşturulması gereken benzersiz bir 40 karakterlik tanımlayıcı
İsim	name		string	Grubun adı. 'Davet Adımları > E-posta Grubu'nda kullanın
E-posta	email		string	Davet alması gereken e-posta adresi
E-posta	email		string	Tamamlanma e-postasını alacak alıcının e-posta adresi
Belge Eklerini Devre Dışı Bırak	disable_document_attachment		boolean	Tamamlanma e-postasıyla belge eklerinin gönderilmesinin devre dışı bırakılıp devre dışı bırakılmayacağı. Olası değerler: False - belge eklerini etkinleştirme, True - belge eklerini devre dışı bırakma
Konu	subject		string	Tamamlama e-postası için özel konu
Message	message		string	Tamamlama e-postası için özel ileti
Birleştirilmiş Olarak İmzala	sign_as_merged		boolean	Doğruysa, API kullanıcısına tek bir belgede birleştirilmiş belge grubu olarak açılan bir davet göndermesine izin verir
İstemci Zaman Damgası	client_timestamp		integer	Belge grubu davetinin zaman damgası
E-posta	email		string	Davet alması gereken e-posta adresi
QES İmzası	signature		string	QES türü. Olası değerler: 'Eideasy', 'Nom151'. İmzalayanlardan QES imzaları istemek için kullanılır. Davetteki tüm imzalayanların aynı imza türünü kullanması gerekir. QES ile davet oluşturmak için kullanıcının QES'nin etkin olduğu bir kuruluşa ait olması gerekir

Döndürülenler

Name	Yol	Tür	Description
Kimlik	id	string	Belge grubu davet kimliği
Bekleyen Davet Bağlantısı	pending_invite_link	string	Bekleyen davet bağlantısı

Belge Gruplarını Alma

İşlem Kimliği:

GetListDocGroups

Kullanıcının belge gruplarının listesini alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template	True	boolean	Belge gruplarının veya grup şablonlarının alınacağını belirtin
Sınır	limit		integer	Döndürülen toplam öğe sayısı (1 ile 50 arasında)
Ofset baskı	offset		integer	Koleksiyonda döndürülecek ilk öğenin (sıfır tabanlı) uzaklığı

Döndürülenler

Body

DocumentGroupsResponse

Belge Listesini Al

İşlem Kimliği:

GetListDoc

Kullanıcının belgelerinin listesini alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template		boolean	Belgelerin veya şablonların alınması gerekip gerekmediğini belirtin
Varsayılan Şablonu Ekle	includeDefaultTemplate		boolean	Varsayılan şablonun şablonlar listesine eklenip eklenmediğini belirtin

Döndürülenler

response

array of DocumentProperties

Belge şemasını alma [KULLANIM DIŞI]

İşlem Kimliği:

GetDocSchema

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belge şemasını al'ı kullanın.

OpenAPI belge şemasını alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id		string	Benzersiz bir belge kimliği belirtin
Alan türü filtresi	select		string	Almak istediğiniz alan türlerini virgülle ayırın

Döndürülenler

Name	Yol	Tür	Description
properties	properties	object

Belgeyi İmzala'ya Davet Et

İşlem Kimliği:

InviteToSignAllOptions

Bu eylem, belgenin imzalanması için alan daveti oluşturur ve gönderir

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	id	True	string	Belge Kimliği
E-posta	email		string	Alıcı e-posta adresi
E-posta Grubu	email_group		string	Daveti alması gereken bir kullanıcı grubu. Kullanıcılardan biri belgeyi imzaladığında tamamlanmış olarak kabul edilir. 'E-posta grupları' gelişmiş parametresiyle kullanılmalıdır. 'E-posta' veya 'Telefon Daveti' eklenmediyse gereklidir, ancak bu parametrelerden biriyle aynı anda kullanılamaz
Telefon Daveti	phone_invite		string	Alıcı telefon numarası. SMS yoluyla davet etme için gereklidir
Rol	role	True	string	Alıcı rolü adı. Örneğin, İmzalayan 1, İmzalayan 2
Sipariş	order	True	integer	İmzalama sırası. İmzalama sırası, alıcıların belgeyi imzalaması veya doldurması gereken sırayı tanımlar. Bir sipariş adımındaki tüm alıcılar imzalamayı tamamladıktan sonra, belge sonraki sipariş adımına (örneğin, 2, 3) devam eder. Birden çok alıcı aynı imzalama sırasını paylaşabilir
Rol	role	True	string	Gelişmiş parametreleri eşlemek için kullanılan alıcı rolü adı
İmza Adını Önceden Doldur	prefill_signature_name		string	İmza alanındaki önceden doldurulmuş metin, imzalayan tarafından düzenleme için kullanılabilir
Gerekli Önceden Ayarlanmış İmza Adı	required_preset_signature_name		string	İmza alanı için, alıcı tarafından düzenlemeye karşı kilitlenmiş, önceden doldurulmuş metin. 'İmza adını önceden doldur' veya 'Yeni imza gerektir' ile kullanılamaz
Yeni İmza gerektir	force_new_signature		boolean	İmzalayanın kaydedilmiş bir imza kullanıp kullanamayacağını tanımlar. False – imzalayan kayıtlı bir imza kullanabilir; Doğru – imzalayan yeni bir imza oluşturmalıdır
İletilmesine İzin Ver	reassign		boolean	Alıcının daveti başka bir e-posta adresine iletip iletemeyeceğini tanımlar. 'true': alıcı daveti iletebilir; 'false': alıcı daveti iletemiyor
İmzaya Göre Reddetmeye İzin Ver	decline_by_signature		boolean	İmza alanlarında İmzaya Reddet seçeneğinin gösterilip gösterilmeyeceğini tanımlar. Doğru – reddetme seçeneğini gösterin; false – reddetme seçeneğini gizle
X Gün içinde Anımsatıcı Gönder	remind_after		integer	Davetten X gün sonra, bir alıcı bir anımsatıcı e-postası alır (1 ila 179 gün). 'Son kullanma tarihine kadar geçen gün sayısı' değerinden küçük olmalıdır
Süre Dolmadan X Gün Önce Anımsatıcı Gönder	remind_before		integer	Süre dolmadan X gün önce, bir alıcı bir anımsatıcı e-postası alır (1 ila 179 gün). 'Son kullanma tarihine kadar geçen gün sayısı' değerinden küçük olmalıdır
X Günde Bir Anımsatıcı Gönder	remind_repeat		integer	Davet gönderildikten her x gün sonra (1 ila 7 gün) bir alıcı bir anımsatıcı e-postası alır
Süresi Dolana Kadar Geçen Gün Sayısı	expiration_days		integer	X gün içinde davetin süresi dolar (3 ila 180 gün)
Kimlik Doğrulaması Türü	authentication_type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Kimlik Doğrulama Parolası	password		string	İmzalayan kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Kimlik Doğrulama Telefonu	phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Kimlik Doğrulaması Sms İletisi	authentication_sms_message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow belge davet kilidini açma kodu: 123456'. Örnek: Belgenizin kilidini açmak için {password} parolasını girin
Konu	subject		string	Alıcı için özel e-posta konusu
Message	message		string	Alıcı için özel e-posta iletisi
Yeniden Yönlendirme Uri'si	redirect_uri		string	İstenen tüm alanlar tamamlanıp imzalandığında, imzalayan bu URI'ye yönlendirilir
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar
Yeniden Yönlendirme Uri'sini Reddet	decline_redirect_uri		string	Belge alıcı tarafından reddedildikten sonra açılan bağlantı
Yeniden Yönlendirme Uri'sini kapat	close_redirect_uri		string	Alıcı, imzalama oturumu sırasında İlerlemeyi Kaydet ve Daha Sonra Bitir'e veya Görünüm modunda kapat'a tıkladığında açılan bağlantı
Son Yeniden Yönlendirme İptal Edildi mi	is_finish_redirect_canceled		boolean	Kuruluş için tamamlama yeniden yönlendirme ayarının iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Kapatma Yeniden Yönlendirme İptal Edildi	is_close_redirect_canceled		boolean	Kayıt ilerleme durumu yeniden yönlendirme ayarının kuruluş için iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Reddetme Yeniden Yönlendirme İptal Edildi mi?	is_decline_redirect_canceled		boolean	Kuruluş için reddetme yeniden yönlendirme ayarının iptal edilip edilmeyeceğini belirtir. True – yeniden yönlendirme iptal edilir; False – yeniden yönlendirme etkin kalır
Language	language		string	İmzalayan için imzalama oturumunun dilini ve bildirim e-postalarını belirtir. Olası değerler: İngilizce için En, İspanyolca için Es ve Fransızca için Fr. Ayarlanmamışsa, dil SignNow hesabınızın diline göre belirlenir
E-posta	email	True	string	Görüntüleyici e-posta adresi
Rol	role	True	string	Görüntüleyici rolü adı
Sipariş	order	True	integer	Tamsayı: 1'den başlayarak gönderme sırası
Rol	role	True	string	Görüntüleyici rolü adı. Gelişmiş parametreleri eşlemek için kullanılır
Konu	subject		string	Görüntüleyici için özel e-posta konusu
Message	message		string	Görüntüleyici için özel e-posta iletisi
E-posta	email	True	string	Onaylayan e-posta adresi
Rol	role	True	string	Onaylayan rol adı
Sipariş	order	True	integer	Onay isteğini alma sırası
Rol	role	True	string	Onaylayan rol adı. Gelişmiş parametreleri eşlemek için kullanılır
Son Kullanma Günleri	expiration_days		integer	Davetin süresi dolmadan önceki gün sayısı
Message	message		string	Onaylayan için özel e-posta iletisi
Konu	subject		string	Onaylayan için özel e-posta konusu
Kimlik Doğrulaması Türü	authentication_type		string	İmzalama oturumu sırasında alıcı kimlik doğrulaması için kullanılan kimlik doğrulama türü. İzin verilen değerler: 'Password', 'Phone call' ve 'Sms'
Şifre	password		string	İmzalayan kimlik doğrulaması için parola ayarlandı. 'Parola' kimlik doğrulama türü için gereklidir
Telefon	phone		string	İmzalayanın kimliğini doğrulamak için kullanılan telefon numarası. 'Telefon araması' ve 'Sms' kimlik doğrulama türü için gereklidir. Örnek: +1XXXXXXXXXX
Kimlik Doğrulaması Sms İletisi	authentication_sms_message		string	İmzalayana gönderilen ve {password} yer tutucusunun bulunduğu özel sms iletisi. 'Sms' kimlik doğrulama türüyle kullanılır. Bu parametre olmadan, imzalayan otomatik olarak oluşturulan parola (kilit açma kodu) ile varsayılan bir sms alır - 'SignNow belge davet kilidini açma kodu: 123456'. Örnek: Belgenizin kilidini açmak için {password} parolasını girin
Yeniden Yönlendirme Uri'si	redirect_uri		string	Onaylayan belgeyi onayladıktan sonra açılan URL
Hedefi Yeniden Yönlendirme	redirect_target		string	Yeniden yönlendirme URI'sinin tarayıcıda yeni bir sekmede mi yoksa imzalama oturumundan sonra aynı sekmede mi açılıp açılmayacağını belirler. Olası değerler: 'Yeni sekmede' – bağlantıyı yeni bir sekmede açar, 'Aynı sekmede' - bağlantıyı aynı sekmede açar
Kaynak	from		string	Gönderen e-posta adresi. Yalnızca SignNow hesabınızla ilişkili e-posta (oturum açma e-postası) kullanılabilir. Boş bırakılırsa otomatik olarak ayarlanır
Kimlik	id		string	E-posta grubunun kimliği. Önceden oluşturulması gereken benzersiz bir 40 karakterlik tanımlayıcı
İsim	name		string	Grubun adı. İmzalayanlar > E-posta Grubu alanında kullanın
E-posta	email		string	Davet alması gereken e-posta adresi
E-posta	email		string	Davet alması gereken e-posta adresi
İsim	name		string	Adımın adı
E-posta	email		string	BILGI alıcısı e-posta adresi
Step	step		integer	1'den başlayarak gönderme sırası
Konu	subject		string	Tüm alıcılar için e-posta konusu
Message	message		string	Tüm alıcılar için e-posta iletisi
CC Konusu	cc_subject		string	Tüm BILGI alıcıları için CC e-posta konusu
CC İletisi	cc_message		string	Tüm BILGI alıcıları için CC e-posta iletisi
QES İmzası	signature		string	QES türü. Olası değerler: 'Eideasy', 'Nom151'. İmzalayanlardan QES imzaları istemek için kullanılır. Davetteki tüm imzalayanların aynı imza türünü kullanması gerekir. QES ile davet oluşturmak için kullanıcının QES'nin etkin olduğu bir kuruluşa ait olması gerekir

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Statü

Belgeyi İndir

İşlem Kimliği:

DownloadDocument

SignNow'dan belge indirme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin veya listeden bir belge seçin
Biçim	mode		string	İndirmek için bir belge biçimi seçin

Döndürülenler

response

binary

Belgeyi Karşıya Yükle

İşlem Kimliği:

UploadDocument

SignNow'a belge yükleme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Dosya	file	True	file	Karşıya yüklenecek dosya

Döndürülenler

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği

Belgeyi Sil

İşlem Kimliği:

DeleteDoc

SignNow'dan belge silme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Belge kaldırma durumu

Birden Çok Dosyadan Belge Grubu Oluşturma

İşlem Kimliği:

CreateDocGroupFromFiles

Base64 ile kodlanmış dizeler olarak birden çok dosya yükleyerek belge grubu oluşturma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Grubu Adı	group_name	True	string	Belge grubu için bir ad girin
Belge Adı	name	True	string	Uzantılı belge adı: Report.pdf, Letter.docx vb.
Dosya İçeriği	content	True	string	Belgenin içeriğini temsil eden Base64 kodlu dize

Döndürülenler

Body

CreateDocumentGroupFromFilesResponse

Daveti iptal et

İşlem Kimliği:

CancelInvite

İmza daveti iptali

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id	True	string	İmza daveti iptali için belge kimliğini belirtin

Döndürülenler

response

object

Grup Şablonundan Belge Grubu Oluşturma

İşlem Kimliği:

CreateFromTemplateGroup

Seçili grup şablonundan belge grubu oluşturma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Şablonu	doc_group_id	True	string	Listeden grup şablonunu seçin
Belge Grubu Adı	group_name		string	Belge grubu için yeni ad girin

Döndürülenler

Name	Yol	Tür	Description
Belge Grubu Kimliği	id	DocumentGroupId	Benzersiz Belge Grubu Kimliği

İmzalama Bağlantısı Oluştur

İşlem Kimliği:

CreateSigningLink

Belgenin bağlantısını oluşturma ve belgenin imzalı olması için bu bağlantıyı paylaşma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id	True	string	Benzersiz bir belge kimliği belirtin veya listeden bir belge seçin
Alanları	fields		dynamic

Döndürülenler

Name	Yol	Tür	Description
URL	url_no_signup	string	İmzalama Bağlantısı

Kullanım dışı - Belge Grubunu imzalamaya davet et

İşlem Kimliği:

SendGroupInvite

Eylem kullanım dışı bırakıldı. Belge grubunu doldurmak ve imzalamak için başkalarını davet etme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template	True	boolean	Belge gruplarının veya grup şablonlarının alınacağını belirtin
Belge Grubu	template_group_id	True	string	Listeden belge grubunu seçin
body	body	True	dynamic

Döndürülenler

response

object

Kullanım dışı - Gelişmiş Belge Daveti

İşlem Kimliği:

SendUserDefinedInvite

Eylem kullanım dışı bırakıldı. El ile tanımlanmış şemayla davet isteği. Gelecekte oluşturulacak bir belge için davet ayarlamaya olanak tanır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Kimliği	doc_id	True	string	Belge kimliği belirtin
İsim	role		string	İmzalayanın rol adı
E-posta	email		email	İmzalayan için e-posta belirtme
Telefon Numarası (SMS ile davet et)	phone_invite		string	+XXXXXXXXXXXX alıcının telefon numarasını belirtin. SMS ile Davet Et için gereklidir.
Sipariş	order		integer	Birden çok imzalayan için imzalama sırasını ayarlama
Kişiselleştirilmiş Konu	subject		string	İmzalayan için Kişiselleştirilmiş Konu Ekleme
Kişiselleştirilmiş İleti	message		string	İmzalayan için Kişiselleştirilmiş ileti ekleme
Doğrulama türü	authentication_type		string	Parola, SMS veya telefon araması yoluyla kullanıcı kimliğini doğrulama
Şifre	password		string	Parola Kimlik Doğrulama türü için parolayı ayarlama
Telefon	phone		string	Telefon veya SMS kimlik doğrulama türü için +XXXXXXXXXXXx telefon numarasını belirtin
Süresi Dolana Kadar Geçen Gün Sayısı	expiration_days		integer	Davetin süresi kaç gün içinde imzalayana bildirilir
Anımsatıcı gönder	reminder		integer	E-posta anımsatıcısı ile otomatik olarak izlemek üzere daveti gönderdikten sonraki gün sayısı
Her X Günde Bir Anımsatıcı Gönder	remind_repeat		integer	Alıcı, ayarlanan her gün bir anımsatıcı e-postası alır.
İletilmesine İzin Ver	reassign		boolean	İmzalayanın imzalamayı başka birine devretmesine izin ver
İmzada Reddetmeyi Göster	decline_by_signature		boolean	Alıcı belgeyi imzalamayı reddettiyse, imza alanını İmzalamayı Reddet olarak damgalayın
CC	cc		string	Davette Karbon Kopyalanacak virgülle ayrılmış e-postalar
Konu	subject		string	Konunuzu yazın
Message	message		string	İletinizi yazın
Tamamlandığında tüm taraflara e-posta gönderin	on_complete		string	Belge imzalandığında tüm taraflara bildirim e-postası gönderilir

Döndürülenler

response

object

Kullanım dışı - İmzaya davet et

İşlem Kimliği:

SendInvite

Eylem kullanım dışı bırakıldı. Diğer kişileri belgeyi doldurmaya ve imzalamaya davet etme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Template	template	True	boolean	Belgelerin veya şablonların alınması gerekip gerekmediğini belirtin
Belge	template_id	True	string	Listeden şablon seçme
body	body	True	dynamic

Döndürülenler

response

object

Şablondan Belge Oluştur

İşlem Kimliği:

CreateFromTemplate

Seçili şablondan belge oluşturma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Şablonu	doc_id	True	string	Listeden şablon seçme
Belge Adı	document_name		string	Belge için yeni dosya adı girin

Döndürülenler

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği

Tetikleyiciler

Belge olayında akışı başlatma	Tetiklenecek olayı seçin: yeni veya güncelleştirilmiş imza daveti; birisi belgeyi oluşturduğunda, güncelleştirdiğinde, tamamladığında veya sildiğinde
Belge olayında akışı başlatma [KULLANIM DIŞI]	Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge olayında Başlangıç akışını kullanın. Bu olaylardan biri için tetikleyici oluşturabilirsiniz: belge oluşturma, belge güncelleştirmesi, belge silme, belge tamamlama, oluşturma davet etme, güncelleştirmeyi davet etme

Belge olayında akışı başlatma

İşlem Kimliği:

Triggers_V2

Tetiklenecek olayı seçin: yeni veya güncelleştirilmiş imza daveti; birisi belgeyi oluşturduğunda, güncelleştirdiğinde, tamamladığında veya sildiğinde

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Event	event	True	string	Flow'un tetiklenmesi gereken olayı seçin

Döndürülenler

Name	Yol	Tür	Description
Event	meta.event	string	Tetikleyiciye neden olan belge olayı.
Belge Kimliği	content.document_id	string	Olaya neden olan hedef belgenin benzersiz kimliği.
Belge Adı	content.document_name	string	Uzantı olmadan hedef belge dosyası adı

Belge olayında akışı başlatma [KULLANIM DIŞI]

İşlem Kimliği:

Triggers

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge olayında Başlangıç akışını kullanın.

Bu olaylardan biri için tetikleyici oluşturabilirsiniz: belge oluşturma, belge güncelleştirmesi, belge silme, belge tamamlama, oluşturma davet etme, güncelleştirmeyi davet etme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Event	event	True	string	Flow'un tetiklenmesi gereken olayı seçin.

Döndürülenler

Name	Yol	Tür	Description
Zaman Damgası	meta.timestamp	integer	Olayın gerçekleştiği tarih ve saat (Unix zaman damgası biçimi).
Event	meta.event	string	Tetikleyiciye neden olan belge olayı.
Belge Kimliği	content.document_id	string	Olaya neden olan hedef belgenin benzersiz kimliği.
Belge Adı	content.document_name	string	Uzantı olmadan hedef belge dosyası adı

Tanımlar

DocumentProperties

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği
Belge Adı	document_name	string	Uzantı olmadan belge dosyası adı
Sayfa sayısı	page_count	integer	Belgedeki sayfa sayısı
Oluşturuldu	created	integer	Belgenin Unix Zaman Damgası biçiminde oluşturulduğu tarih ve saat
Updated	updated	integer	Belgenin Unix Zaman Damgası biçiminde güncelleştirilmiş olduğu tarih ve saat
Şablon adı	original_filename	string	Uzantılı şablon dosya adı (varsa)
Şablon Kimliği	origin_document_id	string	Şablon belge kimliği (varsa)
Şablondur	template	boolean	belge şablonsa true.
Belge Durumu	status	string	Belge Durumu

DocumentGroupsResponse

Name	Yol	Tür	Description
document_groups	document_groups	array of DocumentGroupProperties
Belge Grupları Toplam Sayısı	document_group_total_count	integer	SignNow hesabındaki toplam Belge Grubu sayısı

DocumentGroupProperties

Name	Yol	Tür	Description
Belge Grubu Kimliği	group_id	DocumentGroupId	Benzersiz Belge Grubu Kimliği
Belge Grubu Adı	group_name	string	Belge Grubu Adı
Documents	documents	array of DocumentGroupDocumentProperties	Documents

DocumentGroupDocumentProperties

Name	Yol	Tür	Description
Belge Kimliği	id	DocumentId	Benzersiz belge kimliği
Belge Adı	document_name	string	Uzantı olmadan belge dosyası adı
Şablon Kimliği	origin_document_id	string	Şablon belge kimliği (varsa)

CreateDocumentGroupFromFilesResponse

Name	Yol	Tür	Description
Belge Grubu Adı	group_name	string	Belge grubu adı
Belge Grubu Kimliği	group_id	string	Belge grubu kimliği
belgeler	documents	array of object
Belge Kimliği	documents.id	DocumentId	Benzersiz belge kimliği
Belge Adı	documents.name	string	Belge adı

DocumentId

Benzersiz belge kimliği

Benzersiz belge kimliği

Belge Kimliği

string

DocumentGroupId

Benzersiz Belge Grubu Kimliği

Benzersiz Belge Grubu Kimliği

Belge Grubu Kimliği

string

object

Bu , 'object' türüdür.

ikili

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