SigningHub (Önizleme)

Ascertia tarafından yapılan SigningHub, yüksek güvenilir dijital imzalar ve belge iş akışı otomasyonu için kapsamlı bir paket sunar. Bu bağlayıcı, işletmelerin kullanıcıların kimliğini güvenli bir şekilde doğrulamasını, belge imzalama isteklerini başlatmasını ve uçtan uca onay döngülerini yönetmesini sağlar. Sıkı küresel güvenlik standartlarını karşılamak üzere tasarlanan bu hizmet, otomatik iş akışlarınızın tüm kuruluşunuz genelinde yasal olarak uygulanabilir, şeffaf ve yüksek oranda güvenli kalmasını sağlar.

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	Support
URL	https://www.signinghub.com/contact-us/
E-posta	support@ascertia.com

Bağlayıcı Meta Verileri
Publisher	Ascertia Limited.
Publisher	Ascertia
StackOwner	SigningHub
BrandColor	#1C1C1C
IconBrandColor	#1C1C1C
Web sitesi	https://signinghub.com
Gizlilik ilkesi	https://www.signinghub.com/privacy-policy
Kategoriler	İçerik ve Dosyalar; Verimli -lik

SigningHub Bağlayıcısı

SigningHub, kuruluşların dijital belge imzalama iş akışlarını otomatikleştirmesine ve yönetmesine olanak tanıyan kapsamlı bir REST API sağlar. Bu bağlayıcıyı kullanarak, belge onay işlemlerini kolaylaştırmak ve özel iş akışları içinde imzalama eylemlerini otomatikleştirmek için SigningHub'ı Power Automate ile tümleştirebilirsiniz.

Bu bağlayıcı, doğrudan Power Automate akışlarında belge imzalama ve diğer İmzalamaHub eylemlerinin otomasyonunu sağlar ve kuruluşların verimli ve güvenli belge iş akışları oluşturmalarına yardımcı olur.

Publisher: Ascertia

Önkoşullar

Bu bağlayıcıyı kullanmak için aşağıdakilere sahip olmanız gerekir:

• Etkin bir SigningHub hesabı (https://www.signinghub.com).
• SigningHub'da tanımlanan geçerli bir Tümleştirme.

Kimlik bilgilerini alma

Oturum Açma Formu alanlarını aşağıdaki değerlerle doldurun:

• E-posta: İmzalamaHub hesabı e-postası.
• Parola: SigningHub hesabı parolası.
• API İstemci Kimliği: Ascertia veya şirket yöneticiniz bağlayıcıyı kullanmak için API İstemci Kimliğini sağlar.
• API İstemci Gizli Anahtarı: Ascertia veya şirket yöneticiniz bağlayıcıyı kullanmak için API İstemci Gizli Anahtarı'nı sağlar.
• API URL'si: Varsayılan olarak SigningHub API URL'si https://api.signinghub.com

Desteklenen İşlemler

Bu bağlayıcı , SigningHub REST API'sinin kapsamını sağlar. Desteklenen eylemlerin ve parametrelerinin listesi için bkz . SigningHub API Kılavuzu.

Destek ve Bağlantılar

• Resmi API Belgeleri
• Destek URL'si
• Gizlilik İlkesi

Azaltma Sınırları

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

Eylemler

Alanları Otomatik Yerleştir	İş uygulamaları, sağlanan arama ölçütüne göre belgeye imza veya kullanıcı tanımlı form alanları eklemek için bu API'yi çağırabilir. Yerleştirme seçenekleri şunlardır: solda, sağda, üstte ve altta. Belge aramadır ve karşılanan arama ölçütlerinin tüm örnekleri işlenir. Bu, tek bir çağrıyla birden çok alan eklemenize olanak tanır. Örneğin, bir belgeyi karşıya yükleyin ve "Burada imzalayın:" sözcüğünün tüm örneklerinin sağındaki imza alanını otomatik olarak yerleştirin. Bu, zaman kazandırır ve iş akışında hiçbir imzanın kaçırılmamasını sağlar. API çağrısı tüm alan türlerini destekler; elektronik, dijital, bizzat, baş harfler ve metin alanı vb. Buna ek olarak, API çağrısı "order" değişkenini destekler. Bu, bir dizi imza alanını tek bir kullanıcıya otomatik olarak atayabileceğiniz anlamına gelir. Bu nedenle, iş akışında birden fazla kullanıcıya imza alanları yerleştirmek ve atamak için çağrı yinelenebilir. İmza alanlarının belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcının bulunması gerekir. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Bu API çağrısı aynı belgede birden çok kez kullanılabilir. Bunu yapmanın nedeni, bir belgede birden çok imzalayana hizmet vermektir. Alıcı veya imzalayan, çağrıda geçirilen "order" değişkeni tarafından tanımlanır. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.
Ağ Geçidi Denetleyicisi Belgeyi Onayla	İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırasıyla onaylayabilir.
Ağ Geçidi Denetleyicisi Reddetme Belgesi	İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırasıyla reddedebilir.
Baş Harfleri Doldur	İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgedeki baş harflerin baş harflerini sırayla doldurabilir.
Belge Alanlarını Al	İş uygulamaları bu hizmet API'sini kullanarak belge alanlarını (örneğin, baş harfleri, kişilerin, imza alanlarını veya form alanlarını) alabilir.
Belge Alanı Ata	İş uygulamaları bu hizmet API'sini kullanarak kullanıcıları imza alanları gibi giriş alanlarına atayabilir ve bu nedenle imzalama sırasını tanımlayabilir. Alanların belgede zaten mevcut olması ve kullanıcıların iş akışında mevcut olması gerekir. İş akışı belgesinin kimliği, paket tanımlayıcısıyla birlikte kaynak URL'sinde sağlanır. Alıcılar bir iş akışında olduğunda numaralandırılır, bir taneden başlar ve her ek iş için sayılır. Bu nedenle, bir iş akışında üç kullanıcı varsa, "1", "2" ve "3" numaralıdır. Bu API çağrısı, bir kullanıcıyı iş akışı sipariş numarasına göre belgedeki bir giriş alanına atamanızı sağlar.
Belge Alanını Sil	İş uygulamaları, paketteki belge alanını silmek için bu hizmet API'sini kullanabilir.
Belge Ayrıntılarını Alma	İş uygulamaları belge ayrıntılarını almak için bu hizmet API'sini kullanabilir. Belge kimliği URL'de "{document_id}" olarak sağlanır.
Belge Gönder	SigningHub rollerinden biri "Düzenleyici" olarak adlandırılır. Bu, alıcının belgedeki giriş alanlarını düzenlemesine izin verir, ancak imza gerektirmez. Tamamlandıktan sonra alıcı değişikliklerini gönderir. GUI'de kullanılan düğmeye "Gönder" adı verilir. Bu, düzenleyicinin değişikliklerini bir API çağrısı aracılığıyla göndermesine eşdeğer bir işlemdir. Kullanılabilir tüm iş akışı alıcı rollerinin açıklaması için İmzalamaHub Rolleri'ne tıklayın.
Belge için Sertifika İlkesi alma	İş uygulamaları, bir paketteki belgenin imza ayarlarını onaylamak için bu hizmet API'sini kullanabilir.
Belge için Sertifika İlkesini Güncelleştirme	İş uygulamaları bu hizmet API'sini kullanarak paketteki bir belgenin imza ayarlarını onaylayabilir.
Belge Paketini Paylaş	İş uygulamaları, belge paketini imzalayanlarla paylaşmak ve yeni bir iş akışı başlatmak için bu hizmet API'sini kullanabilir. Belge, şablon uygulanarak ve isteğe bağlı olarak şablonda tanımlanan kullanıcıları ve eylemleri güncelleştirerek hazırlanmış olmalıdır. Paylaşılacak paket kimliği kaynak URL'sinde sağlanır.
Belgeyi Geri Çek	İş uygulamaları, devam eden bir iş akışını durdurmak için bu hizmet API'sini kullanabilir. Belge kimliği kaynak URL'sinde sağlanır. Geri çağrıldıktan sonra belge durumu otomatik olarak "TASLAK" olarak değişir.
Belgeyi İmzala	İş uygulamaları, signHub kullanarak belgeyi son kullanıcıya görüntülemeden belgeyi imzalamak için (elektronik ve dijital) bu hizmet API'sini kullanabilir. Örneğin, bir iş uygulamasının belgeyi kullanıcıya görüntülemesi için başka bir yöntemi olabilir ve yalnızca SigningHub'ın imzalama işlevi gereklidir veya toplu işlemler için kullanıcının her belgeyi tek tek görüntülemesine ve onaylamasına gerek kalmadan imzalaması haklı olabilir. İmzalamadan önce belgeye kaydedilecek değişiklikler varsa, Belgeyi İmzala API'sini çağırmadan önce Form Alanlarını Doldur API'sinin çağrılması gerekir. Bu API'nin başarıyla tamamlanması için belgedeki zorunlu giriş alanlarının tamamlanmasını gerektirdiğini unutmayın. İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir. Bu çağrı tamamlandığında, belgenin son imzalayanı imzalayan ise Belgeyi Bitir API çağrısının çağrılmış olması önemlidir. Bunun nedeni, API çağrılmadan belgenin belge sahibine "Devam Ediyor" durumunda kalmasıdır. API çağrıldıktan sonra, belge sahibi için durum "Tamamlandı" olarak değişir. Belge imzalandıktan sonra doğrulama yanıtı Belge Doğrulama API'sini Al'dan görülebilir. Kimlik Doğrulaması için Birinci veya İkinci Faktör OTP Kullanımı Sunucu tarafı imzalama işlemi için OTP kimlik doğrulaması açıksa, istemci uygulamalarının OTP API çağrısı aracılığıyla İmzalayan Kimlik Doğrulaması'nı kullanarak mobil numara için bir OTP oluşturması gerekir. İlgili iş uygulamaları OTP'yi kullanımdan almalı ve API çağrısı yaparken göndermelidir. Bu, istekteki "x-otp" üst bilgisi kullanılarak yapılır.
Belgeyi İndir	İş uygulamaları, belge baytlarını indirmek için bu hizmet API'sini kullanabilir. Paket kimliği ve belge kimliği kaynak URL'sinde sağlanır.
Belgeyi Karşıya Yükle	İş uygulamaları bu hizmet API'sini kullanarak kurumsal kullanıcının hesabına bağlı bir belge paketine belge ekleyebilir. Belge bilgileri HTTP isteği üst bilgisinde, belge baytları ise HTTP isteği gövdesinde gönderilir. Not"x-convert-document" üst bilgisi "true" değerine ayarlanırsa SigningHub desteklenen belge biçimlerini PDF'ye dönüştürür. Bu değerin "false" olarak ayarlandığı durumlarda desteklenen tek durum, Word biçimini ve XML belgelerini korumaktır. SigningHub, her biri karşıya yüklendikten sonra PDF biçimine dönüştürülebilen çok çeşitli belge biçimlerini destekler. Tam liste için buraya tıklayın. Not PDF belgeleri sisteme yüklendikten sonra değiştirilmez. Bu çağrıyı kullanarak belge ekleyebilmeniz için önce bir paketin zaten mevcut olması gerektiğini unutmayın.
Belgeyi Onayla	İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırayla onaylayabilir.
Belgeyi Reddet	İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcının sırasıyla bir belgeyi reddetmesini sağlayabilir.
Belgeyi Sil	İş uygulamaları, paketteki bir belgeyi silmek için bu hizmet API'sini kullanabilir.
Belgeyi Yeniden Adlandır	İş uygulamaları, paketteki bir belgeyi yeniden adlandırmak için bu hizmet API'sini kullanabilir.
CheckBox Alanı Ekle	İş uygulamaları, paketteki belgeye onay kutusu eklemek için bu hizmet API'sini kullanabilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir. Genişlik ve yükseklik parametreleri sağlanmazsa, varsayılan boyut olarak 10x10 atanır. Genişlik veya yükseklik (veya her ikisi) sağlanmışsa, sistem sağlanan bu değerleri birbiriyle karşılaştırır. Genişlik ve yükseklik arasındaki daha büyük değer her iki boyuta da atanır.
CheckBox Alanını Güncelleştir	İş uygulamaları, paketteki bir belgenin onay kutusu alanını güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir. Genişliği ve yüksekliği güncelleştirilemez. Eklendiklerinde olduğu gibi kalırlar.
Dijital İmza Alanı Ekle	İş uygulamaları, paketteki bir belgeye dijital imza alanı eklemek için bu hizmet API'sini kullanabilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.
Dijital İmza Alanını Güncelleştir	İş uygulamaları, paketteki bir belgenin dijital imza alanını güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.
Eki İndir	İş uygulamaları, bir belgenin ekini indirmek için bu hizmet API'sini kullanabilir.
Eki Karşıya Yükle	İş uygulamaları bir belgeye ek yüklemek için bu hizmet API'sini kullanabilir.
Eki Sil	İş uygulamaları, bir belgenin ekini silmek için bu hizmet API'sini kullanabilir.
Ekleri Al	İş uygulamaları, bir belgenin eklerini almak için bu hizmet API'sini kullanabilir.
Form Alanlarını Doldur	İş uygulamaları, bir belgedeki bir veya daha fazla form alanını belirtilen kullanıcı tarafından sırayla doldurmak için bu hizmet API'sini kullanabilir.
Güncelleştirme Sonrası İşleme	İş uygulamaları, paketteki bir belgenin iş akışına yer tutucu eklemek için bu hizmet API'sini kullanabilir.
İlk Alan Ekle	İş uygulamaları bu hizmet API'sini kullanarak paketteki bir belgeye baş harf alanı ekleyebilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.
İlk Alanı Güncelleştir	İş uygulamaları, paketteki belgenin baş harfleri alanını güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.
İş Akışı Anımsatıcılarını Güncelleştirme	İş uygulamaları, iş akışına zaten eklenmiş olan bir alıcı için iş akışı anımsatıcılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki anımsatıcı ayarlarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır.
İş Akışı Anımsatıcısı Alma	İş uygulamaları, iş akışına zaten eklenmiş olan alıcıların anımsatıcılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki anımsatıcı ayarlarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır.
İş Akışı Ayrıntılarını Alma	İş uygulamaları, paketin iş akışı ayrıntılarını almak için bu hizmet API'sini kullanabilir.
İş Akışı Ayrıntılarını Güncelleştirme	İş uygulamaları iş akışı ayrıntılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan sonra yararlıdır, ancak iş uygulamaları onaylama iznini veya işlem sonrası ayrıntılarını geçersiz kılmak ister. Paket kimliği kaynak URL'sinde sağlanır.
İş Akışı Geçmişini Alma	İş uygulamaları, bir belgede gerçekleştirilen eylemlerin listesini almak için bu hizmet API'sini kullanabilir. Paket kimliği kaynak URL'sinde sağlanır. Arama alanı (x-search-text üst bilgisi) e-posta, belge adı, eylem, bilgi anahtarı ve infovalue için tasarlanmıştır.
İş Akışı Kullanıcı İzinlerini Alma	İş uygulamaları bu hizmet API'sini kullanarak bir alıcı için belge izinleri alabilir. Alıcı, iş akışındaki sıralamaya göre tanımlanır. Paketin kimliği kaynak URL'sinde sağlanır.
İş Akışı Kullanıcı İzinlerini Güncelleştirme	İş uygulamaları, iş akışına zaten eklenmiş bir kullanıcının iş akışı izinlerini güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki izinleri geçersiz kılmak istediğinde kullanışlıdır. Belge paketinin kimliği kaynak URL'sinde sağlanır ve iş akışı kullanıcısı iş akışına eklenme sırasına göre tanımlanır.
İş Akışı Kullanıcıları Siparişini Güncelleştir	İş uygulamaları, alıcının iş akışındaki sırasını güncelleştirmek için bu hizmet API'sini kullanabilir.
İş Akışı Kullanıcılarını Alma	İş uygulamaları, paketin iş akışı ayrıntılarını almak için bu hizmet API'sini kullanabilir.
İş Akışı Kullanıcılarını Güncelleştir	İş uygulamaları bu hizmet API'sini kullanarak bir iş akışına zaten eklenmiş olan bir alıcı, grup veya yer sahibinin ayrıntılarını güncelleştirebilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki belirli bir kullanıcının ayrıntılarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır. XML türü belge hazırlığı sırasında yalnızca rol türlerini "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" desteklediğini unutmayın.
İş Akışı Kullanıcılarını Sil	İş uygulamaları iş akışı alıcısını silmek için bu hizmet API'sini kullanabilir.
İş Akışı Şablonu Uygula	İş uygulamaları, belgeye iş akışı şablonu uygulamak için bu hizmet API'sini kullanabilir. Şablonun uygulanması gereken belge kimliği kaynak URL'sinde sağlanır. Belge kimliği 0 olarak ayarlandığında, şablon bir pacakge içindeki tüm doucments'a uygulanır. Şablonu uygularken şu iki önemli noktayı hatırlamak önemlidir: 1. Nokta - Uygulanan şablon zaten form alanları içeren bir PDF kullanılarak oluşturulduysa, bu şablonun uygulandığı belgenin bu form alanlarını önceden içermesi gerektiğinden emin olun ve SigningHub bu form alanlarını şablon aracılığıyla oluşturmaz, yalnızca form verilerini uygular ve ilgili kullanıcılara atar. 2. Nokta - Uygulanan şablon, imza alanı, ilk, kişisel imza, onay kutuları, radyo düğmeleri, metin alanları gibi İmzalamaHub aracılığıyla form alanlarının el ile eklendiği (dolayısıyla başlangıçta PDF'de bulunmadığı) oluşturulursa, bu tür bir şablon uygulandığında, bu form alanları belgede zaten mevcut olsa bile hedef belgede oluşturulur.
İş Akışına Grup Ekleme	İş uygulamaları, grupları bir iş akışına alıcı olarak eklemek için bu hizmet API'sini kullanabilir. SigningHub grubu, grubun herhangi bir üyesinin eylemi (örneğin, grubun tüm üyeleri adına imzalama) gerçekleştirebileceği anlamına gelir. Grubun iş akışındaki son kullanıcı/grup olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan geçerli bir kullanıcıyı/grubu kaldırmak için daha fazla çalışma gerekebilir. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
İş Akışına Kullanıcı Ekleme	İş uygulamaları, bir iş akışına alıcı eklemek için bu hizmet API'sini kullanabilir. Bu çağrı yalnızca iş akışına bir alıcı ekler. Başka bir ifadeyle, şu anda belgedeki hiçbir alan yeni alıcılara otomatik olarak atanmayacak veya bu yeni alan oluşturmayacaktır. Alıcıların iş akışındaki son kişi olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan alıcıları kaldırmak için daha fazla çalışma gerekebilir. Alanlar (giriş ve imza) belgeye eklenmeden önce iş akışında en az bir kullanıcı bulunmalıdır. Girişin tek bir çağrıda bir veya daha fazla kullanıcıyı kabul eder. Bu özel çağrıda kullanıcı bilinen bir gerçek kişidir. Ancak, aynı kurallar Gruplar ve Yer Tutucular için de geçerlidir. Bu iki durumda da alıcı, grubun herhangi bir üyesinin belgeyi imzaladığı bir Kullanıcı Grubu veya Yer Tutucu olur.İkinci durum, hedeflenen imzalayan kişinin kimliğini bilmediğinizde kullanılır. Not İmzalamaHub iş akışı imzalama sırası "1" ile başlar. Bu nedenle, geçerli alıcıları olmayan bir kullanıcıyı iş akışına eklemek yeni bir imzalama siparişi sayısı başlatır. İş akışı türü "özel" ise "signing_order" parametresi zorunludur. Önemli, bu API çağrısının kullanılması iş akışı türünü etkileyebilir. Sıralı bir iş akışında geçerli alıcılar varsa ve geçerli alıcıyla aynı imzalama sırasına sahip yeni bir alıcı eklenirse, iş akışının bu bölümü otomatik olarak sıralıdan paralele dönüşür. Bu nedenle, genel iş akışı artık tamamen sıralı değil özel türündedir. İki veya paralel alıcıyla aynı imzalama sırasına sahip bir alıcı eklemek iş akışını değiştirmez. İş akışının belirli bir noktasında yalnızca üç veya daha fazla alıcı vardır; tümü paralel sırada. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türlerinin "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olduğunu unutmayın
İş Akışına Yer Tutucu Ekle	İş uygulamaları, paketteki bir iş akışına yer tutucu eklemek için bu hizmet API'sini kullanabilir. Bir iş akışında hedeflenen alıcının kimliğini bilmediğinizde yer tutucu gereklidir. Yer tutucunun iş akışındaki son kullanıcı olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan geçerli bir kullanıcıyı/grubu kaldırmak için daha fazla çalışma gerekebilir. Yer tutucu eklemek, devam etmenizi ve belgeye imza ve/veya giriş alanları eklemenize olanak tanır. Bu alanlar daha sonraki bir aşamada tek tek kullanıcılara atanabilir. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
İşlem Kanıtı Raporu Alma	İş uygulamaları, bir belgenin iş akışı süreci kanıt raporunu indirmek için bu hizmet API'sini kullanabilir.
İşlemeyi Bitir	İş uygulamaları, tüm imza alanlarını imzaladıktan sonra belge işlemeyi tamamlamak için bu hizmet API'sini kullanabilir. Bu yöntem öncelikli olarak iOS ve Android için yerel SigningHub mobil uygulamaları ve mobil web kullanım örnekleri tarafından kullanılır. İlgili portallarına sıkı tümleştirme kullanan genel iş uygulamalarının bu yöntemi çağırması gerekmez. Ancak, belgeyi İmzala API'sini kullanırken (ve bu nedenle kullanıcıya imzalaması istenen belgenin görsel bir gösterimi sunulmaz) ilgili iş akışının devam ettiğinden veya tamamlandığından emin olmak için bu API'yi çağırmak gerekir. Örneğin, "kör" Belge İmzala API çağrısı kullanılarak tüm imzalar uygulandıktan sonra, bu API çağrılana kadar belge sahibine "Tamamlandı" durumu olarak gösterilmez. Bu API çağrılana kadar belge sahibi "Devam Ediyor" durumunu görür. Yerel SigningHub mobil uygulamalarında ve mobil web kullanım örneklerinde bu çağrı, her kullanıcının SigningHub ile ilgili eylemlerini tamamladığından emin olmak için gereklidir.Örneğin, bir imzacı SigningHub App'te bir belgeyi imzaladıktan sonra, iş akışının işlemeye devam ettiğinden ve bir sonraki imzalayana bildirildiğinden emin olmak için bu yöntem uygulama tarafından çağrılır, ve belge durumu yapılandırılan geri arama URL'si aracılığıyla kullanılabilir.
Kitaplıktan Belge Ekleme veya Güncelleştirme	İş uygulamaları, kullanıcının kitaplığından pakete belge eklemek için bu hizmet API'sini kullanabilir. PAKET KİmLİĞİ URL'de sağlanır; kopyalanacak kitaplık belgesini tanımlamak için belgenin kimliği de kaynak URL'sinde "document_id" olarak sağlanmalıdır. Bu çağrıyı kullanarak belge ekleyebilmeniz için önce bir paketin zaten mevcut olması gerektiğini unutmayın.
Kişi İçi Alan Ekle	İş uygulamaları bu hizmet API'sini bir paketteki belgeye kişi içi imza alanı eklemek için kullanabilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir. Bir bizzat toplantıyı barındırmak için bir SigningHub kullanıcısının iş akışının bir parçası olması gerekir. "INPERSON_HOST" veya "İMZALAYAN" Rolü ile eklenmelidir. Konak seçeneği için, belgede imza veya giriş alanı gerektirmezler ve kişisel imza alanı, SigningHub kayıtlı olmayan kullanıcı tarafından imzalanabilir. Bunun, SigningHub kullanıcısının ve alıcısının aynı konumda olması beklenen özel bir iş akışı senaryosu olduğunu unutmayın. Bu imza türü, normal gevşek tümleştirme yöntemindeki e-posta bağlantısı üzerinden bir belgenin alıcılarla paylaşıldığı durumlarda kullanılmak üzere tasarlanmamıştır.
Kişileri Al	İş uygulamaları, geçerli kullanıcının hem kişisel hem de kurumsal kişilerinden kişileri yeniden düzenlemek için bu hizmet API'sini kullanabilir. "x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür. Ayrıca, kullanıcının belirli kişilerinde veya kullanıcının ait olduğu kuruluşta arama yapmak mümkündür. Arama yanıtı bilgileri, kullanıcı e-posta adresini ve ilgili kullanıcı adını içerir.
Kişisel Alanı Güncelleştir	İş uygulamaları, paketteki bir belgenin kişisel imza alanını güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.
Kurumsal Paketin İş Akışı Kullanıcı Kimlik Doğrulama (Belge Açma) Güncelleştirme	İş uygulamaları, alıcıların paket kimlik doğrulamalarını ve erişim süresini güncelleştirmek için bu hizmet API'sini kullanabilir. Bu API, kimlik doğrulama isteğinde "kapsam" değişkeni kullanıldıysa kuruluş yöneticisi veya kuruluş kullanıcısı tarafından da kullanılabilir
Kurumsal Paketin İş Akışı Kullanıcı Kimlik Doğrulaması (Belge Açma) Alma	İş uygulamaları, paket için erişim güvenlik ayarlarını etkinleştirmek için bu hizmet API'sini kullanabilir. Güvenliğin yapılandırıldığı alıcılar URL'deki sırayla tanımlanır. Paket kimliği, istek URL'sinde de tanımlanır. Erişim güvenliği etkinleştirilmişse alıcılar bu sürenin kapsamı dışında belge paketine erişemez. Belge sahibi, bir alıcı için paketin kimlik doğrulama tabanlı güvenliğini de yapılandırabilir.
Kurumsal Şablonları Alma	İş uygulamaları, geçerli kullanıcının kurumsal şablonlarının listesini almak için bu hizmet API'sini kullanabilir. Bu, kimlik doğrulama isteğinde "kapsam" değişkeni kullanıldıysa kuruluş yöneticisi veya kurumsal kullanıcı anlamına gelir. "x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür.
Paket Ayrıntılarını Alma	İş uygulamaları bir paketin ayrıntılarını almak için bu hizmet API'sini kullanabilir. Bu API, iş uygulaması tarafından "Kapsam Kimlik Doğrulaması" aracılığıyla kurumsal kullanıcı adına eylem gerçekleştirmek için de kullanılabilir.
Paket Ekle	Bu hizmet API'si, bir veya daha fazla belgeyi barındıracak bir belge paketi eklemek/oluşturmak için kullanılır. Bu paket daha sonra yeni bir iş akışı başlatmak üzere belge ve alıcı eklemek için kullanılabilir. Daha önce belirtildiği gibi, belgelerle çalışmak istiyorsanız bu çağrı zorunludur. İmzalamaHub'a belge yükleyebilmeniz veya ekleyebilmeniz için önce bir paket bulunmalıdır.. Tek bir belge bile paketin bir parçasıdır: tek bir belge içeren paket. Not: Bir paket oluşturulduktan sonra gerekirse yeniden adlandırılabilir.
Paketi İndir	İş uygulamaları, belge paketini ikili biçimde indirmek için bu hizmet API'sini kullanabilir. Paket kimliği kaynak URL'sinde sağlanır. Paket yalnızca bir belge içeriyorsa, indirme ikili PDF belgesidir. Alternatif olarak, pakette birden fazla belge varsa, indirme tüm belgelerin ikili zip dosyasıdır. x-password ve x-otp üst bilgileri isteğe bağlıdır. Belge sahibi bunları iş akışı oluşturma aşamasında ayarladıysa gereklidir.
Paketi Sil	İş uygulamaları, kullanıcı gelen kutusundan belge silmek için bu hizmet API'sini kullanabilir. Paket kimliği kaynak URL'sinde "{package_id}" olarak sağlanır. Belge durumu BEKLENİYORsa, silme işleminin sonucu olarak otomatik olarak reddedilir. Belgenin durumu PAYLAŞILDI ise, belge otomatik olarak geri çağrılır ve belge silinmeden önce iş akışı durdurulur.
Paketi Yeniden Adlandır	Bu hizmet API'si belge paketini yeniden adlandırmak için kullanılır. Belge paketi, çağrının URL'sindeki benzersiz tanımlayıcısıyla tanımlanır.
Paketi Özel veya Paylaşılan Alan klasörüne taşıma	İş uygulamaları, belge paketini paylaşılan bir alana veya kullanıcının özel klasörüne taşımak için bu hizmet API'sini kullanabilir.
Paketleri Al	İş uygulamaları, farklı durumlara göre filtrelenen belgelerin listesini almak için bu hizmet API'sini kullanabilir. Kullanıcılar, sayfa başına bir dizi kayıt sağlayarak kayıtları sayfalara bölebilir.
Paylaşılan Alan Al	İş uygulamaları, belirli bir paylaşılan alanı almak için bu hizmet API'sini kullanabilir. Bu API paylaşılan alan, sahibi ve ortak çalışan hakkındaki bilgileri döndürür.
Paylaşılan Alanı Güncelleştir	İş uygulamaları, paylaşılan alanı güncelleştirmek için bu hizmet API'sini kullanabilir. Paylaşılan alanları güncelleştirmenin kullanılabilirliği, atanan kurumsal kullanıcı rolüne tabidir. Bu sağlamayı sağlamak için Enterprise Admin, Roller>Belge Ayarları'nda 'Paylaşılan Alanı Yönet' seçeneğini etkinleştirir.
Paylaşılan Alanı Sil	İş uygulamaları paylaşılan alanı silmek için bu hizmet API'sini kullanabilir. Paylaşılan alanları silmenin kullanılabilirliği, atanan kurumsal kullanıcı rolüne tabidir. Bu sağlamayı sağlamak için Enterprise Admin, Roller>Belge Ayarları'nda 'Paylaşılan Alanı Yönet' seçeneğini etkinleştirir.
QR Kodu Ekle	İş uygulamaları, paketteki bir belgeye QR Kodu eklemek için bu hizmet API'sini kullanabilir.
QR Kodunu Güncelleştirme	İş uygulamaları, paketteki bir belgenin QR Kodunu güncelleştirmek için bu hizmet API'sini kullanabilir.
RadioBox Alanı Ekle	İş uygulamaları, paketteki belgeye onay kutusu eklemek için bu hizmet API'sini kullanabilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir. Genişlik ve yükseklik parametreleri sağlanmazsa, varsayılan boyut olarak 10x10 atanır. Genişlik veya yükseklik (veya her ikisi) sağlanmışsa, sistem sağlanan bu değerleri birbiriyle karşılaştırır. Genişlik ve yükseklik arasındaki daha büyük değer her iki boyuta da atanır.
RadioBox Alanını Güncelleştir	İş uygulamaları, paketteki bir belgenin radyo düğmesini güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir. Genişliği ve yüksekliği güncelleştirilemez. Eklendiklerinde olduğu gibi kalırlar.
Tam İş Akışı Ortada (İş Akışını Sonlandır)	İş uygulamaları, iş akışının ortasında bile iş akışının tamamlandığını işaretleyebilir. İş akışının durumunu tamamlandı olarak değiştirmek için bu hizmet API'sini kullanın. Belgeyi henüz imzalamamış alıcılar varsa. İmzaları artık gerekli olmayacak ve belgeyi gelen kutularında daha fazla göremezler. Taşıyıcı belirteci belge sahibine ait olmalıdır veya kuruluş yöneticisi bu eylemi gerçekleştirmek üzere belge sahibi adına erişim belirtecini almak için kapsam değişkenini kullanabilir.
TextBox Alanı Ekle	İş uygulamaları, paketteki bir belgeye metin girişi alanı eklemek için bu hizmet API'sini kullanabilir. Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar. Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.
TextBox Alanını Güncelleştir	İş uygulamaları, paketteki belgenin metin kutusunu güncelleştirmek için bu hizmet API'sini kullanabilir. Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.
Toplu İmza Paketleri	İş uygulamaları, belgeleri son kullanıcıya görüntülemeden birden çok belgeyi (elektronik ve dijital) imzalamak/paylaşmak/imzalamak ve paylaşmak için bu API'yi kullanabilir. Bu API,iş uygulamasından belge paketleri ve imzaların ayrıntıları, bizzat ve baş harfler alanları hakkında bilgi gerektirir. Toplu imzalama işleminin başarıyla tamamlanmasının ardından API, belge paketlerinin durumlarını ve işlem kimliklerini döndürür. Belgeyi İmzala API'sinin aksine, bu API yalnızca belge paketini imzalamakla kalmaz, aynı zamanda alıcının İmzalayan, Düzenleyici veya Gözden Geçiren olup olmadığına bağlı olarak onaylanıp gözden geçirilmiş olarak işaretler. Durumu TAMAMLANDı olarak döndüren tüm belge paketleri bu API tarafından imzalanmış, onaylanmıştır veya gözden geçirilmiştir. Toplu İmzalama, tüm imzalama zamanı kimlik doğrulama yöntemleriyle çalışır. sign bulk_action olarak geçirilirse ve paket Taslak durumundaysa, İmzala ve Paylaş otomatik olarak gerçekleştirilir. Belgeleri Önceden İmzala API'sini kullandıktan sonra bu API'yi çağırmanız gerekir. İmzalamadan önce belgenin herhangi birinde değişiklik yapmanız gerekirse, Toplu İmza Öncesi Belge API'sini çağırmadan önce Form Alanlarını Doldur API'sinin çağrılması gerekir. Bu API'nin başarıyla tamamlanması için belgedeki zorunlu giriş alanlarının tamamlanması gerektiğini unutmayın; ancak otomatik olarak doldurulan alanlar (Ad, E-posta, Tarih, İş Unvanı vb.) otomatik olarak doldurulur. İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir. Belge imzalandıktan sonra doğrulama yanıtı Toplu İmzalama Durumu API'sinden görülebilir. Kimlik Doğrulaması için Birinci veya İkinci Faktör OTP Kullanımı Sunucu tarafı imzalama işlemi için OTP kimlik doğrulamasının açık olması durumunda, istemci uygulamalarının OTP API çağrısı aracılığıyla Toplu İmza kimlik doğrulamasını kullanarak mobil numara için bir OTP oluşturması gerekir. İlgili iş uygulamaları OTP'yi kullanımdan almalı ve API çağrısı yaparken göndermelidir. Bu, istekteki "x-otp" üst bilgisi kullanılarak yapılır.
Toplu İmzalama Durumu	İş uygulamaları, Toplu İmzalama Paketleri API'si tarafından işlenen belge paketlerinin ayrıntılarıyla birlikte belirli bir toplu imzalama işleminin durumunu almak için bu API'yi kullanabilir. Toplu İmzalama Paketleri API'sinin ardından bu API'yi çağırmanız gerekir. İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir. RAS imzalama için ACTION özelliği REMOTE_AUTHORIZATION_REQURIED ve STATUS özelliği BEKLEMEDE olur ve isteğin mobil cihaz kullanılarak yetkilendirilmesi gerektiğini belirtir. İmzalama işlemi, yapılandırılan farklı güvence düzeyleri nedeniyle bazı belgelerde başarısız olursa ve kullanıcı başarısız belgelerde imzalama işlemini tamamlamak için imzalama işlemini yeniden başlatmak isterse, ACTION özelliği REINITIATE_SIGNING_PROCESS olur ve STATUS özelliği BEKLEMEDE olur.
Yer Tutucuyu Güncelleştir	İş uygulamaları, iş akışındaki bir yer tutucuyu güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki belirli bir yer sahibinin ayrıntılarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı yer tutucusu iş akışına eklenme sırasına göre tanımlanır. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
Şablonları Al	İş uygulamaları, geçerli kullanıcının şablon listesini almak için bu hizmet API'sini kullanabilir. "x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür. Ayrıca, bir kullanıcının kişisel şablonlarını veya kuruluş şablonlarını, kuruluş yöneticisi tarafından kullanıcı rolüne göre izin verilen şekilde aramak mümkündür.

Alanları Otomatik Yerleştir

İşlem Kimliği:

V4_Fields_AutoPlace

İş uygulamaları, sağlanan arama ölçütüne göre belgeye imza veya kullanıcı tanımlı form alanları eklemek için bu API'yi çağırabilir. Yerleştirme seçenekleri şunlardır: solda, sağda, üstte ve altta. Belge aramadır ve karşılanan arama ölçütlerinin tüm örnekleri işlenir. Bu, tek bir çağrıyla birden çok alan eklemenize olanak tanır. Örneğin, bir belgeyi karşıya yükleyin ve "Burada imzalayın:" sözcüğünün tüm örneklerinin sağındaki imza alanını otomatik olarak yerleştirin. Bu, zaman kazandırır ve iş akışında hiçbir imzanın kaçırılmamasını sağlar.

API çağrısı tüm alan türlerini destekler; elektronik, dijital, bizzat, baş harfler ve metin alanı vb.

Buna ek olarak, API çağrısı "order" değişkenini destekler. Bu, bir dizi imza alanını tek bir kullanıcıya otomatik olarak atayabileceğiniz anlamına gelir. Bu nedenle, iş akışında birden fazla kullanıcıya imza alanları yerleştirmek ve atamak için çağrı yinelenebilir.

İmza alanlarının belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcının bulunması gerekir. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Bu API çağrısı aynı belgede birden çok kez kullanılabilir. Bunu yapmanın nedeni, bir belgede birden çok imzalayana hizmet vermektir. Alıcı veya imzalayan, çağrıda geçirilen "order" değişkeni tarafından tanımlanır.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin kimliği.
Belge Kimliği	documentId	True	integer	Alanların istendiği belgenin kimliği.
search_text	search_text		string	Belgede aranması gereken Word.
order	order	True	integer	Alanların otomatik olarak atanacağı kullanıcının sırası. SigningHub'daki iş akışı alıcıları sipariş eder. Bu liste, belirlenen ilk imzalayan için "1" ile başlar.
yerleştirme	placement		string	Metin bulunursa, alanlar belgeye yerleştirilir. Alanın yerleşimi bu öznitelikte belirtilebilir. Bir alanın yerleşiminin olası değerleri LEFT, RIGHT, TOP, BOTTOM şeklindedir. Değer sağlanmazsa varsayılan değer LEFT olur.
field_type	field_type		string	Belgede oluşturulacak alan türü. Olası değerler şunlardır: "SIGNATURE", "IN_PERSON_SIGNATURE", "INITIALS", "TEXT", "NUMBER" ,"NAME", "EMAIL", "COMPANY", "JOBTITLE", "RADIOBOX", "CHECKBOX", "DATE", "ATTACHMENT"
level_of_assurance	level_of_assurance		array of string	Güncelleştirilecek Güvence Düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
yer tutucu	placeholder		string	Zorunlu Ek durumunda not sağlayın
radio_group_name	radio_group_name		string	Grup adı yalnızca birden çok Radyo kutusunu birlikte gruplandırmak için Bir Radyo Kutusu türü alanı eklerken gereklidir.
format	format		string	Alanın metin biçimi. Yalnızca tarih türü alanı için kullanılır. Olası değerler şunlardır: m/d m/d/yy m/d/yyy aa/gg/yy aa/gg/yyyy aa/yy aa/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy gg/aa/yy ddmmmyyyy
value	value		string	Kullanıcının alanda göstermek istediği değer.
max_length	max_length	True	integer	Alanda izin verilen değerin uzunluk üst sınırı. 1 - 9999 arasında olmalıdır
validation_rule	validation_rule		string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
required	required	True	boolean
türü	type		string	Şu anda her zaman metin alanı için EQUALS olarak ayarlanmış doğrulama kuralının türünü belirtir.
value	value		string	Doğrulama için kullanılan değeri temsil eder.
name	name		string	Metin alanı için seçilen yazı tipinin adı. Olası değerler "COURIER", "HELVETICA" şeklindedir.
size	size		string	Metin alanı için seçilen yazı tipinin boyutu. Olası değerler: 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Özgün PDF belgesindeki yazı tipinin boyutu.
çok satırlı	multiline	True	boolean	Bu, Metin Alanı alan türüne aittir ve True olarak ayarlanırsa, metin alanı alanı çok satırlı seçenekle oluşturulur.

Döndürülenler

response

array of AutoPlaceFieldsResponse

Ağ Geçidi Denetleyicisi Belgeyi Onayla

İşlem Kimliği:

V4_Package_GatekeeperApprove

İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırasıyla onaylayabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Onaylanacak paketin kimliği.
neden	reason		string	Paketi onaylamanın nedeni.
Belge Erişim Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
Belge One-Time Parolası	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.

Döndürülenler

response

object

Ağ Geçidi Denetleyicisi Reddetme Belgesi

İşlem Kimliği:

V4_Package_GatekeeperDecline

İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırasıyla reddedebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Reddedilecek paketin kimliği.
neden	reason		string	Kullanıcı tarafından reddedilmesi için sağlanan neden.

Döndürülenler

response

object

Baş Harfleri Doldur

İşlem Kimliği:

V4_Initials_Fill

İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgedeki baş harflerin baş harflerini sırayla doldurabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Belgenin kimliği.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
image	image	True	string	Baş harflerin doldurulması için kullanılan Base64 görüntüsü.
method	method		integer	0 = ÇIZ 1 = METNEÇEVİr 2 = KARŞıYA YÜKLE 3 = SIGNATURE_PAD 4 = YOK
apply_to_all	apply_to_all	True	boolean	Tüm baş harfler doldurulacaksa true.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Belge Alanlarını Al

İşlem Kimliği:

V4_Fields_GetAllDocumentFields

İş uygulamaları bu hizmet API'sini kullanarak belge alanlarını (örneğin, baş harfleri, kişilerin, imza alanlarını veya form alanlarını) alabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin kimliği.
Belge Kimliği	documentId	True	integer	Alanların istendiği belgenin kimliği.
Sayfa No	pageNo	True	integer	Alanların istendiği belgenin sayfa numarası. Sayfa numarası sağlanmazsa, belgenin tamamına ait alanlar döndürülür.
Gönderen	x-mobile		string	İsteğin/eylemin gönderenini (Web/Mobil) tanımlama

Döndürülenler

Body

FieldsResponse

Belge Alanı Ata

İşlem Kimliği:

V4_Fields_AutoAssignField

İş uygulamaları bu hizmet API'sini kullanarak kullanıcıları imza alanları gibi giriş alanlarına atayabilir ve bu nedenle imzalama sırasını tanımlayabilir. Alanların belgede zaten mevcut olması ve kullanıcıların iş akışında mevcut olması gerekir. İş akışı belgesinin kimliği, paket tanımlayıcısıyla birlikte kaynak URL'sinde sağlanır.

Alıcılar bir iş akışında olduğunda numaralandırılır, bir taneden başlar ve her ek iş için sayılır. Bu nedenle, bir iş akışında üç kullanıcı varsa, "1", "2" ve "3" numaralıdır. Bu API çağrısı, bir kullanıcıyı iş akışı sipariş numarasına göre belgedeki bir giriş alanına atamanızı sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	İş akışı kullanıcısının güncelleştirilmesi gereken belge kimliği.
field_name	field_name	True	string	Atanacak imza alanının adı.
radio_group_name	radio_group_name		string	radyo kutusu için grup adı sağlama
order	order	True	integer	Alanın atandığı iş akışındaki kullanıcının sırası.
level_of_assurance	level_of_assurance		array of string	Eklenecek güvence düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"

Döndürülenler

response

object

Belge Alanını Sil

İşlem Kimliği:

V4_Fields_DeleteDocumentField

İş uygulamaları, paketteki belge alanını silmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Silinecek alanın adı.

Döndürülenler

response

object

Belge Ayrıntılarını Alma

İşlem Kimliği:

V4_Documents_GetDocumentDetails

İş uygulamaları belge ayrıntılarını almak için bu hizmet API'sini kullanabilir. Belge kimliği URL'de "{document_id}" olarak sağlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin Paket Kimliği.
Belge Kimliği	documentId	True	integer	Belge ayrıntılarının istendiği belge kimliği.
Belge Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
One-Time Parolası (OTP)	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

Body

DocumentDetailsResponse

Belge Gönder

İşlem Kimliği:

V4_Package_Submit

SigningHub rollerinden biri "Düzenleyici" olarak adlandırılır. Bu, alıcının belgedeki giriş alanlarını düzenlemesine izin verir, ancak imza gerektirmez. Tamamlandıktan sonra alıcı değişikliklerini gönderir. GUI'de kullanılan düğmeye "Gönder" adı verilir.

Bu, düzenleyicinin değişikliklerini bir API çağrısı aracılığıyla göndermesine eşdeğer bir işlemdir.

Kullanılabilir tüm iş akışı alıcı rollerinin açıklaması için İmzalamaHub Rolleri'ne tıklayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Gönderilecek belgeyi içeren SigningHub paket kimliği.
Belge Erişim Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
Belge One-Time Parolası	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Belge için Sertifika İlkesi alma

İşlem Kimliği:

V4_Documents_GetCertifyPolicy

İş uygulamaları, bir paketteki belgenin imza ayarlarını onaylamak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	İndirilecek belgenin kimliği.

Döndürülenler

Body

CertifyPolicyResponse

Belge için Sertifika İlkesini Güncelleştirme

İşlem Kimliği:

V4_Documents_UpdateCertifyPolicy

İş uygulamaları bu hizmet API'sini kullanarak paketteki bir belgenin imza ayarlarını onaylayabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirileceği belgenin kimliği.
enabled	enabled	True	boolean	Belge için sertifika ayarlarının etkinleştirilmesi gerekiyorsa true.
izin	permission	True	string	Belge için ayarlanacak izin düzeyini onaylar. Olası değerler "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" ve "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" değerleridir.
lock_form_fields	lock_form_fields	True	boolean	Form alanları geçerli belgedeki son imzadan sonra kilitlenecekse True.

Döndürülenler

response

object

Belge Paketini Paylaş

İşlem Kimliği:

V4_Workflow_StartWorkflow

İş uygulamaları, belge paketini imzalayanlarla paylaşmak ve yeni bir iş akışı başlatmak için bu hizmet API'sini kullanabilir. Belge, şablon uygulanarak ve isteğe bağlı olarak şablonda tanımlanan kullanıcıları ve eylemleri güncelleştirerek hazırlanmış olmalıdır. Paylaşılacak paket kimliği kaynak URL'sinde sağlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Paylaşılacak belge paketi.

Döndürülenler

response

array of StartWorkflowResponse

Belgeyi Geri Çek

İşlem Kimliği:

V4_Workflow_RecallWorkflow

İş uygulamaları, devam eden bir iş akışını durdurmak için bu hizmet API'sini kullanabilir. Belge kimliği kaynak URL'sinde sağlanır. Geri çağrıldıktan sonra belge durumu otomatik olarak "TASLAK" olarak değişir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Geri çekilecek paketin kimliği.

Döndürülenler

response

object

Belgeyi İmzala

İşlem Kimliği:

V4_Signing_SignDocument

İş uygulamaları, signHub kullanarak belgeyi son kullanıcıya görüntülemeden belgeyi imzalamak için (elektronik ve dijital) bu hizmet API'sini kullanabilir. Örneğin, bir iş uygulamasının belgeyi kullanıcıya görüntülemesi için başka bir yöntemi olabilir ve yalnızca SigningHub'ın imzalama işlevi gereklidir veya toplu işlemler için kullanıcının her belgeyi tek tek görüntülemesine ve onaylamasına gerek kalmadan imzalaması haklı olabilir. İmzalamadan önce belgeye kaydedilecek değişiklikler varsa, Belgeyi İmzala API'sini çağırmadan önce Form Alanlarını Doldur API'sinin çağrılması gerekir. Bu API'nin başarıyla tamamlanması için belgedeki zorunlu giriş alanlarının tamamlanmasını gerektirdiğini unutmayın.

İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir.

Bu çağrı tamamlandığında, belgenin son imzalayanı imzalayan ise Belgeyi Bitir API çağrısının çağrılmış olması önemlidir. Bunun nedeni, API çağrılmadan belgenin belge sahibine "Devam Ediyor" durumunda kalmasıdır. API çağrıldıktan sonra, belge sahibi için durum "Tamamlandı" olarak değişir.

Belge imzalandıktan sonra doğrulama yanıtı Belge Doğrulama API'sini Al'dan görülebilir.

Kimlik Doğrulaması için Birinci veya İkinci Faktör OTP Kullanımı

Sunucu tarafı imzalama işlemi için OTP kimlik doğrulaması açıksa, istemci uygulamalarının OTP API çağrısı aracılığıyla İmzalayan Kimlik Doğrulaması'nı kullanarak mobil numara için bir OTP oluşturması gerekir. İlgili iş uygulamaları OTP'yi kullanımdan almalı ve API çağrısı yaparken göndermelidir. Bu, istekteki "x-otp" üst bilgisi kullanılarak yapılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İmza için belgeyi içeren paketin tanımlayıcısı.
Belge Kimliği	documentId	True	integer	İmzalanacak belgenin tanımlayıcısı.
field_name	field_name	True	string	Belgedeki imza alanının benzersiz tanımlayıcısı.
hand_signature_image	hand_signature_image		string	Belgeye yerleştirilen görünür imza görünümünün Base64 kodlanmış dize görüntüsü. Bu çağrıyı kullanarak kullanıcının kişisel ayarlarından alınabileceğini unutmayın. (Yanıt ikili olduğundan, iş uygulamasının bu API çağrısında göndermeden önce Base64 kodlaması gerekir.)
hand_signature_method	hand_signature_method		integer	0 = ÇIZ 1 = METNEÇEVİr 2 = KARŞıYA YÜKLE 3 = SIGNATURE_PAD 4 = YOK
signing_reason	signing_reason		string	Alıcı tarafından sağlanan imzalama nedeni. Not: XML belgeleri için taahhüt türü göstergesi
signing_location	signing_location		string	Alıcı tarafından sağlanan imzalayanın yerel ayarı.
contact_information	contact_information		string	Alıcı tarafından sağlanan imzalayanın iletişim bilgileri.
user_name	user_name		string	Alıcı tarafından sağlanan imzalayanın adı. Bunun yalnızca kişisel imzalama işlemleri için geçerli olduğunu unutmayın.
user_password	user_password		string	Kullanıcı tarafından sağlanan parola, kullanıcının imza ayarlarına tabidir.
appearance_design	appearance_design		string	İmzalama için kullanıcı tarafından sağlanan imza görünümünün adı. Hiçbir görünüm adı sağlanmazsa varsayılan seçili görünüm kullanılır. Olası değerler şunlardır: "COMPANY_LOGO","DETAILED_SIGNATURE","HAND_SIGNATURE"
signing_capacity	signing_capacity		string	Belgenin imzalanması gereken sertifika profilinin/imzalama kapasitesinin adı. Sağlanmadıysa, imzalamak için varsayılan kapasite kullanılır. Sağlanan ad, büyük/küçük harf duyarlılığı nedeniyle gerçek profille tam olarak aynı olmalıdır.
skip_verification	skip_verification	True	boolean	Yanıt gövdesi true olarak ayarlandığında hiçbir imza doğrulaması döndürülmezse. Bu parametre için varsayılan değer false olarak ayarlanır.
signing_server	signing_server		string	Belgenin imzalanması gereken imzalama sunucusunun adı.
mechanism	mechanism		string	Kimlik doğrulama mekanizması. Mekanizma için olası değerler şunlardır: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
password	password		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_PASSWORD' kullanılırken gereklidir
token	token		string	Üçüncü taraf sunucudan alınacak isteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2' 'AUTHENTICATION_OIDC' 'AUTHENTICATION_GOOGLE' 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' kullanılırken gereklidir
user_identifier	user_identifier		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_ACTIVE_DIRECTORY' veya 'AUTHENTICATION_SAML' kullanılırken gereklidir
kimlik	id		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_SALES_FORCE' veya 'AUTHENTICATION_IDFY' kullanılırken gereklidir. 'AUTHENTICATION_IDFY' için requestId değeridir
code_verifier	code_verifier		string	İstemci için PKCE etkinleştirildiyse Kod Doğrulayıcı.
Nonce	nonce		string	İstemci için etkinleştirildiyse Nonce değeri.
One-Time Parolası (OTP)	x-otp		string	İmzalama işlemi için ikinci faktör kimlik doğrulaması olarak kullanılan OTP.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.
Mobil Kaynak	x-mobile		string	İsteğin/eylemin gönderenini (Web/Mobil) tanımlama

Döndürülenler

Body

SignDocumentResponse

Belgeyi İndir

İşlem Kimliği:

V4_Documents_DownloadDocumentBytes

İş uygulamaları, belge baytlarını indirmek için bu hizmet API'sini kullanabilir. Paket kimliği ve belge kimliği kaynak URL'sinde sağlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	İndirilecek belgenin kimliği.
Belge Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
One-Time Parolası (OTP)	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Belgeyi Karşıya Yükle

İşlem Kimliği:

V4_Documents_UploadStream

İş uygulamaları bu hizmet API'sini kullanarak kurumsal kullanıcının hesabına bağlı bir belge paketine belge ekleyebilir. Belge bilgileri HTTP isteği üst bilgisinde, belge baytları ise HTTP isteği gövdesinde gönderilir. Not"x-convert-document" üst bilgisi "true" değerine ayarlanırsa SigningHub desteklenen belge biçimlerini PDF'ye dönüştürür. Bu değerin "false" olarak ayarlandığı durumlarda desteklenen tek durum, Word biçimini ve XML belgelerini korumaktır.

SigningHub, her biri karşıya yüklendikten sonra PDF biçimine dönüştürülebilen çok çeşitli belge biçimlerini destekler. Tam liste için buraya tıklayın.

Not PDF belgeleri sisteme yüklendikten sonra değiştirilmez.

Bu çağrıyı kullanarak belge ekleyebilmeniz için önce bir paketin zaten mevcut olması gerektiğini unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Dosya İçeriği	body	True	binary	Bu, ham ikili biçimdeki belgedir.
Dosya Adı	x-file-name		string	Uzantılı dosyanın adıdır.
Belgeyi Dönüştür	x-convert-document		string	Bu, belgenin PDF'ye dönüştürülmesini veya özgün biçiminde saklanması gerekip gerekmediğini belirler. Desteklenen tek özgün biçimin şu anda Word ve XML. Bu üst bilgi değeri "false" olarak ayarlanırsa diğer tüm belge türleri hataya neden olur. PDF belgesi karşıya yükleniyorsa bu Üst Bilgi atlanabilir.
Source	x-source		string	Bu, belgenin karşıya yüklendiği belgenin kaynağının kimliğidir, örneğin "Uygulamam".

Döndürülenler

Body

UploadDocument

Belgeyi Onayla

İşlem Kimliği:

V4_Package_Approve

İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcı tarafından bir belgeyi sırayla onaylayabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Onaylanacak paketin kimliği.
neden	reason		string	Paketi onaylamanın nedeni.
Belge Erişim Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
Belge One-Time Parolası	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Belgeyi Reddet

İşlem Kimliği:

V4_Package_Decline

İş uygulamaları bu hizmet API'sini kullanarak belirtilen kullanıcının sırasıyla bir belgeyi reddetmesini sağlayabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Reddedilecek paketin kimliği.
neden	reason		string	Kullanıcı tarafından reddedilmesi için sağlanan neden.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Belgeyi Sil

İşlem Kimliği:

V4_Documents_DeleteDocument

İş uygulamaları, paketteki bir belgeyi silmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Silinecek belgenin kimliği.

Döndürülenler

Body

DocumentResponse

Belgeyi Yeniden Adlandır

İşlem Kimliği:

V4_Documents_RenameDocument

İş uygulamaları, paketteki bir belgeyi yeniden adlandırmak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirileceği belgenin kimliği.
document_name	document_name	True	string	Belgenin yeni adı.

Döndürülenler

Body

DocumentResponse

CheckBox Alanı Ekle

İşlem Kimliği:

V4_Checkbox_AddCheckBox

İş uygulamaları, paketteki belgeye onay kutusu eklemek için bu hizmet API'sini kullanabilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Genişlik ve yükseklik parametreleri sağlanmazsa, varsayılan boyut olarak 10x10 atanır. Genişlik veya yükseklik (veya her ikisi) sağlanmışsa, sistem sağlanan bu değerleri birbiriyle karşılaştırır. Genişlik ve yükseklik arasındaki daha büyük değer her iki boyuta da atanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
order	order	True	integer	Alanın eklendiği iş akışındaki kullanıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
field_name	field_name		string	Eklenecek sağlanan alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
value	value		string	Alanın değeri. Olası değerler "true" veya "false" olabilir
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
validation_rule	validation_rule		string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.

Döndürülenler

Body

AddFieldResponse

CheckBox Alanını Güncelleştir

İşlem Kimliği:

V4_Checkbox_UpdateCheckBox

İş uygulamaları, paketteki bir belgenin onay kutusu alanını güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Genişliği ve yüksekliği güncelleştirilemez. Eklendiklerinde olduğu gibi kalırlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	Yeniden adlandırma amaçlanıyorsa alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
value	value		string	Alanın değeri. Olası değerler "true" veya "false" olabilir
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
validation_rule	validation_rule		string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Dijital İmza Alanı Ekle

İşlem Kimliği:

V4_Signature_AddSignature

İş uygulamaları, paketteki bir belgeye dijital imza alanı eklemek için bu hizmet API'sini kullanabilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı ayrıntılarının güncelleştirilmiş olması gereken paket kimliği.
Belge Kimliği	documentId	True	integer	Alanın eklendiği belge kimliği.
order	order	True	integer	Alanın oluşturulduğu alıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulmak üzere olduğu sayfa numarası.
field_name	field_name		string	Eklenecek alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
level_of_assurance	level_of_assurance		array of string	Eklenecek güvence düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
göstermek	display		string	Eklenecek alanın görünürlüğü, olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur
enabled	enabled	True	boolean	Alan için kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
enabled	enabled	True	boolean	Alan için SMS/E-posta OTP kimlik doğrulaması etkinleştirildiyse true. Aksi durumda yanlış.
mobile_number	mobile_number		string	Alanın atandığı alıcının cep telefonu numarası.
enabled	enabled	True	boolean	Alan için TOTP kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.

Döndürülenler

Body

SignatureFieldResponse

Dijital İmza Alanını Güncelleştir

İşlem Kimliği:

V4_Signature_UpdateSignature

İş uygulamaları, paketteki bir belgenin dijital imza alanını güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
level_of_assurance	level_of_assurance		array of string	Güncelleştirilecek Güvence Düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SIGNATURE", "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SIGNATURE", "HIGH_TRUST_ADVANCED", "QUALIFIED_ELECTRONIC_SIGNATURE"
renamed_as	renamed_as		string	Alanın yeniden adlandırılması amaçlanıyorsa, alanın adı güncelleştirildi.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
göstermek	display		string	Güncelleştirilecek alanın görünürlüğü, olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur
enabled	enabled	True	boolean	Alan için kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
enabled	enabled	True	boolean	Alan için SMS/E-posta OTP kimlik doğrulaması etkinleştirildiyse true. Aksi durumda yanlış.
mobile_number	mobile_number		string	Alanın atandığı alıcının cep telefonu numarası.
enabled	enabled	True	boolean	Alan için TOTP kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Eki İndir

İşlem Kimliği:

V4_Attachment_DownloadAttachment

İş uygulamaları, bir belgenin ekini indirmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Ekin eklendiği belgenin kimliği.
Ek Kimliği	attachment_id	True	integer	Ekin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Eki Karşıya Yükle

İşlem Kimliği:

V4_Attachment_UploadAttachment

İş uygulamaları bir belgeye ek yüklemek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Ekin eklenmesi gereken belgenin kimliği.
Ek Dosyası İçeriği	body	True	binary	Bu, ham ikili biçimdeki belgedir.
Alan Adı	x-field-name		string	Gerekirse alan adı. Bu isteğe bağlıdır ve alan adı ek alanıyla birlikte işlenir. Ayrıca, alan adı parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Dosya Adı	x-file-name	True	string	Uzantılı dosyanın adıdır.
Belge Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
parolayı One-Time	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

Body

AddAttachmentResponse

Eki Sil

İşlem Kimliği:

V4_Attachment_DeleteAttachment

İş uygulamaları, bir belgenin ekini silmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Ekin eklendiği belgenin kimliği.
Ek Kimliği	attachment_id	True	integer	Ekin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Ekleri Al

İşlem Kimliği:

V4_Attachment_GetAttachments

İş uygulamaları, bir belgenin eklerini almak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin paket kimliği.
Belge Kimliği	documentId	True	integer	Ekin eklendiği belgenin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

array of GetAttachmentResponse

Form Alanlarını Doldur

İşlem Kimliği:

V4_Fields_FillFormFields

İş uygulamaları, bir belgedeki bir veya daha fazla form alanını belirtilen kullanıcı tarafından sırayla doldurmak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Belgenin kimliği.
auto_save	auto_save	True	boolean	Varsayılan değer yanlış'tır. Doğru, form alanları kullanıcı müdahalesi olmadan kaydediliyorsa ( örneğin, belgeyi kapatırken veya geri basarken). İmzalama, Baş Harfler, Kişiler, Gözden Geçirme, Gönderme eylemleri için değer false değeridir.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
value	value		string	Belgeye kaydedilecek alanın değeri.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
radio_group_name	radio_group_name		string	Radyo düğmesinin ait olduğu grup adı.
value	value	True	boolean	Belgeye kaydedilecek alanın değeri.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
value	value	True	boolean	Belgeye kaydedilecek alanın değeri.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
value	value		string	Belgeye kaydedilecek alanın değeri.
field_name	field_name	True	string	Belgedeki alanın benzersiz tanımlayıcısı.
value	value		string	Belgeye kaydedilecek alanın değeri.
Belge Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
One-Time Parolası (OTP)	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Güncelleştirme Sonrası İşleme

İşlem Kimliği:

V4_Workflow_UpdateWorkflowPostProcess

İş uygulamaları, paketteki bir belgenin iş akışına yer tutucu eklemek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Gönderi işlemenin güncelleştirildiği belge paketinin kimliği.
enabled	enabled	True	boolean	Doğru, paket için post işleme açıksa.
contacts	contacts		array of string
name	name	True	string
email	email	True	string
message	message		string	Tüm kişiler için özel dize iletisi. İleti, kişilere gönderilen e-postanın bir parçası olur.
google_drive	google_drive		boolean	Doğru, belge iş akışı tamamlandıktan sonra sağlanan google hesabına yüklenecekse.
Dropbox	dropbox		boolean	Doğru, iş akışı tamamlandıktan sonra belge sağlanan dropbox hesabına yüklenecekse.
onedrive	onedrive		boolean	Doğru, iş akışı tamamlandıktan sonra belge sağlanan oneDrive hesabına yüklenecekse.
workflow_recipients	workflow_recipients	True	boolean	Doğru, iş akışı tamamlama raporu, işlem sonrası yürütülürken iş akışının tüm alıcılarına gönderilecekse. Varsayılan değer yanlış'tır.
document_processing_report	document_processing_report	True	boolean	Doğru, belge işleme raporunu gönder (XML) iş akışı için etkinleştirilecekse

Döndürülenler

response

object

İlk Alan Ekle

İşlem Kimliği:

V4_Initials_AddInitial

İş uygulamaları bu hizmet API'sini kullanarak paketteki bir belgeye baş harf alanı ekleyebilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
order	order	True	integer	Alanın eklendiği iş akışındaki kullanıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
field_name	field_name		string	Eklenecek alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.

Döndürülenler

Body

AddFieldResponse

İlk Alanı Güncelleştir

İşlem Kimliği:

V4_Initials_UpdateInitial

İş uygulamaları, paketteki belgenin baş harfleri alanını güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin.

Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	Yeniden adlandırma amaçlanıyorsa alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.

Döndürülenler

response

object

İş Akışı Anımsatıcılarını Güncelleştirme

İşlem Kimliği:

V4_Workflow_UpdateWorkflowReminder

İş uygulamaları, iş akışına zaten eklenmiş olan bir alıcı için iş akışı anımsatıcılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki anımsatıcı ayarlarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı anımsatıcılarının güncelleştirildiği paket kimliği.
Sipariş	order	True	integer	İş akışı anımsatıcılarının güncelleştirildiği kullanıcının sırası.
apply_to_all	apply_to_all	True	boolean	Doğru, anımsatıcı ayarları iş akışındaki tüm alıcılara uygulanacaksa.
enabled	enabled	True	boolean	Anımsatıcı ayarlarının etkinleştirilmesi gerekiyorsa true.
frequency	frequency		string	Anımsatıcı Sıklığı. Olası Değerler GÜNSAY | SAAT.
remind_after	remind_after	True	integer	Gerekli, özelliğin etkinleştirilmesi durumunda true olur. İlk anımsatıcının iş akışı kullanıcısına gönderileceği gün sayısı.
enabled	enabled	True	boolean	Doğru, sonraki anımsatıcılar etkinleştirildiyse.
frequency	frequency		string	Anımsatıcı Sıklığını yineleyin. Olası Değerler GÜNSAY | SAAT.
keep_reminding_after	keep_reminding_after	True	integer	Gerekli, özelliğin etkinleştirilmesi durumunda true olur. Sonraki anımsatıcıların iş akışı kullanıcısına gönderileceği gün sayısı.
total_reminders	total_reminders	True	integer	Gerekli, özelliğin etkinleştirilmesi durumunda true olur. sonraki anımsatıcıların sayısı iş akışı kullanıcısına gönderilir.

Döndürülenler

response

object

İş Akışı Anımsatıcısı Alma

İşlem Kimliği:

V4_Workflow_GetWorkflowReminder

İş uygulamaları, iş akışına zaten eklenmiş olan alıcıların anımsatıcılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki anımsatıcı ayarlarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı anımsatıcılarının güncelleştirildiği paket kimliği.
Sipariş	order	True	integer	İş akışı anımsatıcılarının güncelleştirildiği kullanıcının sırası.

Döndürülenler

Body

ReminderResponse

İş Akışı Ayrıntılarını Alma

İşlem Kimliği:

V4_Workflow_GetWorkflowDetail

İş uygulamaları, paketin iş akışı ayrıntılarını almak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İndirilecek paketin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

Body

WorkflowDetailsResponse

İş Akışı Ayrıntılarını Güncelleştirme

İşlem Kimliği:

V4_Workflow_UpdateWorkflow

İş uygulamaları iş akışı ayrıntılarını güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan sonra yararlıdır, ancak iş uygulamaları onaylama iznini veya işlem sonrası ayrıntılarını geçersiz kılmak ister. Paket kimliği kaynak URL'sinde sağlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı ayrıntılarının güncelleştirilmiş olması gereken paket kimliği.
workflow_type	workflow_type		string	Paket için iş akışı türü(SERIAL,PARALLEL,INDIVIDUAL,CUSTOM). Değer sağlanmazsa, eski değer korunur.
workflow_mode	workflow_mode		string	Paketin iş akışı modu(ONLY_ME, ME_AND_OTHERS, ONLY_OTHERS). İş akışı modu ONLY_ME olarak ayarlanırsa, kimliği doğrulanmış başka bir kullanıcının kendisini paketlemek için hiçbir ortak çalışan eklenemez
continue_on_decline	continue_on_decline		boolean	Doğru, herhangi bir alıcı belgeyi reddetse bile iş akışının devam etmesi gerekiyorsa. Değer sağlanmazsa, eski değer korunur.
message	message		string	Belge sahibinden her alıcıya özel bir dize iletisi, bu ileti hem paylaşım e-postasında hem de ekranda görünür. Değer sağlanmazsa, eski değer korunur.
comments	comments		boolean	Açıklamalara izin ver

Döndürülenler

response

object

İş Akışı Geçmişini Alma

İşlem Kimliği:

V4_Workflow_GetWorkflowHistory

İş uygulamaları, bir belgede gerçekleştirilen eylemlerin listesini almak için bu hizmet API'sini kullanabilir. Paket kimliği kaynak URL'sinde sağlanır. Arama alanı (x-search-text üst bilgisi) e-posta, belge adı, eylem, bilgi anahtarı ve infovalue için tasarlanmıştır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Günlüğün gerekli olduğu belgenin kimliği.
Sayfa Numarası	pageNo	True	integer	Alınacak sayfa numarası.
Sayfadaki Kayıt Sayısı	recordsPerPage	True	integer	Bir sayfada alınacak toplam kayıt sayısı.
Metin Ara	x-search-text		string	Arama alanı (x-search-text üst bilgisi) e-posta, belge adı, eylem, bilgi anahtarı ve infovalue için tasarlanmıştır.

Döndürülenler

Body

WorkflowHistoryResponse

İş Akışı Kullanıcı İzinlerini Alma

İşlem Kimliği:

V4_WorkflowPermission_GetWorkflowPermissions

İş uygulamaları bu hizmet API'sini kullanarak bir alıcı için belge izinleri alabilir. Alıcı, iş akışındaki sıralamaya göre tanımlanır. Paketin kimliği kaynak URL'sinde sağlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı kullanıcısının güncelleştirilmesi gereken belge kimliği.
Sipariş	order	True	integer	İzinlerin istendiği iş akışındaki kullanıcının sırası. Hizmet, 0 değerini sırayla sağlayarak iş akışında en son eklenen ortak çalışanın izinlerini döndürür.

Döndürülenler

Body

WorkflowPermissionResponse

İş Akışı Kullanıcı İzinlerini Güncelleştirme

İşlem Kimliği:

V4_WorkflowPermission_UpdateWorkflowPermissions

İş uygulamaları, iş akışına zaten eklenmiş bir kullanıcının iş akışı izinlerini güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki izinleri geçersiz kılmak istediğinde kullanışlıdır. Belge paketinin kimliği kaynak URL'sinde sağlanır ve iş akışı kullanıcısı iş akışına eklenme sırasına göre tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı izinlerinin güncelleştirildiği paket kimliği.
Sipariş	order	True	integer	İş akışı izinlerinin güncelleştirildiği alıcının sırası.
apply_to_all	apply_to_all	True	boolean	doğru, izinler iş akışındaki tüm alıcılara uygulanacaksa.
print	print		boolean	Alıcının belgeyi yazdırmasına izin verilip verilmeyeceğini tanımlar.
indir	download		boolean	Alıcının belgeyi indirmesine izin verilip verilmeyeceğini tanımlar.
add_text	add_text		boolean	Alıcının belgeye metin alanları eklemesine izin verilip verilmeyeceğini tanımlar.
change_recipients	change_recipients		boolean	Kullanıcının henüz imzalamamış olan alıcıları değiştirmesine olanak tanır.
add_attachment	add_attachment		boolean	Alıcının PDF belgesine ek eklemesine izin verilip verilmeyeceğini tanımlar.
enabled	enabled	True	boolean	Yasal uyarı etkinleştirildiyse true.
legal_notice_name	legal_notice_name		string	Alıcı için seçilen yasal bildirimin adı.
enabled	enabled	True	boolean	Enabled
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

İş Akışı Kullanıcıları Siparişini Güncelleştir

İşlem Kimliği:

V4_Workflow_WorkflowUserUpdateOrder

İş uygulamaları, alıcının iş akışındaki sırasını güncelleştirmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Alıcıların eklendiği paketin kimliği.
Sipariş	order	True	integer	Güncelleştirilecek alıcının mevcut sırası.
order	order	True	integer	Güncelleştirilecek alıcının sırası.

Döndürülenler

response

object

İş Akışı Kullanıcılarını Alma

İşlem Kimliği:

V4_Workflow_GetWorkflowUsers

İş uygulamaları, paketin iş akışı ayrıntılarını almak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İndirilecek paketin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

array of WorkflowRecipient

İş Akışı Kullanıcılarını Güncelleştir

İşlem Kimliği:

V4_Workflow_WorkflowUserUpdate

İş uygulamaları bu hizmet API'sini kullanarak bir iş akışına zaten eklenmiş olan bir alıcı, grup veya yer sahibinin ayrıntılarını güncelleştirebilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki belirli bir kullanıcının ayrıntılarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı alıcısı iş akışına eklenme sırasına göre tanımlanır. XML türü belge hazırlığı sırasında yalnızca rol türlerini "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" desteklediğini unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı kullanıcısının güncelleştirilmesi gereken paket kimliği.
Sipariş	order	True	integer	İş akışındaki kullanıcının sırası.
user_email	user_email		string	İş akışında güncelleştirilecek yeni kullanıcının e-posta adresi. Değer sağlanmazsa, eski değer korunur.
user_name	user_name		string	Güncelleştirilecek alıcının adı. Değer sağlanmazsa, eski değer korunur.
email_notification	email_notification		boolean	Değerini "true" olarak ayarlamak, iş akışına geldiğinde kullanıcıya bir e-posta bildirimi gönderir. Değerini "false" olarak ayarlamak, kullanıcıya e-posta bildirimini kendi dönüşünde göndermez. Değer sağlanmazsa, eski değer korunur.
mobile_number	mobile_number		string	Cep telefonu numarası. Değer sağlanmazsa, eski değer korunur.
role	role	True	string	Güncelleştirilecek alıcının rolü. Olası değerler şunlardır: "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST". Değer sağlanmazsa, eski değer korunur. Ancak, XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
signing_order	signing_order		integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.
email_language_code	email_language_code		string	e-posta dil kodu
delivery_method	delivery_method	True	string	alıcının iş akışındaki teslim yöntemi. Olası değerler "EMAIL", "SMS" veya "EMAIL_AND_SMS" şeklindedir. Varsayılan değer E-POSTA olacaktır
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

Body

UpdateCollaboratorResponse

İş Akışı Kullanıcılarını Sil

İşlem Kimliği:

V4_Workflow_WorkflowDeleteUser

İş uygulamaları iş akışı alıcısını silmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Alıcının silindiği paket kimliği.
Sipariş	order	True	integer	İş akışında silinecek alıcının sırası.

Döndürülenler

response

object

İş Akışı Şablonu Uygula

İşlem Kimliği:

V4_Workflow_ApplyTemplate

İş uygulamaları, belgeye iş akışı şablonu uygulamak için bu hizmet API'sini kullanabilir. Şablonun uygulanması gereken belge kimliği kaynak URL'sinde sağlanır. Belge kimliği 0 olarak ayarlandığında, şablon bir pacakge içindeki tüm doucments'a uygulanır.

Şablonu uygularken şu iki önemli noktayı hatırlamak önemlidir:

1. Nokta - Uygulanan şablon zaten form alanları içeren bir PDF kullanılarak oluşturulduysa, bu şablonun uygulandığı belgenin bu form alanlarını önceden içermesi gerektiğinden emin olun ve SigningHub bu form alanlarını şablon aracılığıyla oluşturmaz, yalnızca form verilerini uygular ve ilgili kullanıcılara atar.

2. Nokta - Uygulanan şablon, imza alanı, ilk, kişisel imza, onay kutuları, radyo düğmeleri, metin alanları gibi İmzalamaHub aracılığıyla form alanlarının el ile eklendiği (dolayısıyla başlangıçta PDF'de bulunmadığı) oluşturulursa, bu tür bir şablon uygulandığında, bu form alanları belgede zaten mevcut olsa bile hedef belgede oluşturulur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Şablonun uygulanması gereken paketin Paket Kimliği.
Belge Kimliği	documentId	True	integer	Şablonun uygulanması gereken belge kimliği. Değer 0 olarak ayarlanırsa, şablon paketteki tüm belgelere uygulanacaksa.
template_name	template_name	True	string	Belgeye uygulanacak şablonun adı.
apply_to_all	apply_to_all	True	boolean	Doğru, şablon paketteki tüm belgelere uygulanacaksa.

Döndürülenler

Body

DocumentDetailsResponse

İş Akışına Grup Ekleme

İşlem Kimliği:

V4_Workflow_WorkflowAddGroup

İş uygulamaları, grupları bir iş akışına alıcı olarak eklemek için bu hizmet API'sini kullanabilir. SigningHub grubu, grubun herhangi bir üyesinin eylemi (örneğin, grubun tüm üyeleri adına imzalama) gerçekleştirebileceği anlamına gelir.

Grubun iş akışındaki son kullanıcı/grup olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan geçerli bir kullanıcıyı/grubu kaldırmak için daha fazla çalışma gerekebilir. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Grubun eklendiği paketin kimliği.
group_name	group_name		string	İş akışına eklenecek yeni grubun adı.
email_notification	email_notification	True	boolean	Değerini "true" olarak ayarlamak, iş akışına geldiğinde kullanıcıya bir e-posta bildirimi gönderir. Değerini "false" olarak ayarlamak, kullanıcıya e-posta bildirimini kendi dönüşünde göndermez. Değer sağlanmazsa varsayılan "true" değeri ayarlanır.
role	role	True	string	Alıcının iş akışındaki rolü. Olası değerler şunlardır: "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST". Ancak, XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
signing_order	signing_order		integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.

Döndürülenler

response

array of CollaboratorGroupResponse

İş Akışına Kullanıcı Ekleme

İşlem Kimliği:

V4_Workflow_WorkflowAddUser

İş uygulamaları, bir iş akışına alıcı eklemek için bu hizmet API'sini kullanabilir. Bu çağrı yalnızca iş akışına bir alıcı ekler. Başka bir ifadeyle, şu anda belgedeki hiçbir alan yeni alıcılara otomatik olarak atanmayacak veya bu yeni alan oluşturmayacaktır.

Alıcıların iş akışındaki son kişi olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan alıcıları kaldırmak için daha fazla çalışma gerekebilir.

Alanlar (giriş ve imza) belgeye eklenmeden önce iş akışında en az bir kullanıcı bulunmalıdır.

Girişin tek bir çağrıda bir veya daha fazla kullanıcıyı kabul eder.

Bu özel çağrıda kullanıcı bilinen bir gerçek kişidir. Ancak, aynı kurallar Gruplar ve Yer Tutucular için de geçerlidir. Bu iki durumda da alıcı, grubun herhangi bir üyesinin belgeyi imzaladığı bir Kullanıcı Grubu veya Yer Tutucu olur.İkinci durum, hedeflenen imzalayan kişinin kimliğini bilmediğinizde kullanılır.

Not İmzalamaHub iş akışı imzalama sırası "1" ile başlar. Bu nedenle, geçerli alıcıları olmayan bir kullanıcıyı iş akışına eklemek yeni bir imzalama siparişi sayısı başlatır. İş akışı türü "özel" ise "signing_order" parametresi zorunludur.

Önemli, bu API çağrısının kullanılması iş akışı türünü etkileyebilir. Sıralı bir iş akışında geçerli alıcılar varsa ve geçerli alıcıyla aynı imzalama sırasına sahip yeni bir alıcı eklenirse, iş akışının bu bölümü otomatik olarak sıralıdan paralele dönüşür. Bu nedenle, genel iş akışı artık tamamen sıralı değil özel türündedir. İki veya paralel alıcıyla aynı imzalama sırasına sahip bir alıcı eklemek iş akışını değiştirmez. İş akışının belirli bir noktasında yalnızca üç veya daha fazla alıcı vardır; tümü paralel sırada.

XML türü belge hazırlığı sırasında yalnızca desteklenen rol türlerinin "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olduğunu unutmayın

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Alıcıların eklendiği SigningHub paket kimliği.
user_email	user_email		string	İş akışına eklenecek kullanıcının e-posta adresi.
user_name	user_name	True	string	İş akışına eklenecek alıcının adı.
user_national_id	user_national_id		string	Alıcının kullanıcı ulusal kimliği
email_notification	email_notification	True	boolean	True olarak ayarlanırsa, SigningHub belge sahibine ve kullanıcı bildirim ayarlarına göre kullanıcıya e-posta yoluyla bildirim gönderir. false değeri, iş akışı boyunca kullanıcıya bildirim gönderilmeyeceği anlamına gelir.
role	role	True	string	Alıcının iş akışındaki rolü. Olası değerler şunlardır: "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST". Ancak, XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
signing_order	signing_order		integer	İş akışındaki alıcının sırası. İş akışı türü "ÖZEL" olduğunda bu imzalama sırası zorunludur.
delivery_method	delivery_method	True	string	alıcının iş akışındaki teslim yöntemi. Olası değerler "EMAIL", "SMS" veya "EMAIL_AND_SMS" şeklindedir. Varsayılan değer E-POSTA olacaktır
mobile_number	mobile_number		string	Cep Telefonu Numarası

Döndürülenler

response

array of CollaboratorResponse

İş Akışına Yer Tutucu Ekle

İşlem Kimliği:

V4_Workflow_WorkflowAddPlaceholder

İş uygulamaları, paketteki bir iş akışına yer tutucu eklemek için bu hizmet API'sini kullanabilir. Bir iş akışında hedeflenen alıcının kimliğini bilmediğinizde yer tutucu gereklidir.

Yer tutucunun iş akışındaki son kullanıcı olarak ekleneceğini unutmayın. Bu nedenle, iş akışında zaten mevcut olan geçerli bir kullanıcıyı/grubu kaldırmak için daha fazla çalışma gerekebilir.

Yer tutucu eklemek, devam etmenizi ve belgeye imza ve/veya giriş alanları eklemenize olanak tanır. Bu alanlar daha sonraki bir aşamada tek tek kullanıcılara atanabilir. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Yer tutucunun eklendiği paketin kimliği.
yer tutucu	placeholder		string	İş akışına eklenecek yeni yer tutucunun adı.
email_notification	email_notification	True	boolean	Değerini "true" olarak ayarlamak, iş akışına geldiğinde kullanıcıya bir e-posta bildirimi gönderir. Değerini "false" olarak ayarlamak, kullanıcıya e-posta bildirimini kendi dönüşünde göndermez.
role	role	True	string	Alıcının iş akışındaki rolü. Olası değerler şunlardır: "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST". Ancak, XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
signing_order	signing_order		integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.

Döndürülenler

response

array of CollaboratorPlaceholderResponse

İşlem Kanıtı Raporu Alma

İşlem Kimliği:

V4_WorkflowEvidenceReport_DownloadBytes

İş uygulamaları, bir belgenin iş akışı süreci kanıt raporunu indirmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

İşlemeyi Bitir

İşlem Kimliği:

V4_Package_Finish

İş uygulamaları, tüm imza alanlarını imzaladıktan sonra belge işlemeyi tamamlamak için bu hizmet API'sini kullanabilir. Bu yöntem öncelikli olarak iOS ve Android için yerel SigningHub mobil uygulamaları ve mobil web kullanım örnekleri tarafından kullanılır. İlgili portallarına sıkı tümleştirme kullanan genel iş uygulamalarının bu yöntemi çağırması gerekmez. Ancak, belgeyi İmzala API'sini kullanırken (ve bu nedenle kullanıcıya imzalaması istenen belgenin görsel bir gösterimi sunulmaz) ilgili iş akışının devam ettiğinden veya tamamlandığından emin olmak için bu API'yi çağırmak gerekir. Örneğin, "kör" Belge İmzala API çağrısı kullanılarak tüm imzalar uygulandıktan sonra, bu API çağrılana kadar belge sahibine "Tamamlandı" durumu olarak gösterilmez. Bu API çağrılana kadar belge sahibi "Devam Ediyor" durumunu görür.

Yerel SigningHub mobil uygulamalarında ve mobil web kullanım örneklerinde bu çağrı, her kullanıcının SigningHub ile ilgili eylemlerini tamamladığından emin olmak için gereklidir.Örneğin, bir imzacı SigningHub App'te bir belgeyi imzaladıktan sonra, iş akışının işlemeye devam ettiğinden ve bir sonraki imzalayana bildirildiğinden emin olmak için bu yöntem uygulama tarafından çağrılır, ve belge durumu yapılandırılan geri arama URL'si aracılığıyla kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Tamamlanacak paketin kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Kitaplıktan Belge Ekleme veya Güncelleştirme

İşlem Kimliği:

V4_Documents_UploadFromLibrary

İş uygulamaları, kullanıcının kitaplığından pakete belge eklemek için bu hizmet API'sini kullanabilir. PAKET KİmLİĞİ URL'de sağlanır; kopyalanacak kitaplık belgesini tanımlamak için belgenin kimliği de kaynak URL'sinde "document_id" olarak sağlanmalıdır.

Bu çağrıyı kullanarak belge ekleyebilmeniz için önce bir paketin zaten mevcut olması gerektiğini unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paketin Paket Kimliği.
Belge Kimliği	documentId	True	integer	Eklenmesi/güncelleştirilmiş olması gereken kitaplık belgesi kimliği
Eski Belge Kimliği	x-document-id		string	Güncellenmesi gereken geçerli paketin eski belgesinin kimliği

Döndürülenler

Body

UploadDocumentLibraryResponse

Kişi İçi Alan Ekle

İşlem Kimliği:

V4_InPerson_AddInPerson

İş uygulamaları bu hizmet API'sini bir paketteki belgeye kişi içi imza alanı eklemek için kullanabilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Bir bizzat toplantıyı barındırmak için bir SigningHub kullanıcısının iş akışının bir parçası olması gerekir. "INPERSON_HOST" veya "İMZALAYAN" Rolü ile eklenmelidir. Konak seçeneği için, belgede imza veya giriş alanı gerektirmezler ve kişisel imza alanı, SigningHub kayıtlı olmayan kullanıcı tarafından imzalanabilir.

Bunun, SigningHub kullanıcısının ve alıcısının aynı konumda olması beklenen özel bir iş akışı senaryosu olduğunu unutmayın. Bu imza türü, normal gevşek tümleştirme yöntemindeki e-posta bağlantısı üzerinden bir belgenin alıcılarla paylaşıldığı durumlarda kullanılmak üzere tasarlanmamıştır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
order	order	True	integer	Alanın eklendiği iş akışındaki kullanıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
field_name	field_name		string	Eklenecek alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
yer tutucu	placeholder	True	string	Inperson alanı için dize tanımlayıcısı, Customer, Jack, CEO vb. olabilir.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
göstermek	display		string	Eklenecek alanın görünürlüğü, olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur
level_of_assurance	level_of_assurance		array of string	Güncelleştirilecek Güvence Düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	Alan için kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
enabled	enabled	True	boolean	Alan için SMS/E-posta OTP kimlik doğrulaması etkinleştirildiyse true. Aksi durumda yanlış.
mobile_number	mobile_number		string	Alanın atandığı alıcının cep telefonu numarası.
enabled	enabled	True	boolean	Alan için TOTP kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.

Döndürülenler

Body

AddFieldResponse

Kişileri Al

İşlem Kimliği:

V4_Contacts_Get

İş uygulamaları, geçerli kullanıcının hem kişisel hem de kurumsal kişilerinden kişileri yeniden düzenlemek için bu hizmet API'sini kullanabilir.

"x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür. Ayrıca, kullanıcının belirli kişilerinde veya kullanıcının ait olduğu kuruluşta arama yapmak mümkündür.

Arama yanıtı bilgileri, kullanıcı e-posta adresini ve ilgili kullanıcı adını içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sayfadaki Kayıt Sayısı	recordPerPage	True	integer	Bir sayfada alınacak toplam kayıt sayısı.
Sayfa Numarası	pageNo	True	integer	Alınacak sayfa numarası.
Sıralama Ölçütü	sort-by		string	Sonucu yukarıda belirtilen olası değerlere göre sıralayın.
Artan Sıralama	asc		boolean	Sonuç kümesini artan veya azalan düzende sıralar.
Metin Ara	x-search-text		string	Gerekirse metin arayın. Bu isteğe bağlıdır ve bu seçenek olmadan listenin tamamı döndürülür. Ayrıca, arama metni parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Yalnızca Kurumsal Kişiler	x-enterprise		string	"True" olarak ayarlandığında yalnızca kurumsal kişiler listesi döndürülür. "False" durumunda yalnızca kullanıcının kişi listesi döndürülür. Üst bilgiyi ayarlamazsanız hem kuruluş hem de kullanıcının kişi listeleri döndürülür.
Toplam Kayıt Sayısı	x-total-records		string	Sağlanan arama ölçütleriyle bulunan toplam kayıt sayısı.

Döndürülenler

response

array of ContactResponse

Kişisel Alanı Güncelleştir

İşlem Kimliği:

V4_InPerson_UpdateInPerson

İş uygulamaları, paketteki bir belgenin kişisel imza alanını güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	yeniden adlandırma amaçlanıyorsa, alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
yer tutucu	placeholder		string	Kişisel alan için dize tanımlayıcısı, Müşteri, Jack, CEO vb. olabilir.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
göstermek	display		string	Güncelleştirilecek alanın görünürlüğü, olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur
level_of_assurance	level_of_assurance		array of string	Güncelleştirilecek Güvence Düzeyi. Olası Değerler şunlardır: "ELECTRONIC_SEAL", "ADVANCED_ELECTRONIC_SEAL", "QUALIFIED_ELECTRONIC_SEAL", "ELECTRONIC_SIGNATURE"
enabled	enabled	True	boolean	Alan için kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
enabled	enabled	True	boolean	Alan için SMS/E-posta OTP kimlik doğrulaması etkinleştirildiyse true. Aksi durumda yanlış.
mobile_number	mobile_number		string	Alanın atandığı alıcının cep telefonu numarası.
enabled	enabled	True	boolean	Alan için TOTP kimlik doğrulaması etkinleştirildiyse True. Aksi durumda yanlış.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Kurumsal Paketin İş Akışı Kullanıcı Kimlik Doğrulama (Belge Açma) Güncelleştirme

İşlem Kimliği:

V4_EnterpriseDocuments_UpdateEnterpriseWorkflowAccess

İş uygulamaları, alıcıların paket kimlik doğrulamalarını ve erişim süresini güncelleştirmek için bu hizmet API'sini kullanabilir. Bu API, kimlik doğrulama isteğinde "kapsam" değişkeni kullanıldıysa kuruluş yöneticisi veya kuruluş kullanıcısı tarafından da kullanılabilir

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı erişim güvenliği ve kimlik doğrulamasının güncelleştirildiği paket kimliği.
Alıcı Siparişi	order	True	integer	Erişim güvenliği ve kimlik doğrulamasının güncelleştirildiği iş akışındaki alıcının sırası.
apply_to_all	apply_to_all	True	boolean	Erişim güvenliği veya kimlik doğrulamaları iş akışındaki tüm alıcılara uygulanacaksa True.
enabled	enabled	True	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
enabled	enabled	True	boolean	Paket için parola kimlik doğrulaması etkinleştirildiyse true.
user_password	user_password		string	Parola alanı etkinse parola dizesi. Parola zaten ayarlanmışsa ve sahip parolayı değiştirmek istemezse, alanı yanıttan kaldırın veya null gönderin.
enabled	enabled	True	boolean	Paket için SMS OTP kimlik doğrulaması etkinleştirildiyse true.
mobile_number	mobile_number		string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.
enabled	enabled	True	boolean	Enabled
enabled	enabled	True	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
mobile_number	mobile_number		string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.
enabled	enabled	True	boolean	Enabled
enabled	enabled	True	boolean	Paket için erişim süresi güvenliği etkinleştirildiyse true.
enabled	enabled	True	boolean	Erişim güvenliği tarih ve saate göre bir süre için etkinleştirildiyse True.
start_date_time	start_date_time		date-time	Paketin alıcı tarafından erişilebileceği tarih ve saat.
end_date_time	end_date_time		date-time	Paketin alıcı tarafından erişilmediği tarih ve saat.
enabled	enabled	True	boolean	Erişim güvenliği gün sayısına göre bir süre için etkinleştirildiyse Doğru.
total_days	total_days	True	integer	Paketi aldıktan sonra paketin alıcı tarafından erişilebileceği toplam gün sayısı.

Döndürülenler

response

object

Kurumsal Paketin İş Akışı Kullanıcı Kimlik Doğrulaması (Belge Açma) Alma

İşlem Kimliği:

V4_EnterpriseDocuments_GetEnterpriseWorkflowAccess

İş uygulamaları, paket için erişim güvenlik ayarlarını etkinleştirmek için bu hizmet API'sini kullanabilir. Güvenliğin yapılandırıldığı alıcılar URL'deki sırayla tanımlanır. Paket kimliği, istek URL'sinde de tanımlanır. Erişim güvenliği etkinleştirilmişse alıcılar bu sürenin kapsamı dışında belge paketine erişemez. Belge sahibi, bir alıcı için paketin kimlik doğrulama tabanlı güvenliğini de yapılandırabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	İş akışı erişim güvenliği ve kimlik doğrulamasının güncelleştirildiği paket kimliği.
Alıcı Siparişi	order	True	integer	Erişim güvenliği ve kimlik doğrulamasının güncelleştirildiği iş akışındaki alıcının sırası.

Döndürülenler

Body

EnterpriseAccessResponse

Kurumsal Şablonları Alma

İşlem Kimliği:

V4_Template_GetEnterpriseTemplates

İş uygulamaları, geçerli kullanıcının kurumsal şablonlarının listesini almak için bu hizmet API'sini kullanabilir. Bu, kimlik doğrulama isteğinde "kapsam" değişkeni kullanıldıysa kuruluş yöneticisi veya kurumsal kullanıcı anlamına gelir.

"x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sayfa başına kayıt sayısı	recordPerPage	True	integer	Bir sayfada alınacak toplam kayıt sayısı.
Alınacak sayfa numarası	pageNo	True	integer	Alınacak sayfa numarası.
Sütuna göre verileri sırala	sort-by		string	Sonucu yukarıda belirtilen olası değerlere göre sıralayın.
Sonuç kümesini sıralama	asc		boolean	Sonuç kümesini artan veya azalan düzende sıralar.
Şablon kimliklerine göre filtreleme	id		array	Şablon kimliklerine göre arama yapın.
Arama metni	x-search-text		string	Gerekirse metin arayın. Bu isteğe bağlıdır ve bu seçenek olmadan listenin tamamı döndürülür. Ayrıca, arama metni parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Toplam kayıt sayısı	x-total-records		string	Sağlanan arama ölçütleriyle bulunan toplam kayıt sayısı.

Döndürülenler

response

array of EnterpriseTemplateResponse

Paket Ayrıntılarını Alma

İşlem Kimliği:

V4_Package_GetPackageDetails

İş uygulamaları bir paketin ayrıntılarını almak için bu hizmet API'sini kullanabilir. Bu API, iş uygulaması tarafından "Kapsam Kimlik Doğrulaması" aracılığıyla kurumsal kullanıcı adına eylem gerçekleştirmek için de kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belge paketinin paket kimliği.

Döndürülenler

Body

GetPackageDetailsResponse

Paket Ekle

İşlem Kimliği:

V4_Package_AddPackage

Bu hizmet API'si, bir veya daha fazla belgeyi barındıracak bir belge paketi eklemek/oluşturmak için kullanılır. Bu paket daha sonra yeni bir iş akışı başlatmak üzere belge ve alıcı eklemek için kullanılabilir.

Daha önce belirtildiği gibi, belgelerle çalışmak istiyorsanız bu çağrı zorunludur. İmzalamaHub'a belge yükleyebilmeniz veya ekleyebilmeniz için önce bir paket bulunmalıdır..

Tek bir belge bile paketin bir parçasıdır: tek bir belge içeren paket.

Not: Bir paket oluşturulduktan sonra gerekirse yeniden adlandırılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
package_name	package_name		string	Paketin adı. package_name sağlanmazsa varsayılan paket adı her zaman "Adsız" olur.
workflow_mode	workflow_mode	True	string	İş akışının modu, uygulamada desteklenen üç tür iş akışı modu vardır. Olası değerler şunlardır: "ONLY_ME", "ME_AND_OTHERS" ve "ONLY_OTHERS"
folder_name	folder_name		string	Klasörün adı. Paketi kullanıcının herhangi bir klasörüne yüklemek için kullanılır; bu bir özel klasör veya paylaşılan klasördür.

Döndürülenler

Body

AddPackageResponse

Paketi İndir

İşlem Kimliği:

V4_Package_DownloadPackageBytes

İş uygulamaları, belge paketini ikili biçimde indirmek için bu hizmet API'sini kullanabilir.

Paket kimliği kaynak URL'sinde sağlanır.

Paket yalnızca bir belge içeriyorsa, indirme ikili PDF belgesidir.

Alternatif olarak, pakette birden fazla belge varsa, indirme tüm belgelerin ikili zip dosyasıdır.

x-password ve x-otp üst bilgileri isteğe bağlıdır. Belge sahibi bunları iş akışı oluşturma aşamasında ayarladıysa gereklidir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId_bulkAction	True	integer	İndirilecek paket kimliği.
Belge Kimlikleri	document-ids		array	Belge Kimlikleri parametresi isteğe bağlıdır. x-combine-files true olarak ayarlanırsa, belgeler paketin belirtilen belgelerine göre birleştirilir.
Belge Erişim Parolası	x-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
Belge One-Time Parolası	x-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Dosyaları Birleştir	x-combine-files		string	Varsayılan değer false,Belge paketinin tamamını tek bir PDF dosyasında birleştirmek için "true" olarak ayarlayın.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

Paketi Sil

İşlem Kimliği:

V4_Package_DeletePackage

İş uygulamaları, kullanıcı gelen kutusundan belge silmek için bu hizmet API'sini kullanabilir. Paket kimliği kaynak URL'sinde "{package_id}" olarak sağlanır. Belge durumu BEKLENİYORsa, silme işleminin sonucu olarak otomatik olarak reddedilir. Belgenin durumu PAYLAŞILDI ise, belge otomatik olarak geri çağrılır ve belge silinmeden önce iş akışı durdurulur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId_bulkAction	True	integer	Belgeyi içeren paketin paket kimliği.

Döndürülenler

response

object

Paketi Yeniden Adlandır

İşlem Kimliği:

V4_Package_RenamePackage

Bu hizmet API'si belge paketini yeniden adlandırmak için kullanılır.

Belge paketi, çağrının URL'sindeki benzersiz tanımlayıcısıyla tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId_bulkAction	True	integer	Adını değiştirmek için paket kimliği.
package_name	package_name	True	string	Belge paketinin yeni adı.

Döndürülenler

response

object

Paketi Özel veya Paylaşılan Alan klasörüne taşıma

İşlem Kimliği:

V4_Folder_MovePackage

İş uygulamaları, belge paketini paylaşılan bir alana veya kullanıcının özel klasörüne taşımak için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Klasöre taşınması gereken paket kimliği
folder_name	folder_name	True	string	Paketin taşınması gereken hedef klasör adı

Döndürülenler

response

object

Paketleri Al

İşlem Kimliği:

V4_Package_GetAllPackages

İş uygulamaları, farklı durumlara göre filtrelenen belgelerin listesini almak için bu hizmet API'sini kullanabilir. Kullanıcılar, sayfa başına bir dizi kayıt sağlayarak kayıtları sayfalara bölebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Belge Durumu	document_status	True	string	Belge durumuna göre filtrele olası değerler ALL, DRAFT, PENDING, SIGNED, DECLINED, INPROGRESS, EDITED, REVIEWED, COMPLETED, EXPIRING_IN_SEVEN_DAYS değerleridir.
Sayfa Numarası	pageNo	True	integer	Sayfa başına kayıtların bölünmesine göre sayfa numarası.
Sayfadaki Kayıt Sayısı	recordPerPage	True	integer	Bir istekte alınması gereken kayıt sayısı.
Paket Adı	package-name		string	Paket Adı
Paket Kimliği	package-id		integer	Paket Kimliği
Kaynak	recipient-from		string	Kaynak
İçin	recipient-to		string	İçin
Belge Kimliği	document-id		integer	Belge Kimliği
Süre Sonu (Gün)	expiry		integer	Süre Sonu (Gün)
Değiştirme Tarihinden Itibaren	modified-from		date-time	Değiştirme Tarihinden Itibaren
Değiştirilme Tarihi	modified-to		date-time	Değiştirilme Tarihi
Kimden Boyutu (KB)	size-from		integer	Kimden Boyutu (KB)
Boyuta (KB)	size-to		integer	Boyuta (KB)
Sertifikalı Belgeler	certified-documents		boolean	Yalnızca sertifikalı imzalı belgeler
Form Alanları	form-fields		boolean	Yalnızca form alanları olan belgeler
Ekler	attachments		boolean	Yalnızca ekleri olan belgeler
Belge Türü	document-type		string	XML, PDF, DOCX gibi Belge Türü
Sıralama Ölçütü	sort-by		string	Sonuç kayıtlarını tercihinize göre sıralayın
Artan Düzen	asc		boolean	Sonuç kayıtlarını artan veya azalan düzende sıraladı
Belge Durumları	document-statuses		array	Belge Türü
Sahip olduğu	owned-by		string	Sahip olunan filtre olası değerleri ME_OTHERS, ME, OTHERS'tır.
Akıllı Form Adı	smart-form		string	Akıllı form adı
Klasör Adı	x-folder		string	Belgelerin getirileceği klasör adı. Olası değerler GELEN KUTUSU ve ARŞİV'tir. Ayrıca, x klasörü parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Metin Ara	x-search-text		string	Belgelerin daha fazla filtrelenmesi için üst bilgilerde gönderilen metni arayın. Paket kimliği, ad ve belge sahibi aranabilir. Ayrıca, arama metni parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Toplam Kayıt Sayısı	x-total-records		string	Sağlanan arama ölçütleriyle bulunan toplam kayıt sayısı.
Source	x-source		string	Bu, belgenin karşıya yüklendiği belgenin kaynağının kimliğidir, örneğin "Uygulamam".
Alıcı Ayrıntıları	x-recipient-details		string	"True" geçirildiyse, reddetme bilgileriyle birlikte Belge Erişim Süresi ile ilgili alıcı ayrıntıları sağlanacaktır

Döndürülenler

response

array of GetPackagesResponse

Paylaşılan Alan Al

İşlem Kimliği:

V4_WorkSpace_GetSharedSpace

İş uygulamaları, belirli bir paylaşılan alanı almak için bu hizmet API'sini kullanabilir. Bu API paylaşılan alan, sahibi ve ortak çalışan hakkındaki bilgileri döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paylaşılan Alan Kimliği	id	True	integer	Almak istediğiniz paylaşılan alanın kimliği

Döndürülenler

Body

WorkSpaceResponse

Paylaşılan Alanı Güncelleştir

İşlem Kimliği:

V4_WorkSpace_UpdateSharedSpace

İş uygulamaları, paylaşılan alanı güncelleştirmek için bu hizmet API'sini kullanabilir. Paylaşılan alanları güncelleştirmenin kullanılabilirliği, atanan kurumsal kullanıcı rolüne tabidir. Bu sağlamayı sağlamak için Enterprise Admin, Roller>Belge Ayarları'nda 'Paylaşılan Alanı Yönet' seçeneğini etkinleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paylaşılan Alan Kimliği	id	True	integer	Güncelleştirmek istediğiniz paylaşılan alanın kimliği
name	name		string	Paylaşılan alanın adı
name	name	True	string	çalışma alanı üyesinin adı
email	email	True	string	çalışma alanı üyesinin E-posta Adresi

Döndürülenler

response

object

Paylaşılan Alanı Sil

İşlem Kimliği:

V4_WorkSpace_DeleteSharedSpace

İş uygulamaları paylaşılan alanı silmek için bu hizmet API'sini kullanabilir. Paylaşılan alanları silmenin kullanılabilirliği, atanan kurumsal kullanıcı rolüne tabidir. Bu sağlamayı sağlamak için Enterprise Admin, Roller>Belge Ayarları'nda 'Paylaşılan Alanı Yönet' seçeneğini etkinleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paylaşılan Alan Kimliği	id	True	integer	Silmek istediğiniz paylaşılan alanın kimliği

Döndürülenler

response

object

QR Kodu Ekle

İşlem Kimliği:

V4_QR_AddQRCode

İş uygulamaları, paketteki bir belgeye QR Kodu eklemek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
field_name	field_name		string	Eklenecek sağlanan alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
veriler	data		string	QR kodunda kodlanacak düz metin verileri. Varsayılan değer, ilgili belgeye erişmek için oluşturulan URL'dir. Örneğin{ base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Veri yedekliliği miktarını belirleyen QR kodu için Hata Düzeltme Düzeyi. Seçenekler şunlardır: L (Düşük), M (Orta), Q (Dörttebirlik) ve H (Yüksek). Daha yüksek düzeyler daha fazla hata direnci sunar. Varsayılan değer "Q"
encoding	encoding	True	string	QR kodu içeriği için karakter kodlama modunu belirtir. Desteklenen seçenekler şunlardır: Varsayılan, Iso8859_1, Iso8859_2 ve Utf8. Varsayılan değer "Varsayılan"
pixels_per_module	pixels_per_module	True	integer	QR kodundaki modül başına piksel sayısını belirtir. Daha yüksek bir sayı, daha büyük ve daha ayrıntılı bir QR koduyla sonuçlanır. Varsayılan değer "20" Olası Değerler: 20 | 30 | 40 | 50
add_margins	add_margins	True	boolean	QR kodunun çevresinde sessiz bölgelerin (kenar boşlukları) çizilip çizilmeyeceğini gösterir. Sessiz bölgeler, tarayıcıların QR kodunu daha doğru algılamasına ve kodunu çözmesine yardımcı olur. Varsayılan değer "true"
Nokta	dots		string	QR kodundaki noktalar için kullanılan koyu rengi temsil eder. Varsayılan değer "siyah"tır. Örneğin, "#000000"
arka plan	background		string	QR kodunun arka planı için kullanılan açık rengi temsil eder. Varsayılan değer "beyaz"dır. örneğin "#ffffff"
base64	base64		string	QR kodunun ortasına yerleştirmek için isteğe bağlı bir simge (base64).
hide_background_dots	hide_background_dots	True	boolean	Simge sağlanmışsa, simgenin arkasındaki arka plan rengi. Renk sağlanmazsa saydam arka plan uygulanır.
size	size	True	integer	Simgenin boyutu, bir simge sağlanmışsa QR kodunun boyutunun yüzdesi olarak. Varsayılan değer "15"tir. Olası Değerler: 10 | 15 | 20 | 25 | 30 | 35 | 40

Döndürülenler

Body

AddQrCodeResponse

QR Kodunu Güncelleştirme

İşlem Kimliği:

V4_QR_UpdateQRCode

İş uygulamaları, paketteki bir belgenin QR Kodunu güncelleştirmek için bu hizmet API'sini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	Yeniden adlandırma amaçlanıyorsa alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Güncelleştirilecek alan için sayfa numarası
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
veriler	data		string	QR kodunda kodlanacak düz metin verileri. Varsayılan değer, ilgili belgeye erişmek için oluşturulan URL'dir. Örneğin{ base_url}/document/{document_unique_id}
error_correction_level	error_correction_level	True	string	Veri yedekliliği miktarını belirleyen QR kodu için Hata Düzeltme Düzeyi. Seçenekler şunlardır: L (Düşük), M (Orta), Q (Dörttebirlik) ve H (Yüksek). Daha yüksek düzeyler daha fazla hata direnci sunar. Varsayılan değer "Q"
encoding	encoding	True	string	QR kodu içeriği için karakter kodlama modunu belirtir. Desteklenen seçenekler şunlardır: Varsayılan, Iso8859_1, Iso8859_2 ve Utf8. Varsayılan değer "Varsayılan"
pixels_per_module	pixels_per_module	True	integer	QR kodundaki modül başına piksel sayısını belirtir. Daha yüksek bir sayı, daha büyük ve daha ayrıntılı bir QR koduyla sonuçlanır. Varsayılan değer "20" Olası Değerler: 20 | 30 | 40 | 50
add_margins	add_margins	True	boolean	QR kodunun çevresinde sessiz bölgelerin (kenar boşlukları) çizilip çizilmeyeceğini gösterir. Sessiz bölgeler, tarayıcıların QR kodunu daha doğru algılamasına ve kodunu çözmesine yardımcı olur. Varsayılan değer "true"
Nokta	dots		string	QR kodundaki noktalar için kullanılan koyu rengi temsil eder. Varsayılan değer "siyah"tır. Örneğin, "#000000"
arka plan	background		string	QR kodunun arka planı için kullanılan açık rengi temsil eder. Varsayılan değer "beyaz"dır. örneğin "#ffffff"
base64	base64		string	QR kodunun ortasına yerleştirmek için isteğe bağlı bir simge (base64).
hide_background_dots	hide_background_dots	True	boolean	Simge sağlanmışsa, simgenin arkasındaki arka plan rengi. Renk sağlanmazsa saydam arka plan uygulanır.
size	size	True	integer	Simgenin boyutu, bir simge sağlanmışsa QR kodunun boyutunun yüzdesi olarak. Varsayılan değer "15"tir. Olası Değerler: 10 | 15 | 20 | 25 | 30 | 35 | 40

Döndürülenler

Body

UpdateQrCodeResponse

RadioBox Alanı Ekle

İşlem Kimliği:

V4_Radio_AddRadioBox

İş uygulamaları, paketteki belgeye onay kutusu eklemek için bu hizmet API'sini kullanabilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Genişlik ve yükseklik parametreleri sağlanmazsa, varsayılan boyut olarak 10x10 atanır. Genişlik veya yükseklik (veya her ikisi) sağlanmışsa, sistem sağlanan bu değerleri birbiriyle karşılaştırır. Genişlik ve yükseklik arasındaki daha büyük değer her iki boyuta da atanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
order	order	True	integer	Alanın eklendiği iş akışındaki kullanıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
field_name	field_name		string	Eklenecek sağlanan alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
value	value		string	Alanın değeri. Olası değerler "true" veya "false" olabilir
validation_rule	validation_rule	True	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
radio_group_name	radio_group_name	True	string
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.

Döndürülenler

Body

AddFieldResponse

RadioBox Alanını Güncelleştir

İşlem Kimliği:

V4_Radio_UpdateRadioBox

İş uygulamaları, paketteki bir belgenin radyo düğmesini güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Genişliği ve yüksekliği güncelleştirilemez. Eklendiklerinde olduğu gibi kalırlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	Yeniden adlandırma amaçlanıyorsa alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
value	value		string	Alanın değeri. Olası değerler "true" veya "false" olabilir
validation_rule	validation_rule	True	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
radio_group_name	radio_group_name	True	string	Alanın ait olduğu grup adı.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.

Döndürülenler

response

object

Tam İş Akışı Ortada (İş Akışını Sonlandır)

İşlem Kimliği:

V4_Workflow_MarkWorkflowCompleted

İş uygulamaları, iş akışının ortasında bile iş akışının tamamlandığını işaretleyebilir. İş akışının durumunu tamamlandı olarak değiştirmek için bu hizmet API'sini kullanın. Belgeyi henüz imzalamamış alıcılar varsa. İmzaları artık gerekli olmayacak ve belgeyi gelen kutularında daha fazla göremezler. Taşıyıcı belirteci belge sahibine ait olmalıdır veya kuruluş yöneticisi bu eylemi gerçekleştirmek üzere belge sahibi adına erişim belirtecini almak için kapsam değişkenini kullanabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Alıcının silindiği paket kimliği.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.

Döndürülenler

response

object

TextBox Alanı Ekle

İşlem Kimliği:

V4_TextBox_AddTextBox

İş uygulamaları, paketteki bir belgeye metin girişi alanı eklemek için bu hizmet API'sini kullanabilir.

Alanların (giriş ve imza) belgeye bu şekilde eklenebilmesi için önce bir iş akışında en az bir kullanıcı bulunmalıdır. Sipariş numarası iş akışındaki alıcıya karşılık gelir. Bu nedenle, bu sayı iş akışındaki toplam kullanıcı sayısına eşit veya daha az olmalıdır. Aşağıdaki örnek, bu yeni imza alanını iş akışındaki ilk kişiye atar.

Daha fazla bilgi için bkz. İş Akışına Kullanıcı Ekleme . Şablon uygulanmış bir belgeniz varsa veya API'leri kullanarak bir belge uyguladıysanız, iş akışı zaten kullanıcıları içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
order	order	True	integer	Alanın eklendiği iş akışındaki kullanıcının sırası.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
türü	type	True	string	Alanın türü, olası değerler "METNEÇEVİr", "AD", "E-POSTA", "ŞİrKET", "JOBTITLE", "DATE" şeklindedir. METNEÇEVİr dışındaki tüm metin alanları, alıcının öznitelikleri/verileriyle bekleme modunda otomatik olarak doldurulur.
value	value		string	Alanın değeri. tür = TARİh için değerin ISO 8601 biçimine uyması beklenir. YYYY-MM-DD hh:mm:ss +00 biçiminden sonra. Değerler tarih alanları için olduğundan istemci uygulamaları YYYY-MM-DD gönderebilir ve hh:mm:ss +00 değerini yoksayabilir. Değer düzgün biçimde değilse bir hata döndürülür.
yer tutucu	placeholder		string	Metin alanı için yer tutucu metin. Ad, e-posta, şirket, iş unvanı ve tarih için yer tutucu değeri "AD", "E-POSTA", "ŞİrKET", "JOBTITLE", "DATE" olabilir. Geliştiriciler varsayılan değerlerin üzerine yazmak için kendi yer tutucularını gönderebilir. "METNEÇEVİr" için geliştiriciler kendi yer tutucu metinlerini sağlayabilir. Bu yer tutucular, belgeyi görüntüleyicide görüntülerken metin alanlarında görünür.
max_length	max_length	True	integer	Alanda izin verilen değerin uzunluk üst sınırı. 1 - 9999 arasında olmalıdır
format	format		string	Alanın metin biçimi. Yalnızca tarih türü alanı için kullanılır. Olası değerler şunlardır: m/d m/d/yy m/d/yyy aa/gg/yy aa/gg/yyyy aa/yy aa/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy gg/aa/yy ddmmmyyyy
field_name	field_name		string	Eklenecek alanın adı. Sağlanmadıysa, sistem alana benzersiz bir otomatik olarak oluşturulan ad atar.
field_type	field_type	True	string	Değer türünü kabul etme açısından alan türü, olası değerler "SAYI" veya "METNEÇEVİr" şeklindedir.
validation_rule	validation_rule	True	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
required	required	True	boolean
türü	type		string	Şu anda her zaman metin alanı için EQUALS olarak ayarlanmış doğrulama kuralının türünü belirtir.
value	value		string	Doğrulama için kullanılan değeri temsil eder.
name	name		string	Metin alanı için seçilen yazı tipinin adı. Olası değerler "COURIER", "HELVETICA" şeklindedir.
size	size		string	Metin alanı için seçilen yazı tipinin boyutu. Olası değerler: 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Özgün PDF belgesindeki yazı tipinin boyutu.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
çok satırlı	multiline	True	boolean	True olarak ayarlanırsa metin alanı alanı oluşturulur

Döndürülenler

Body

AddFieldResponse

TextBox Alanını Güncelleştir

İşlem Kimliği:

V4_TextBox_UpdateTextBox

İş uygulamaları, paketteki belgenin metin kutusunu güncelleştirmek için bu hizmet API'sini kullanabilir.

Tüm giriş parametrelerinin değiştirilebileceğini unutmayın. Geçerli ayarı korumak istediğiniz yerde, aramada değiştirmeden gönderin. Bu nedenle, giriş alanını eklerken kullandığınız parametreleri veya Belge Alanlarını Al tarafından döndürülen bilgileri kullanabilirsiniz. İkincisi, bir şablon uygulandığında veya belge GUI arabirimi kullanılarak oluşturulduğunda kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Belgenin eklendiği paket kimliği.
Belge Kimliği	documentId	True	integer	Eylemin gerçekleştirilecek belge kimliği.
field_name	field_name	True	string	Güncelleştirilecek alanın geçerli adı.
renamed_as	renamed_as		string	Yeniden adlandırma amaçlanıyorsa alanın güncelleştirilmiş adı.
page_no	page_no	True	integer	Alanın oluşturulacağı sayfa numarası.
value	value		string	Alanın değeri. tür = TARİh için değerin ISO 8601 biçimine uyması beklenir. YYYY-MM-DD hh:mm:ss +00 biçiminden sonra. Değerler tarih alanları için olduğundan istemci uygulamaları YYYY-MM-DD gönderebilir ve hh:mm:ss +00 değerini yoksayabilir. Değer düzgün biçimde değilse bir hata döndürülür.
max_length	max_length	True	integer	Alanda izin verilen değerin uzunluk üst sınırı. 1 - 9999 arasında olmalıdır
field_type	field_type	True	string	Değer türünü kabul etme açısından alan türü, olası değerler "SAYI" veya "METNEÇEVİr" şeklindedir.
validation_rule	validation_rule	True	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
name	name		string	Metin alanı için seçilen yazı tipinin adı. Olası değerler "COURIER", "HELVETICA" şeklindedir.
size	size		string	Metin alanı için seçilen yazı tipinin boyutu. Olası değerler: 8, 10, 12, 14, 16, 18, 20
embedded_size	embedded_size		string	Özgün PDF belgesindeki yazı tipinin boyutu.
x	x	True	double	Alanın piksel olarak sol konumu.
y	y	True	double	Alanın piksel olarak en üst konumu.
width	width	True	double	Alanın piksel cinsinden genişliği.
height	height	True	double	Alanın piksel cinsinden yüksekliği.
yer tutucu	placeholder		string	Geliştiriciler kendi yer tutucu metinlerini sağlayabilir. Bu yer tutucular, belgeyi görüntüleyicide görüntülerken metin alanlarında görünür.
format	format		string	Alanın metin biçimi. Yalnızca tarih türü alanı için kullanılır. Olası değerler şunlardır: m/d m/d/yy m/d/yyy aa/gg/yy aa/gg/yyyy aa/yy aa/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy gg/aa/yy ddmmmyyyy
required	required	True	boolean
türü	type		string	Şu anda her zaman metin alanı için EQUALS olarak ayarlanmış doğrulama kuralının türünü belirtir.
value	value		string	Doğrulama için kullanılan değeri temsil eder.

Döndürülenler

response

object

Toplu İmza Paketleri

İşlem Kimliği:

V4_Signing_BulkSignDocuments

İş uygulamaları, belgeleri son kullanıcıya görüntülemeden birden çok belgeyi (elektronik ve dijital) imzalamak/paylaşmak/imzalamak ve paylaşmak için bu API'yi kullanabilir. Bu API,iş uygulamasından belge paketleri ve imzaların ayrıntıları, bizzat ve baş harfler alanları hakkında bilgi gerektirir. Toplu imzalama işleminin başarıyla tamamlanmasının ardından API, belge paketlerinin durumlarını ve işlem kimliklerini döndürür.

Belgeyi İmzala API'sinin aksine, bu API yalnızca belge paketini imzalamakla kalmaz, aynı zamanda alıcının İmzalayan, Düzenleyici veya Gözden Geçiren olup olmadığına bağlı olarak onaylanıp gözden geçirilmiş olarak işaretler. Durumu TAMAMLANDı olarak döndüren tüm belge paketleri bu API tarafından imzalanmış, onaylanmıştır veya gözden geçirilmiştir.

Toplu İmzalama, tüm imzalama zamanı kimlik doğrulama yöntemleriyle çalışır.

sign bulk_action olarak geçirilirse ve paket Taslak durumundaysa, İmzala ve Paylaş otomatik olarak gerçekleştirilir.

Belgeleri Önceden İmzala API'sini kullandıktan sonra bu API'yi çağırmanız gerekir.

İmzalamadan önce belgenin herhangi birinde değişiklik yapmanız gerekirse, Toplu İmza Öncesi Belge API'sini çağırmadan önce Form Alanlarını Doldur API'sinin çağrılması gerekir. Bu API'nin başarıyla tamamlanması için belgedeki zorunlu giriş alanlarının tamamlanması gerektiğini unutmayın; ancak otomatik olarak doldurulan alanlar (Ad, E-posta, Tarih, İş Unvanı vb.) otomatik olarak doldurulur.

İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir.

Belge imzalandıktan sonra doğrulama yanıtı Toplu İmzalama Durumu API'sinden görülebilir.

Kimlik Doğrulaması için Birinci veya İkinci Faktör OTP Kullanımı

Sunucu tarafı imzalama işlemi için OTP kimlik doğrulamasının açık olması durumunda, istemci uygulamalarının OTP API çağrısı aracılığıyla Toplu İmza kimlik doğrulamasını kullanarak mobil numara için bir OTP oluşturması gerekir. İlgili iş uygulamaları OTP'yi kullanımdan almalı ve API çağrısı yaparken göndermelidir. Bu, istekteki "x-otp" üst bilgisi kullanılarak yapılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlikler	ids		array of integer	Toplu imzalama için seçilen belge paketi kimliklerinin dizisi.
hand_signature_initials_image	hand_signature_initials_image		string	Baş harflerin doldurulması için kullanılan Base64 görüntüsü
hand_signature_initials_method	hand_signature_initials_method		integer	0 = ÇIZ 1 = METNEÇEVİr 2 = KARŞıYA YÜKLE 3 = SIGNATURE_PAD 4 = YOK
hand_signature_image	hand_signature_image		string	Görünür imza görünümünün Base64 kodlanmış dize görüntüsü
hand_signature_method	hand_signature_method		integer	0 = ÇIZ 1 = METNEÇEVİr 2 = KARŞıYA YÜKLE 3 = SIGNATURE_PAD 4 = YOK
signing_reason	signing_reason		string	Alıcı tarafından sağlanan imzalama nedeni.
signing_location	signing_location		string	Alıcı tarafından sağlanan imzalayanın yerel ayarı
contact_information	contact_information		string	Alıcı tarafından sağlanan imzalayan kişinin iletişim bilgileri
appearance_design	appearance_design		string	İmzalama için kullanıcı tarafından sağlanan imza görünümünün adı. Hiçbir görünüm adı sağlanmazsa varsayılan seçili görünüm kullanılır. Olası değerler şunlardır: "COMPANY_LOGO", "DETAILED_SIGNATURE", "HAND_SIGNATURE"
signing_server	signing_server		string	Belgenin imzalanması gereken imzalama sunucusunun adı
signing_capacity	signing_capacity		string	Belgenin imzalanması gereken sertifika profilinin/imzalama kapasitesinin adı
mechanism	mechanism		string	Kimlik doğrulama mekanizması. Mekanizma için olası değerler şunlardır: AUTHENTICATION_PASSWORD, AUTHENTICATION_ACTIVE_DIRECTORY, AUTHENTICATION_AZURE_ACTIVE_DIRECTORY, AUTHENTICATION_OFFICE_365, AUTHENTICATION_OAUTH2, AUTHENTICATION_OIDC
password	password		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_PASSWORD' kullanılırken gereklidir
token	token		string	Üçüncü taraf sunucudan alınacak isteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_AZURE_ACTIVE_DIRECTORY', 'AUTHENTICATION_OFFICE_365', 'AUTHENTICATION_OAUTH2' 'AUTHENTICATION_OIDC' 'AUTHENTICATION_GOOGLE' 'AUTHENTICATION_LINKED_IN' 'AUTHENTICATION_SALES_FORCE' kullanılırken gereklidir
user_identifier	user_identifier		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_ACTIVE_DIRECTORY' veya 'AUTHENTICATION_SAML' kullanılırken gereklidir
kimlik	id		string	İsteğe bağlı bir parametredir, ancak yalnızca 'mekanizma' altında parametre değeri olarak 'AUTHENTICATION_SALES_FORCE' veya 'AUTHENTICATION_IDFY' kullanılırken gereklidir. 'AUTHENTICATION_IDFY' için requestId değeridir
code_verifier	code_verifier		string	İstemci için PKCE etkinleştirildiyse Kod Doğrulayıcı.
Nonce	nonce		string	İstemci için etkinleştirildiyse Nonce değeri.
işlem_kimliği	transaction_id		string	yeniden başlatılan imzalama işlemi işlem kimliği
Paket Kimliği	packageId_bulkAction	True	string	Gerçekleştirilecek toplu işlem. Olası değerler şunlardır: SIGN | PAYLAŞ
İmzalama OTP	x-otp		string	İmzalama işlemi için ikinci bir faktör/belge imzalama kimlik doğrulaması olarak kullanılan OTP/TOTP.
Belge Erişim Parolası	x-open-password		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan parola. Parola ayarlanmamışsa değer null olmalıdır.
Belge One-Time Parolası	x-open-otp		string	Varsa, belgeye erişmek için belge sahibi tarafından ayarlanan One-Time Parolası (OTP). OTP ayarlanmamışsa değer null olmalıdır.
Klasör Kimliği	x-folder-id		string	Paylaşılan bir alan klasörü söz konusu olduğunda klasör öğelerini almak için klasör kimliğini belirtin.
Mobil Kaynak	x-mobile		string	İsteğin/eylemin gönderenini (Web/Mobil) tanımlama

Döndürülenler

Body

BulkSignResponse

Toplu İmzalama Durumu

İşlem Kimliği:

V4_Signing_BulkSignStatus

İş uygulamaları, Toplu İmzalama Paketleri API'si tarafından işlenen belge paketlerinin ayrıntılarıyla birlikte belirli bir toplu imzalama işleminin durumunu almak için bu API'yi kullanabilir.

Toplu İmzalama Paketleri API'sinin ardından bu API'yi çağırmanız gerekir.

İmzalayan, çağrıda sunulan erişim belirteci tarafından tanımlanır. Bu nedenle, bu çağrıyı yapmadan önce imzalayanın kimlik doğrulaması gerekir. Kapsam değişkeniyle Kurumsal Yönetici olarak kimlik doğrulaması yapamaz ve kullanıcı adına belge imzalayamazsınız. Erişim belirteci, doğrudan kimlik doğrulamasının bir sonucu olarak imzalayana verilmelidir.

RAS imzalama için ACTION özelliği REMOTE_AUTHORIZATION_REQURIED ve STATUS özelliği BEKLEMEDE olur ve isteğin mobil cihaz kullanılarak yetkilendirilmesi gerektiğini belirtir. İmzalama işlemi, yapılandırılan farklı güvence düzeyleri nedeniyle bazı belgelerde başarısız olursa ve kullanıcı başarısız belgelerde imzalama işlemini tamamlamak için imzalama işlemini yeniden başlatmak isterse, ACTION özelliği REINITIATE_SIGNING_PROCESS olur ve STATUS özelliği BEKLEMEDE olur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
işlem_kimliği	transaction_id		string	Toplu imzalama işleminin kimlik numarası
Toplu Eylem	bulk_action	True	string	Gerçekleştirilecek toplu işlem. Olası değerler şunlardır: SIGN | PAYLAŞ

Döndürülenler

Body

BulkSignStatusResponse

Yer Tutucuyu Güncelleştir

İşlem Kimliği:

V4_Workflow_WorkflowUpdatePlaceholder

İş uygulamaları, iş akışındaki bir yer tutucuyu güncelleştirmek için bu hizmet API'sini kullanabilir. Normalde bu çağrı, bir belgeye şablon uygulandıktan ve iş uygulamaları iş akışındaki belirli bir yer sahibinin ayrıntılarını geçersiz kılmak istediğinde kullanışlıdır. İş akışı belgesinin kimliği kaynak URL'sinde sağlanır ve iş akışı yer tutucusu iş akışına eklenme sırasına göre tanımlanır. XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket Kimliği	packageId	True	integer	Yer tutucunun eklendiği paketin kimliği.
Sipariş	order	True	integer	İş akışındaki alıcının sırası.
yer tutucu	placeholder		string	İş akışına eklenecek yeni yer tutucunun adı. Değer sağlanmazsa, eski değer korunur.
email_notification	email_notification		boolean	Değerini "true" olarak ayarlamak, iş akışına geldiğinde kullanıcıya bir e-posta bildirimi gönderir. Değerini "false" olarak ayarlamak, kullanıcıya e-posta bildirimini kendi dönüşünde göndermez. Değer sağlanmazsa, eski değer korunur.
role	role	True	string	Güncelleştirilecek alıcının rolü. Olası değerler şunlardır: "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST". Değer sağlanmazsa, eski değer korunur. Ancak, XML türü belge hazırlığı sırasında yalnızca desteklenen rol türleri "İMZALAYAN", "GÖZDEN GEÇIREN" ve "CARBON_COPY" olur
signing_order	signing_order		integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.

Döndürülenler

response

object

Şablonları Al

İşlem Kimliği:

V4_Settings_GetTemplates

İş uygulamaları, geçerli kullanıcının şablon listesini almak için bu hizmet API'sini kullanabilir.

"x-search-text" üst bilgisi altında sağlanan ölçüte göre arama yapmak mümkündür. Ayrıca, bir kullanıcının kişisel şablonlarını veya kuruluş şablonlarını, kuruluş yöneticisi tarafından kullanıcı rolüne göre izin verilen şekilde aramak mümkündür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sayfa başına kayıt sayısı	recordPerPage	True	integer	Bir sayfada alınacak toplam kayıt sayısı.
Alınacak sayfa numarası	pageNo	True	integer	Alınacak sayfa numarası.
Sütuna göre verileri sırala	sort-by		string	Sütuna göre sırala. Olası Değerler CREATED_ON ve NAME değerleridir. Varsayılan, CREATED_ON göre sıralanır
Asc	asc		boolean	Sonuçta elde edilen liste sırası. Varsayılan sonuç listesi azalan olacak
Arama metni	x-search-text		string	Gerekirse metin arayın. Bu isteğe bağlıdır ve bu seçenek olmadan listenin tamamı döndürülür. Ayrıca, arama metni parametresi için önerilen değer Base64 kodlanmış biçimindedir.
Yalnızca kurumsal şablonlar	x-enterprise		string	"True" olarak ayarlandığında yalnızca kurumsal şablonlar listesi döndürülür. "False" durumunda yalnızca kullanıcının şablon listesi döndürülür. Üst bilgiyi ayarlamazsanız hem kuruluş hem de kullanıcı şablonları listeleri döndürülür.
Toplam kayıt sayısı	x-total-records		string	Sağlanan arama ölçütleriyle bulunan toplam kayıt sayısı.

Döndürülenler

response

array of TemplateResponse

Tanımlar

ElectronicSealRecipient

Name	Yol	Tür	Description
name	name	string
level_of_assurance	level_of_assurance	string

PermissionLegalNoticeResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Doğru, alıcı için yasal uyarı etkinleştirildiyse ve yapılandırıldıysa.
allowed_notices	allowed_notices	array of LegalNoticeResponse	Belge sahibine, alıcı için seçebileceği yasal bildirimlerin listesi.
default_notice	default_notice	array of LegalNoticeResponse	Alıcı için varsayılan veya seçili yasal bildirim.

LegalNoticeResponse

Name	Yol	Tür	Description
legal_notice_id	legal_notice_id	integer
legal_notice_name	legal_notice_name	string	LegalNoticeResponse
legal_notice_html	legal_notice_html	string	Yasal bildirimin HTML içeriği.

AccessResponse

Name	Yol	Tür	Description
kimlik doğrulama	authentication	AuthenticationResponse
authentication_signing	authentication_signing	AuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

AuthenticationResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
password	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

AccessSecurityPasswordResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için parola kimlik doğrulaması etkinleştirildiyse true.
user_password	user_password	string	Belge erişimi için kimlik doğrulama parolası.

AccessSecuritySmsOtpResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için SMS OTP kimlik doğrulaması etkinleştirildiyse true.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.
methods	methods	array of string	İzin Verilen OTP Yöntemleri

TotpPermissionResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Enabled

AuthenticationSigningResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
sms_otp	sms_otp	AuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

AuthenticationSigningSmsOtpResponse

Name	Yol	Tür	Description
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.
methods	methods	array of string	İzin Verilen OTP Yöntemleri

PermissionAccessDurationResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için erişim süresi güvenliği etkinleştirildiyse true.
duration_by_date	duration_by_date	AccessDurationByDateResponse
duration_by_days	duration_by_days	AccessDurationByDaysResponse

AccessDurationByDateResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Erişim güvenliği tarih ve saate göre bir süre için etkinleştirildiyse True.
Erişile -mez	accessible	boolean
duration	duration	DurationByDateResponse

DurationByDateResponse

Name	Yol	Tür	Description
start_date_time	start_date_time	string	Paketin alıcı tarafından erişilebileceği tarih ve saat.
end_date_time	end_date_time	string	Paketin alıcı tarafından erişilmediği tarih ve saat.

AccessDurationByDaysResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Erişim güvenliği gün sayısına göre bir süre için etkinleştirildiyse Doğru.
Erişile -mez	accessible	boolean
duration	duration	DurationByDaysResponse

DurationByDaysResponse

Name	Yol	Tür	Description
total_days	total_days	integer	Paketi aldıktan sonra paketin alıcı tarafından erişilebileceği toplam gün sayısı.

AnımsatıcıResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Doğru, alıcı için anımsatıcılar etkinleştirildiyse
frequency	frequency	string	Anımsatıcı Sıklığı. Olası Değerler GÜNSAY | SAAT.
remind_after	remind_after	integer	İlk anımsatıcının iş akışı kullanıcısına gönderileceği gün sayısı.
tekrarlamak	repeat	ReminderRepeat

ReminderRepeat

Name	Yol	Tür	Description
enabled	enabled	boolean	Doğru, sonraki anımsatıcılar etkinleştirildiyse.
frequency	frequency	string	Anımsatıcı Sıklığını yineleyin. Olası Değerler GÜNSAY | SAAT.
keep_reminding_after	keep_reminding_after	integer	Sonraki anımsatıcıların iş akışı alıcısına gönderileceği gün sayısı.
total_reminders	total_reminders	integer	İş akışı kullanıcısına gönderilecek sonraki anımsatıcıların sayısı.

AddQrCodeResponse

Name	Yol	Tür	Description
veriler	data	string	QR Kodu tarafından oluşturulan veriler
field_name	field_name	string	Belgede oluşturulan alanın adı.
value	value	string	Değer QrCode görüntüsünün base64 değeri olacaktır

QrCodeOptions

Name	Yol	Tür	Description
error_correction_level	error_correction_level	ECCLevelAPI	Veri yedekliliği miktarını belirleyen QR kodu için Hata Düzeltme Düzeyi. Seçenekler şunlardır: L (Düşük), M (Orta), Q (Dörttebirlik) ve H (Yüksek). Daha yüksek düzeyler daha fazla hata direnci sunar. Varsayılan değer "Q"
encoding	encoding	EciModeAPI	QR kodu içeriği için karakter kodlama modunu belirtir. Desteklenen seçenekler şunlardır: Varsayılan, Iso8859_1, Iso8859_2 ve Utf8. Varsayılan değer "Varsayılan"
pixels_per_module	pixels_per_module	integer	QR kodundaki modül başına piksel sayısını belirtir. Daha yüksek bir sayı, daha büyük ve daha ayrıntılı bir QR koduyla sonuçlanır. Varsayılan değer "20" Olası Değerler: 20 | 30 | 40 | 50
add_margins	add_margins	boolean	QR kodunun çevresinde sessiz bölgelerin (kenar boşlukları) çizilip çizilmeyeceğini gösterir. Sessiz bölgeler, tarayıcıların QR kodunu daha doğru algılamasına ve kodunu çözmesine yardımcı olur. Varsayılan değer "true"

ECCLevelAPI

Veri yedekliliği miktarını belirleyen QR kodu için Hata Düzeltme Düzeyi. Seçenekler şunlardır: L (Düşük), M (Orta), Q (Dörttebirlik) ve H (Yüksek). Daha yüksek düzeyler daha fazla hata direnci sunar. Varsayılan değer "Q"

Veri yedekliliği miktarını belirleyen QR kodu için Hata Düzeltme Düzeyi. Seçenekler şunlardır: L (Düşük), M (Orta), Q (Dörttebirlik) ve H (Yüksek). Daha yüksek düzeyler daha fazla hata direnci sunar. Varsayılan değer "Q"

string

EciModeAPI

QR kodu içeriği için karakter kodlama modunu belirtir. Desteklenen seçenekler şunlardır: Varsayılan, Iso8859_1, Iso8859_2 ve Utf8. Varsayılan değer "Varsayılan"

QR kodu içeriği için karakter kodlama modunu belirtir. Desteklenen seçenekler şunlardır: Varsayılan, Iso8859_1, Iso8859_2 ve Utf8. Varsayılan değer "Varsayılan"

string

QrCodeColor

Name	Yol	Tür	Description
noktalar	dots	string	QR kodundaki noktalar için kullanılan koyu rengi temsil eder. Varsayılan değer "siyah"tır. Örneğin, "#000000"
arka plan	background	string	QR kodunun arka planı için kullanılan açık rengi temsil eder. Varsayılan değer "beyaz"dır. örneğin "#ffffff"

QrCodeLogo

Name	Yol	Tür	Description
base64	base64	string	QR kodunun ortasına yerleştirmek için isteğe bağlı bir simge (base64).
hide_background_dots	hide_background_dots	boolean	Simge sağlanmışsa, simgenin arkasındaki arka plan rengi. Renk sağlanmazsa saydam arka plan uygulanır.
size	size	integer	Simgenin boyutu, bir simge sağlanmışsa QR kodunun boyutunun yüzdesi olarak. Varsayılan değer "15"tir. Olası Değerler: 10 | 15 | 20 | 25 | 30 | 35 | 40

AddFieldResponse

Name	Yol	Tür	Description
field_name	field_name	string	Belgede oluşturulan alanın adı.
created_on	created_on	string	Alan oluşturma tarihi ve saati.

ValidationRule

Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.

Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.

string

SignatureFieldResponse

Name	Yol	Tür	Description
field_name	field_name	string	Belgede oluşturulan alanın adı.
created_on	created_on	string	Alan oluşturma tarihi ve saati.

UpdateQrCodeResponse

Name	Yol	Tür	Description
value	value	string	Değer QrCode görüntüsünün base64 değeri olacaktır

FieldValidationValue

Name	Yol	Tür	Description
required	required	boolean
rules	rules	array of FieldValidationValueRule

FieldValidationValueRule

Name	Yol	Tür	Description
türü	type	string	Şu anda her zaman metin alanı için EQUALS olarak ayarlanmış doğrulama kuralının türünü belirtir.
value	value	string	Doğrulama için kullanılan değeri temsil eder.

PostProcessResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için post işleme etkinleştirildiyse true.
contacts	contacts	array of string	İş akışı tamamlandığında e-postanın gönderileceği e-posta adreslerinin listesi.
recipients	recipients	array of PostProcessRecipientResponse	İş akışı tamamlandıktan sonra posta işleme yürütülürken e-postaların gönderileceği ad ve e-posta adreslerinin listesi.
message	message	string	İş akışı tamamlandığında kişilere gönderilecek herhangi bir özel dize iletisi.
google_drive	google_drive	boolean	Doğru, paket için google drive karşıya yükleme açıksa. İş akışı tamamlandığında belgeler Google Drive'a yüklenir.
one_drive	one_drive	boolean	Doğru, paket için bir sürücü karşıya yükleme açıksa. İş akışı tamamlandığında belgeler tek bir sürücüye yüklenir.
Dropbox	dropbox	boolean	Doğru, paket için dropbox karşıya yükleme açıksa. İş akışı tamamlandığında belgeler Google Drive'a yüklenir.
workflow_recipients	workflow_recipients	boolean	Doğru, iş akışı tamamlama raporu, işlem sonrası yürütülürken iş akışının tüm alıcılarına gönderilecekse. Varsayılan değer yanlış'tır.
document_processing_report	document_processing_report	boolean	Doğru, belge işleme raporunu gönder (XML) iş akışı için etkinleştirilecekse

PostProcessRecipientResponse

Name	Yol	Tür	Description
name	name	string
email	email	string

CertifyResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Doğru, belge için imza ayarlarını onaylama etkinleştirildiyse.
allowed_permissions	allowed_permissions	array of string	İmza ayarlarını onaylama ile belge için ayarlanan izin düzeyini onaylar.
default_permission	default_permission	string

GroupMemberResponse

Name	Yol	Tür	Description
user_email	user_email	string	Grup üyesinin e-posta adresi
user_name	user_name	string	Grup üyesinin kullanıcı adı

CollaboratorResponse

Name	Yol	Tür	Description
user_email	user_email	string	Kullanıcı e-posta adresi
signing_order	signing_order	integer	İmzalama sırası
guest_user	guest_user	boolean	Konuk kullanıcı mı?
email_language_code	email_language_code	string	E-posta dil kodu
izin	permission	WorkflowPermissionResponse
Hatırlatma	reminder	ReminderResponse

WorkflowPermissionResponse

Name	Yol	Tür	Description
print	print	boolean	Doğru, bu alıcı için yazdırmaya izin veriliyorsa.
indir	download	boolean	İndirmeye izin veriliyorsa true.
add_text	add_text	boolean	Doğru, belgeye metin ek açıklaması eklemeye izin veriliyorsa.
change_recipients	change_recipients	boolean	Doğru, geçerli siparişteki alıcı iş akışı paylaşıldıktan sonra iş akışındaki diğer alıcıları değiştirebilirse.
add_attachment	add_attachment	boolean	Pdf belgelerinin eklerine ve birleştirilmesine izin veriliyorsa True.
legal_notice	legal_notice	PermissionLegalNoticeResponse
ek	attachment	AttachmentPermissionResponse

AttachmentPermissionResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Enabled

EnterpriseTemplateResponse

Name	Yol	Tür	Description
kimlik	id	integer	Şablonun kimliği
name	name	string	Şablonun adı.
genel	public	boolean	Kurumsal şablon genel olarak işaretlenmişse yanıt "true" olur. Aksi takdirde "false" döndürülür
read_only	read_only	boolean	Şablon salt okunursa ve kullanıcı bu şablonu uyguladıktan sonra iş akışında herhangi bir değişiklik yapamıyorsa "true" yanıtı. Aksi takdirde "false".
Açıklama	description	string	Şablonun açıklaması
created_on	created_on	string	Şablonun oluşturulduğu tarih ve saat
roles	roles	array of EnterpriseTemplateRole
evrak	documents	array of TemplateDocumentResponse

EnterpriseTemplateRole

Name	Yol	Tür	Description
name	name	string	Kullanıcıya atanan kurumsal rolün adı.
kimlik	id	integer	Kullanıcıya atanan kurumsal rolün kimliği.

TemplateDocumentResponse

Name	Yol	Tür	Description
kimlik	id	integer	Şablon belgesinin kimliği
name	name	string	Şablon belgesinin adı.

Next_signer_email

Name	Yol	Tür	Description
user_email	user_email	string	Sonraki imzalayanın e-posta adresi.
user_name	user_name	string	Sonraki imzalayanın adı.

WorkflowRecipient

Name	Yol	Tür	Description
order	order	integer	İş akışındaki alıcının sırası.
user_email	user_email	string	Kullanıcı grup değilse alıcının e-posta adresi.
user_name	user_name	string	Kullanıcı grup değilse alıcının adı.
mobile_number	mobile_number	string	Cep telefonu numarası
delivery_method	delivery_method	string	Alıcının teslim yöntemi Olası değerler: E-POSTA, SMS veya EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Kaynağa erişmek için API uç noktası, Bu yalnızca ana imzalayanlar için sağlanacaktır. örneğin, grup/temsilci/ağ geçidi denetleyicisi vb. için null olacaktır. Bu URL, imzalayan görüntüsünün mevcut olduğundan emin değildir. Görüntü varsa, tanımlı URL'ye basılarak sağlanacaktır, aksi takdirde boş bir dize olacaktır.
group_name	group_name	string	Alıcı bir grupsa, alıcının grup adı.
group_members	group_members	array of GroupMemberResponse	Alıcı bir grupsa grup üyelerinin e-posta adreslerinin listesi.
temsilci	delegatee	string	Alıcı bir grup değilse, e-posta adresini temsilci olarak belirleyin.
delegatee_name	delegatee_name	string	Alıcı bir grup değilse, temsilci kullanıcının adı.
role	role	string	Alıcının eklendiği iş akışı rolü. Bu rol kurumsal rol değildir. Olası değerler :"İMZALAYAN", "GÖZDEN GEÇIREN","CARBON_COPY" ve "DÜZENLEYICI".
neden	reason	string	Belgeyi reddederken, onaylarken veya gönderirken kullanıcı tarafından sağlanan neden.
process_status	process_status	string	Alıcı için belge işleme durumu. Olası değerler şunlardır: "UN_PROCESSED", "IN_PROGRESS", "İMZALANDı", "GÖZDEN GEÇIRILDI", "REDDEDILDI", "DÜZENLENDİ" veya "GEÇERSIZ".
processed_on	processed_on	string	Belgenin işlendiği tarih ve saat.
processed_as	processed_as	string	Kullanıcı alanı COLLABORATOR, DELEGATOR, GROUP_MEMBER veya OWNER olarak işlenebilir.
processed_by	processed_by	string	Belgeyi işleyen kullanıcının e-posta adresi.
yer tutucu	placeholder	string	Alıcı bir yer tutucuysa yer tutucu metin
signing_order	signing_order	integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.
user_national_id	user_national_id	string	Kullanıcının ulusal kimlik numarası. Bu, iş akışındaki kullanıcıyı tanımlamaya yardımcı olur
guest_user	guest_user	boolean	Gest kullanıcısı
email_language_code	email_language_code	string	e-posta dil kodu
electronic_seal	electronic_seal	ElectronicSealRecipient
ağ geçidi denetleyicisi	gatekeepers	WorkflowGatekeeperResponse

WorkflowGatekeeperResponse

Name	Yol	Tür	Description
emails	emails	array of WorkflowGatekeeperUserResponse	Getekeepers

WorkflowGatekeeperUserResponse

Name	Yol	Tür	Description
user_email	user_email	string

EnterpriseAccessResponse

Name	Yol	Tür	Description
kimlik doğrulama	authentication	EnterpriseAuthenticationResponse
authentication_signing	authentication_signing	EnterpriseAuthenticationSigningResponse
access_duration	access_duration	PermissionAccessDurationResponse

EnterpriseAuthenticationResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
password	password	AccessSecurityPasswordResponse
sms_otp	sms_otp	EnterpriseAccessSecuritySmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAccessSecuritySmsOtpResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için SMS OTP kimlik doğrulaması etkinleştirildiyse true.
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.

EnterpriseAuthenticationSigningResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için kimlik doğrulaması etkinleştirildiyse True.
sms_otp	sms_otp	EnterpriseAuthenticationSigningSmsOtpResponse
totp	totp	TotpPermissionResponse

EnterpriseAuthenticationSigningSmsOtpResponse

Name	Yol	Tür	Description
otp_length	otp_length	integer
retry_duration	retry_duration	integer
mobile_number	mobile_number	string	Alıcının cep telefonu numarası. Kimlik doğrulaması için alıcıya SMS göndermek için cep telefonu numarası gereklidir.

GetPackageDetailsResponse

Name	Yol	Tür	Description
name	name	string	Belge paketinin adı.
mülkiyet sahibi	owner	DocumentOwner
read_only	read_only	boolean	Uygulanan şablon salt okunursa True. Salt okunur bir şablon uygulandığında kullanıcı herhangi bir değişiklik yapamaz.
document_status	document_status	string	Geçerli oturum açmış kullanıcının belge durumu. Olası değerler "DRAFT", "INPROGRESS", "PENDING", "DECLINED" veya "COMPLETED" değerleridir.
evrak	documents	array of DocumentDetails

DocumentOwner

Name	Yol	Tür	Description
name	name	string	Belge paketi sahibinin adı.
email	email	string	Belge paketi sahibinin e-postası.

DocumentDetails

Name	Yol	Tür	Description
kimlik	id	integer	Yeni oluşturulan belgenin kimliği.
name	name	string	Belgenin adı.
uploaded_on	uploaded_on	string	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	string	Belgenin en son değiştirildiği tarih ve saat.
size	size	integer	Belgenin bayt cinsinden boyutu.
türü	type	string	Belgenin türü( örn. "PDF").
kaynak	source	string	Belgenin karşıya yüklendiği yeri tanımlar. Örneğin, "Uygulamam".

TemplateResponse

Name	Yol	Tür	Description
şablon_id	template_id	integer	Şablonun kimliği burada döndürülür
template_name	template_name	string	Şablonun adı.
template_public	template_public	boolean	Kurumsal şablon genel olarak işaretlenmişse yanıt "true" olur. Aksi takdirde "false" döndürülür
read_only	read_only	boolean	Şablon salt okunursa ve kullanıcı bu şablonu uyguladıktan sonra iş akışında herhangi bir değişiklik yapamıyorsa "true" yanıtı. Aksi takdirde "false".
created_on	created_on	string	Şablonun oluşturulduğu tarih ve saat
Açıklama	description	string	Şablonun açıklaması
kuruluş	enterprise	boolean	Kullanıcı bir kuruluşa aitse True.
evrak	documents	array of TemplateDocumentResponse
smart_form	smart_form	TemplateSmartFormResponse

TemplateSmartFormResponse

Name	Yol	Tür	Description
active_count	active_count	integer	Etkin sayı
total_count	total_count	integer	Toplam

StartWorkflowResponse

Name	Yol	Tür	Description
package_id	package_id	integer	Az önce paylaşılan paketin paket kimliği. Tek tek paylaşımdan sonra bir paket oluşturulur ve alıcılarla paylaşılır. API, yeni oluşturulan belgelerin kimlikleriyle birlikte bir paket dizisi döndürür.
evrak	documents	array of integer	Paylaşmadan önce paketin parçası olan belge kimlikleri dizisi.

WorkflowDetailsResponse

Name	Yol	Tür	Description
package_id	package_id	integer	Belge paketinin paket kimliği.
package_name	package_name	string	Belge paketinin adı.
shared_package	shared_package	boolean	paylaşılan paket
package_owner	package_owner	string	Belge paketi sahibinin e-posta adresi.
owner_name	owner_name	string	Belge paketi sahibinin adı.
package_status	package_status	string	Geçerli oturum açmış kullanıcının belge durumu. Olası değerler şunlardır: "TASLAK", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" veya "COMPLETED".
folder	folder	string	Belge paketini içeren klasörün adı.
folder_id	folder_id	integer	Belge paketini içeren klasörün kimliği.
Gatekeeper	gatekeeper	boolean
next_signer	next_signer	string	Belge paylaşılan durumdaysa sonraki imzalayanın adı.
next_signer_email	next_signer_email	array of Next_signer_email	Sonraki imzalayanların kullanıcı adını ve e-posta adresini içeren bir nesne. Grup imzalayıcısı söz konusu olduğunda, tüm grup üyelerinin e-posta adreslerinin bir listesi bulunur.
uploaded_on	uploaded_on	string	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	string	Belgenin en son değiştirildiği tarih ve saat.
iş akışı	workflow	WorkflowResponse
evrak	documents	array of WorkflowDocumentsResponse	Pakete yüklenen belgelerin listesi.
users	users	array of WorkflowUserResponse	İş akışı için alıcılar listesi.

WorkflowResponse

Name	Yol	Tür	Description
workflow_type	workflow_type	string	İş akışının türü, uygulamada desteklenen dört tür iş akışı vardır. Olası değerler "SERIAL", "PARALLEL", "INDIVIDUAL" ve "CUSTOM" değerleridir.
continue_on_decline	continue_on_decline	boolean	Doğru, bir alıcı sırayı reddettikten sonra bile iş akışının devam etmesi gerekiyorsa.
workflow_status	workflow_status	string	İş akışının durumu işlenirken olası değerler "DRAFT", "IN_PRGORESS" ve "COMPLETED" değerleridir.
workflow_mode	workflow_mode	string	İş akışının modu, uygulamada desteklenen üç tür iş akışı modu vardır. Olası değerler şunlardır: "ONLY_ME", "ME_AND_OTHERS" ve "ONLY_OTHERS"
message	message	string	Belge sahibi tarafından iş akışının tüm alıcısına gönderilecek herhangi bir özel dize iletisi.
read_only	read_only	boolean	Bu iş akışındaki belgelere uygulanan herhangi bir şablon salt okunur veya kilitliyse, iş akışı salt okunur olur. SigningHub, son kullanıcıların taslak durumunda bu iş akışında herhangi bir değişiklik yapmasına izin vermez ve bu iş akışı olduğu gibi paylaşılır.
post_process	post_process	PostProcessResponse
comments	comments	boolean	Açıklamalar

WorkflowDocumentsResponse

Name	Yol	Tür	Description
document_id	document_id	integer	Belgenin kimliği.
document_name	document_name	string	Belgenin adı.
document_type	document_type	string	PDF'ye dönüştürmeden önce belge karşıya yüklendiğinde özgün belge uzantısı.
document_order	document_order	integer	Belge paketindeki belgenin sırası.
document_source	document_source	string	Belgenin karşıya yüklendiği belgenin kaynağı.
update_required	update_required	boolean	Belgenin güncelleştirilmek için gerekli olması durumunda True
document_height	document_height	integer	PDF belgesinin yüksekliği.
document_width	document_width	integer	PDF belgesinin genişliği.
document_pages	document_pages	integer	Belgedeki toplam sayfa sayısı.
created_on	created_on	string	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	string	Belgenin en son değiştirildiği tarih ve saat.
form_fields	form_fields	boolean	Belgede form alanları varsa True.
şablon	template	DocumentsTemplateResponse
Tasdik	certify	CertifyResponse
lock_form_fields	lock_form_fields	boolean	Doğru, belge, belgedeki son dijital imzaya sahip form alanlarını kilitlemek üzere ayarlandıysa.
Kilitli	locked	boolean
has_signed_signature_fields	has_signed_signature_fields	boolean	Pdf belgesi meta bilgileri: pdf belgesinde imza alanları varsa true
attachments	attachments	boolean	Belgenin ekleri varsa True.
conformance_level	conformance_level	string	Belge uyumluluk düzeyi
document_size	document_size	integer	Belgenin boyutu.
Biçimlendirilmiş	formatted	boolean	Bu özellik, biçimlendirilmiş veya biçimlendirilmemiş XML belgesi içindir

DocumentsTemplateResponse

Name	Yol	Tür	Description
şablon_id	template_id	integer	Belgeye uygulanan şablonun kimliği.
template_name	template_name	string	Belgeye uygulanan şablonun adı.
read_only	read_only	boolean	Doğru, şablon salt okunur olarak yapılandırılmışsa. Salt okunur bir şablon uygulandıktan sonra iş akışında değişiklik yapılmamalıdır.

WorkflowUserResponse

Name	Yol	Tür	Description
order	order	integer	İş akışındaki alıcının sırası.
user_name	user_name	string	Alıcı bir grup değilse, alıcının adı. Alıcı bir yer tutucuysa, yer tutucunun adını içerir.
user_email	user_email	string	Alıcı bir grup veya yer tutucu değilse alıcının e-posta adresi.
mobile_number	mobile_number	string	Cep telefonu numarası
delivery_method	delivery_method	string	Alıcının teslim yöntemi Olası değerler: E-POSTA, SMS veya EMAIL_AND_SMS
user_photo_url	user_photo_url	string	Kaynağa erişmek için API uç noktası, Bu yalnızca ana imzalayanlar için sağlanacaktır. örneğin, grup/temsilci/ağ geçidi denetleyicisi vb. için null olacaktır. Bu URL, imzalayan görüntüsünün mevcut olduğundan emin değildir. Görüntü varsa, tanımlı URL'ye basılarak sağlanacaktır, aksi takdirde boş bir dize olacaktır.
group_name	group_name	string	Alıcı bir grupsa grubun adı.
group_members	group_members	array of string	Tüm e-posta adreslerinin ve kullanıcıların adlarının listesi.
temsilci	delegator	string	Bu alıcı için temsilci olan kullanıcının e-posta adresi.
Gatekeeper	gatekeeper	string	Bu alıcının ağ geçidi denetleyicisi olan kullanıcının e-posta adresi.
ağ geçidi denetleyicisi	gatekeepers	WorkflowGatekeeperResponse
role	role	string	Alıcının rolü( örneğin, "İMZALAYAN", "GÖZDEN GEÇIREN", "DÜZENLEYICI","CARBON_COPY" veya "INPERSON_HOST".
process_status	process_status	string	Alıcı için belge işleme durumu. Olası değerler şunlardır: "UN_PROCESSED", "IN_PROGRESS", "İMZALANDı", "GÖZDEN GEÇIRILDI", "REDDEDILDI", "DÜZENLENDİ" veya "GEÇERSIZ".
processed_on	processed_on	string	Belgenin işlendiği tarih ve saat.
processed_as	processed_as	string	Kullanıcı alanı COLLABORATOR, DELEGATOR, GROUP_MEMBER veya OWNER olarak işlenebilir.
processed_by	processed_by	string	Belgeyi işleyen kullanıcının e-posta adresi.
neden	reason	string	Belgeyi reddederken, onaylarken veya gönderirken kullanıcı tarafından sağlanan neden.
yer tutucu	placeholder	string	Alıcı bir yer tutucuysa yer tutucu metin.
izin	permission	WorkflowPermissionResponse
authentications	authentications	AccessResponse
Hatırlatma	reminder	ReminderResponse
signing_order	signing_order	integer	İş akışının alıcılar tarafından imzalanacağı sıra. İş akışı türü "ÖZEL" olarak ayarlandığında bu imzalama sırası önemlidir.
user_national_id	user_national_id	string	Kullanıcının ulusal kimlik numarası. Bu, iş akışındaki kullanıcıyı tanımlamaya yardımcı olur
guest_user	guest_user	boolean	Gest kullanıcısı
email_language_code	email_language_code	string	E-posta dil kodu
electronic_seal	electronic_seal	ElectronicSealRecipient

DocumentDetailsResponse

Name	Yol	Tür	Description
document_id	document_id	integer	Yeni oluşturulan belgenin kimliği.
document_name	document_name	string	Belgenin adı.
document_order	document_order	integer
document_type	document_type	string	Belgenin türü( örn. "PDF").
document_width	document_width	integer	Belgenin PDF biçiminde genişliği.
document_height	document_height	integer	Belgenin PDF biçiminde yüksekliği.
document_source	document_source	string	Belgenin karşıya yüklendiği yeri tanımlar. Örneğin, "Uygulamam".
document_pages	document_pages	integer	Belgenin toplam sayfaları.
form_fields	form_fields	boolean	Belgede form alanları varsa True.
lock_form_fields	lock_form_fields	boolean	Form alanlarının son imzayla kilitlenmesi etkinleştirildiyse True.
uploaded_on	uploaded_on	string	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	string	Belgenin en son değiştirildiği tarih ve saat.
Tasdik	certify	DocumentCertifyResponse
şablon	template	DocumentTemplateResponse

DocumentCertifyResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Belge için imzayı onayla etkinleştirildiyse True.
izin	permission	string	İlk imza oluşturulduğunda PDF belgesine uygulanacak onay izinleridir. Olası değerler "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" ve "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" değerleridir.

DocumentTemplateResponse

Name	Yol	Tür	Description
template_name	template_name	string	Belgeye uygulanan şablonun adı.
read_only	read_only	boolean	Uygulanan şablon salt okunursa True. Salt okunur bir şablon uygulandığında kullanıcı herhangi bir değişiklik yapamaz.

AddAttachmentResponse

Name	Yol	Tür	Description
attachment_id	attachment_id	integer	Ek kimliği

GetAttachmentResponse

Name	Yol	Tür	Description
attachment_id	attachment_id	integer	Ek kimliği
attachment_name	attachment_name	string	Ek adı

AddPackageResponse

Name	Yol	Tür	Description
package_id	package_id	integer	Belgeyi paylaşmak, indirmek ve durumunu almak için daha sonra kullanılacak paket kimliği.
workflow_mode	workflow_mode	string	Paket eklenirken ayarlanan iş akışı modu.
workflow_type	workflow_type	string	İş akışının türü. Olası değerler "SERIAL", "PARALLEL", "INDIVIDUAL" ve "CUSTOM" değerleridir.

GetPackagesResponse

Name	Yol	Tür	Description
package_id	package_id	integer	Belge paketinin paket kimliği.
package_name	package_name	string	Belge paketinin adı.
package_owner	package_owner	string	Belge paketi sahibinin e-posta adresi.
owner_name	owner_name	string	Belge paketi sahibinin adı.
shared_package	shared_package	boolean	Paylaşılan Paket
gatekeeper_package	gatekeeper_package	boolean	Ağ Geçidi Denetleyicisi Paketi
package_status	package_status	string	Geçerli oturum açmış kullanıcının belge durumu. Olası değerler "DRAFT", "INPROGRESS", "PENDING", "DECLINED" veya "COMPLETED" değerleridir.
genişletme	extension	string	Belge Paketi uzantısı
workflow_mode	workflow_mode	string	İş Akışı Modu
folder	folder	string	Belge paketini içeren klasörün adı.
folder_id	folder_id	integer	Belge paketini içeren klasörün kimliği.
okunmamış	unread	boolean	Doğru, belge henüz alıcı tarafından okunmuyorsa.
next_signer	next_signer	string	Belge paylaşılan durumdaysa sonraki imzalayanın adı.
next_signer_email	next_signer_email	array of Next_signer_email	Sonraki imzalayanların kullanıcı adını ve e-posta adresini içeren bir nesne. Grup imzalayıcısı söz konusu olduğunda, tüm grup üyelerinin e-posta adreslerinin bir listesi bulunur.
uploaded_on	uploaded_on	string	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	string	Belgenin en son değiştirildiği tarih ve saat.
access_duration	access_duration	RecipientAccessDurationDetails
Düşüş	decline	RecipientDeclineDetails
size	size	integer	Belgenin bayt cinsinden boyutu.

RecipientAccessDurationDetails

Name	Yol	Tür	Description
date_from	date_from	string	Alıcının belgeye erişmesi için başlangıç tarihi/saati
date_to	date_to	string	Alıcının belgeye erişmesi için bitiş tarihi/saati

RecipientDeclineDetails

Name	Yol	Tür	Description
neden	reason	string	Belge reddetme nedenini tanımlama
auto_decline	auto_decline	boolean	Belgenin el ile/otomatik olarak reddedildi göstergesi
declined_by	declined_by	DeclineByDetails

DeclineByDetails

Name	Yol	Tür	Description
user_name	user_name	string	İş akışını reddeden kullanıcının adı
user_email	user_email	string	İş akışını reddeden kullanıcının e-postası

DocumentResponse

Name	Yol	Tür	Description
package_name	package_name	string	Belge Paketi adı

UploadDocument

Name	Yol	Tür	Description
documentId	documentId	integer	Bu özellik geriye dönük uyumluluk için korunur ve sonraki sürümlerde kaldırılacaktır. Bunun yerine document_id kullanın.
documentid	documentid	integer	Daha sonra belgeyi paylaşmak, indirmek ve durumunu almak için kullanılacak belge kimliği. daha sonra kaldırılacak document_id kullanılacak
document_id	document_id	integer	Daha sonra belgeyi paylaşmak, indirmek ve durumunu almak için kullanılacak belge kimliği.
document_name	document_name	string	Belgenin adı.
document_order	document_order	integer	Paketteki belge sırası
document_type	document_type	string	Belgenin türü( örn. "PDF").
document_source	document_source	string	Belgenin karşıya yüklendiği yeri tanımlar. Örneğin, "Uygulamam".
document_width	document_width	integer	Belgenin PDF biçiminde genişliği.
document_height	document_height	integer	Belgenin PDF biçiminde yüksekliği.
document_pages	document_pages	integer	Belgenin toplam sayfaları.
uploaded_on	uploaded_on	date-time	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	date-time	Belgenin en son değiştirildiği tarih ve saat.
lock_form_fields	lock_form_fields	boolean	Form alanlarının son imzayla kilitlenmesi etkinleştirildiyse True.
Tasdik	certify	CertifyPermissionResponse
document_size	document_size	integer	Bayt cinsinden karşıya yüklenen belge boyutu
metadata	metadata	UploadDocumentMetaInfoDetail
package_name	package_name	string	Belge paketi adı

CertifyPermissionResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Belge için imzayı onayla etkinleştirildiyse True.
allowed_permissions	allowed_permissions	array of string	Belge için izin verilen onay izin düzeyleri kümesi.
default_permission	default_permission	string	İmzayı onaylama ayarları için seçilen izin düzeyi.

UploadDocumentMetaInfoDetail

Name	Yol	Tür	Description
attachments	attachments	boolean	pdf belgesinde ek varsa true
form_fields	form_fields	boolean	pdf belgesinin herhangi bir form alanı varsa true
blank_signatures	blank_signatures	boolean	PDF belgesinde boş imza alanı varsa true
signed_signatures	signed_signatures	boolean	pdf belgesinde imzalı imza alanı varsa true
Uygunluk	conformance	string	null/boş belge herhangi bir uyumluluk düzeyi içermiyorsa, aksi takdirde 1A, 1B vb. formasyon içerir
Kilitli	locked	boolean	pdf belgesi kilitliyse true
Tasdik	certify	string	Pdf belgesinin CertifyLevel değeri. NotCertified, NoChangesAllowed, FormFilling, FormFillingAndAnnotations olası değerleri
qr_code	qr_code	boolean	pdf belgesinin qr kodu varsa true, aksi takdirde false

CertifyPolicyResponse

Name	Yol	Tür	Description
Tasdik	certify	CertifyPermissionResponse
lock_form_fields	lock_form_fields	boolean	Form alanları geçerli belgedeki son dijital imzadan sonra PDF'de kilitlenecekse True.

VerificationResponse

Name	Yol	Tür	Description
field_name	field_name	string	Doğrulamanın istendiği alanın adı.
signer_name	signer_name	string	İmzalayanın adı.
signature_status	signature_status	string	İmzanın genel durumu geçerliyse veya değilse. Olası değerler "GEÇERSİz" veya "GEÇERSİz" olabilir.
signing_reason	signing_reason	string	Alanı imzalarken kullanıcı tarafından sağlanan neden. Tanık imzalama durumunda özel imzalama nedeni ayarlanır
signing_location	signing_location	string	Alan imzalanırken kullanıcı tarafından girilen konum.
contact_information	contact_information	string	Alanı imzalarken kullanıcı tarafından girilen kişi bilgileri.
signing_time	signing_time	string	8601 biçiminde oturum açma tarihi ve saati. SH Yöneticisi'nin varsayılan saat dilimi, saati takip edilir.
Ltv	ltv	boolean	Doğru, eğer imza LTV ise.
Nitelikli	qualified	boolean	İmzalar uygunsa True.
Sertifikalı	certified	boolean	doğru, imzalar sertifikalıysa.
certify_permission	certify_permission	string	Sertifikalı dijital imza için izin düzeyi.
timestamp_at	timestamp_at	string	İmzanın zaman damgalı olduğu tarih ve saat.
timestamp_authority	timestamp_authority	string	İmzanın zaman damgasına sahip olduğu yetki.
subject_dn	subject_dn	string	Alanı imzalarken kullanılan sertifikanın DN konusu.
issuer_dn	issuer_dn	string	Alanı imzalarken kullanılan sertifikadan veren DN.
cert_valid_from	cert_valid_from	string	Sertifikanın geçerli olduğu tarih ve saat.
cert_valid_to	cert_valid_to	string	Sertifikanın geçerli olduğu tarih ve saat.
signature_type	signature_type	string	İmzaların türü, olası değerler "PADES_PART2" veya "PADES_PART4".
signature_algorithm	signature_algorithm	string	Alanı imzalarken kullanılan imza algoritması.
signature_application	signature_application	string	Alanın imzalandığı uygulama adı.
signature_policy_id	signature_policy_id	integer	İmza ilkesi kimliği.
signature_policy_uri	signature_policy_uri	string	İmza ilkesi URI'si.
signer_photo	signer_photo	string	İmzalayanın avatarının Base64 görüntüsü.
signer_photo_url	signer_photo_url	string
signed_hash	signed_hash	string	İlgili imzada imzalanan belgenin karması.
göstermek	display	string
page_number	page_number	integer	İmza alanının sayfa numarası
lei_number	lei_number	string	Sertifikada kullanılabilir durumdaysa LEI numarası
lei_role	lei_role	string	Sertifikada varsa LEI rolü
Error_message	error_message	string	Uygulamanın doğrulama sonuçlarını alamaması durumunda bir hata iletisi döndürülüyor.

BulkSignResponse

Name	Yol	Tür	Description
durum	status	string
işlem_kimliği	transaction_id	string

BulkSignStatusResponse

Name	Yol	Tür	Description
durum	status	string
packages	packages	array of BulkSignPackagesStatus

BulkSignPackagesStatus

Name	Yol	Tür	Description
kimlik	id	integer
name	name	string
durum	status	string
hareket	action	string	Varsa gerekli eylem anahtarı
error	error	string
Yüzde	percentage	integer
evrak	documents	array of BulkSignActionDocumentModel	Geçerli paketteki belgeler

BulkSignActionDocumentModel

Name	Yol	Tür	Description
kimlik	id	integer
Alanları	fields	array of BulkSignActionFieldModel

BulkSignActionFieldModel

Name	Yol	Tür	Description
name	name	string
Hash	hash	string
hashing_algo	hashing_algo	string

SignDocumentResponse

Name	Yol	Tür	Description
field_name	field_name	string	Doğrulamanın istendiği alanın adı.
durum	status	string	İmza alanının durumunu döndürür. Değerler İMZALI, BEKLEMEDE. Durum, eIDAS özellikli uzaktan yetkili imzalamada yardımcı olur. İşaret isteği mobil cihazlara gönderilirse durum beklemededir.
işlem_kimliği	transaction_id	string	Bu parametre RAS imzalama sırasında kullanılır
doğrulama	verification	VerificationResponse
authentication_access_token	authentication_access_token	string	Kullanıcının kimliği OIDC aracılığıyla doğrulandığında OIDC id_token içerir

AutoPlaceFieldsResponse

Name	Yol	Tür	Description
field_name	field_name	string	API tarafından otomatik olarak oluşturulan alanın adı.

ContactResponse

Name	Yol	Tür	Description
kimlik	id	integer	kişinin kimliği.
user_name	user_name	string	Kişinin kullanıcı adı.
user_email	user_email	string	Kişinin e-posta adresi.
mobile_number	mobile_number	string	Kişinin cep telefonu numarası.
kuruluş	enterprise	boolean	Doğru, kişi kurumsal ise.
user_national_id	user_national_id	string	İlgili kişinin ulusal kimlik numarası
created_on	created_on	string	Kişi eklendiğinde DateTime.

WorkSpaceMembers

Name	Yol	Tür	Description
name	name	string	çalışma alanı üyesinin adı
email	email	string	çalışma alanı üyesinin E-posta Adresi

WorkSpaceResponse

Name	Yol	Tür	Description
kimlik	id	integer	Paylaşılan alanın kimliği
name	name	string	Paylaşılan alanın adı
mülkiyet sahibi	owner	WorkSpaceOwner
Üyeler	members	array of WorkSpaceMembers	Paylaşılan alanın üyeleri

WorkSpaceOwner

Name	Yol	Tür	Description
name	name	string	Çalışma alanı sahibinin adı
email	email	string	çalışma alanı sahibinin E-posta Adresi

UploadDocumentLibraryResponse

Name	Yol	Tür	Description
document_id	document_id	integer	Yeni oluşturulan belgenin kimliği.
document_name	document_name	string	Belgenin adı.
document_size	document_size	integer	Bayt cinsinden karşıya yüklenen belge boyutu
document_order	document_order	integer	Belgenin sırası
document_type	document_type	string	Belgenin türü( örn. "PDF").
document_source	document_source	string	Belgenin karşıya yüklendiği yeri tanımlar. Örneğin, "Uygulamam".
document_width	document_width	integer	Belgenin PDF biçiminde genişliği.
document_height	document_height	integer	Belgenin PDF biçiminde yüksekliği.
document_pages	document_pages	integer	Belgenin toplam sayfaları.
uploaded_on	uploaded_on	date-time	Belgenin karşıya yüklendiği tarih ve saat.
modified_on	modified_on	date-time	Belgenin en son değiştirildiği tarih ve saat.
form_fields	form_fields	boolean	Belgede form alanları varsa True.
lock_form_fields	lock_form_fields	boolean	Form alanlarının son imzayla kilitlenmesi etkinleştirildiyse True.
Tasdik	certify	UploadDocumentLibraryCertifyResponse
şablon	template	UploadDocumentLibraryTemplateResponse
package_name	package_name	string	Paket adı
metadata	metadata	UploadDocumentMetaInfoDetail

UploadDocumentLibraryCertifyResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Belge için imzayı onayla etkinleştirildiyse True.
allowed_permissions	allowed_permissions	array of string	Belge için izin verilen onay izin düzeyleri kümesi.
default_permission	default_permission	string	İmzayı onaylama ayarları için seçilen izin düzeyi.
izin	permission	string	İlk imza oluşturulduğunda PDF belgesine uygulanacak onay izinleridir. Olası değerler "NO_CHANGES_ALLOWED", "FORM_FILLING_ALLOWED" ve "FORM_FILLING_WITH_ANNOTATIONS_ALLOWED" değerleridir.

UploadDocumentLibraryTemplateResponse

Name	Yol	Tür	Description
template_name	template_name	string	Belgeye uygulanan şablonun adı.
read_only	read_only	boolean	Uygulanan şablon salt okunursa True. Salt okunur bir şablon uygulandığında kullanıcı herhangi bir değişiklik yapamaz.

WorkflowHistoryResponse

Name	Yol	Tür	Description
package_id	package_id	integer	İş akışı geçmişinin istendiği paketin kimliği.
package_name	package_name	string
package_owner	package_owner	string	Paket sahibinin e-posta adresi.
owner_name	owner_name	string	Paket sahibinin adı.
package_status	package_status	string	Geçerli oturum açmış kullanıcının olduğu paketin/belgenin durumu. Olası değerler şunlardır: "TASLAK", "INPROGRESS", "PENDING", "DECLINED", "APPROVED", "UPDATED" veya "COMPLETED".
next_signer	next_signer	string	Sonraki alıcının adı.
next_signer_email	next_signer_email	array of Next_signer_email	Bir sonraki alıcının adı ve e-posta adresine sahip nesne.
evrak	documents	array of WorkflowDocumentsResponse
eylemler	actions	array of DocumentLogsActions

DocumentLogsActions

Name	Yol	Tür	Description
Log_id	log_id	integer	Belgede gerçekleştirilen eylemin kimliği.
date_time	date_time	string	Eylemin gerçekleştirildiği tarih ve saat.
action_type	action_type	string
user_email	user_email	string	Eylemi gerçekleştiren kullanıcının e-postası.
user_name	user_name	string	Eylemi gerçekleştiren kullanıcının adı.
enterprise_name	enterprise_name	string	Kullanıcının ait olduğu Enterprise adı. Kullanıcı bir kuruluşa ait değilse, bu öğe mevcut değildir.
Bilgi	information	DocumentLogsActionsInformation

DocumentLogsActionsInformation

Name	Yol	Tür	Description
türü	type	string	Eylemle ilgili ek bilgi türü (örneğin, "SIGNING_METHOD"), kullanıcının belgeyi imzalamak için kullandığı imzalama yöntemi anlamına gelir.
value	value	string	Eylemle ilgili ek bilgilerin değeri (örn. "YEREL"). Bu, kullanıcının belgeyi yerel olarak tutulan kimlik bilgilerini kullanarak imzaladığı anlamına gelir.

UpdateCollaboratorResponse

Name	Yol	Tür	Description
user_email	user_email	string	Kullanıcı e-posta adresi
signing_order	signing_order	integer	İmzalama sırası
guest_user	guest_user	boolean	Konuk kullanıcı mı?
email_language_code	email_language_code	string	E-posta dil kodu

CollaboratorGroupResponse

Name	Yol	Tür	Description
izin	permission	WorkflowPermissionResponse
Hatırlatma	reminder	ReminderResponse
signing_order	signing_order	integer	İmzalama sırası

CollaboratorPlaceholderResponse

Name	Yol	Tür	Description
izin	permission	WorkflowPermissionResponse
Hatırlatma	reminder	ReminderResponse
signing_order	signing_order	integer	İmzalama sırası

FieldsResponse

Name	Yol	Tür	Description
imza	signature	array of DigitalSignatureFieldResponse	Belgedeki tüm dijital imzaların listesi.
hand_signature	hand_signature	array of HandSignatureFieldResponse
electronic_signature	electronic_signature	array of ElectronicSignatureFieldResponse
Baş harfler	initials	array of InitialFieldResponse
in_person_signature	in_person_signature	array of object
items	in_person_signature	object
text	text	array of TextFieldResponse
radio	radio	array of RadioFieldResponse
Checkbox	checkbox	array of CheckboxFieldResponse
açılan menü	dropdown	array of DropdownFieldResponse
Listbox	listbox	array of ListBoxFieldResponse
qrcode	qrcode	array of QrCodeResponse
ek	attachment	array of AttachmentFieldResponse
yorum	comment	array of CommentFieldResponse
unique_identifier	unique_identifier	array of UniqueIdentifierFieldResponse

DigitalSignatureFieldResponse

Name	Yol	Tür	Description
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string	Alan atandıysa veya atanmazsa, olası değerler ATANDI, UN_ASSIGNED, İmzaLI, LOGGED_IN_USER, GİzLİ ve YER TUTUCU olur.
process_status	process_status	string	Alanın işlenip işlenmediği. Olası değerler UN_PROCESSED, İşLENDİ şeklindedir.
processed_on	processed_on	string	Belgenin işlendiği tarih saati.
processed_as	processed_as	string	Alanı COLLABORATOR, DELEGATEE, GROUP_MEMBER veya OWNER olarak işleyen kullanıcı.
created_on	created_on	string	Alanın eklendiği tarih saati
processed_by	processed_by	string	Alanı işleyen kullanıcının e-posta adresi.
dimensions	dimensions	FieldDimenssionResponse
doğrulama	verification	VerificationResponse
Nıd	nid	string
göstermek	display	string	Dijital imza alanının görünürlük değerini döndürür; olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur.
level_of_assurance	level_of_assurance	array of string
kimlik doğrulama	authentication	FieldAuthentication

FieldDimenssionResponse

Name	Yol	Tür	Description
alan	field	FieldResponse
sayfa	page	PageResponse

FieldResponse

Name	Yol	Tür	Description
x	x	double	Alanın piksel olarak sol konumu.
y	y	double	Alanın piksel olarak en üst konumu.
width	width	double	Alanın piksel cinsinden genişliği.
height	height	double	Alanın piksel cinsinden yüksekliği.

PageResponse

Name	Yol	Tür	Description
width	width	float	Alanın PDF'ye yerleştirildiği sayfanın genişliği.
height	height	float	Alanın PDF'ye yerleştirildiği sayfanın yüksekliği.

FieldAuthentication

Name	Yol	Tür	Description
enabled	enabled	boolean	Elektronik imza alanları için kimlik doğrulamaları etkinleştirildiyse True.
sms_otp	sms_otp	AccessSecuritySmsOtpResponse
totp	totp	AccessSecurityTOTPResponse

AccessSecurityTOTPResponse

Name	Yol	Tür	Description
enabled	enabled	boolean	Paket için TOTP kimlik doğrulaması etkinleştirildiyse True.

HandSignatureFieldResponse

Name	Yol	Tür	Description
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string	Alan atandıysa veya atanmazsa, olası değerler ATANDI, UN_ASSIGNED, İmzaLI, LOGGED_IN_USER, GİzLİ ve YER TUTUCU olur.
process_status	process_status	string	Alanın işlenip işlenmediği. Olası değerler UN_PROCESSED, İşLENDİ şeklindedir.
processed_on	processed_on	string	Belgenin işlendiği tarih saati.
processed_as	processed_as	string	Alanı COLLABORATOR, DELEGATEE, GROUP_MEMBER veya OWNER olarak işleyen kullanıcı.
processed_by	processed_by	string	Alanı işleyen kullanıcının e-posta adresi.
dimensions	dimensions	FieldDimenssionResponse
Nıd	nid	string

ElectronicSignatureFieldResponse

Name	Yol	Tür	Description
order	order	integer	Alanı işleyen kullanıcının e-posta adresi.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string	Alan atandıysa veya atanmazsa, olası değerler ATANDI, UN_ASSIGNED, İmzaLI, LOGGED_IN_USER, GİzLİ ve YER TUTUCU olur.
process_status	process_status	string	Alanın işlenip işlenmediği. Olası değerler UN_PROCESSED, İşLENDİ şeklindedir.
processed_on	processed_on	string	Belgenin işlendiği tarih saati.
processed_as	processed_as	string	Alanı COLLABORATOR, DELEGATEE, GROUP_MEMBER veya OWNER olarak işleyen kullanıcı.
processed_by	processed_by	string	Alanı işleyen kullanıcının e-posta adresi.
dimensions	dimensions	FieldDimenssionResponse
signature_sub_type	signature_sub_type	string	İmza alt türü, WITNESS imzası olabilir. Hizmet planında tanık imzaları etkinleştirilirse, E-İmza alanları hizmet planındaki tüm kullanıcılar tarafından paylaşılan ortak bir sertifikayla imzalar. Olası değerler WITNESS veya NONE değerleridir.
kimlik doğrulama	authentication	FieldAuthentication
doğrulama	verification	VerificationResponse
Nıd	nid	string
göstermek	display	string	Elektronik imza alanının görünürlük değerini döndürür; olası değerler "GÖRÜNÜR" ve "GÖRÜNMEZ" olur.

InitialFieldResponse

Name	Yol	Tür	Description
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
process_status	process_status	string	Alanın işlenip işlenmediği. Olası değerler UN_PROCESSED, İşLENDİ şeklindedir.
processed_on	processed_on	string	Belgenin işlendiği tarih saati.
processed_as	processed_as	string	Alanı COLLABORATOR, DELEGATEE, GROUP_MEMBER veya OWNER olarak işleyen kullanıcı.
processed_by	processed_by	string	Alanı işleyen kullanıcının e-posta adresi.
dimensions	dimensions	FieldDimenssionResponse
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.

TextFieldResponse

Name	Yol	Tür	Description
required	required	boolean	Pdf'de alan gerekiyorsa True
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
tab_order	tab_order	integer	PDF belgesinde sekme sırası
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string	Metin alanının türü, olası değerler "METNEÇEVİr", "AD", "ŞİrKET", "İŞKİLE", "E-POSTA", "TARİh" şeklindedir.
value	value	string	Alanın değeri. tür = TARİh veya format_type = TARİh için değerin ISO 8601 biçimine uyması beklenir. YYYY-MM-DD hh:mm:ss +00 biçiminden sonra. Değerler tarih alanları için olduğundan istemci uygulamaları YYYY-MM-DD gönderebilir ve hh:mm:ss +00 değerini yoksayabilir. Değer düzgün biçimde değilse bir hata döndürülür.
read_only	read_only	boolean	Alan PDF belgesinde salt okunur olarak işaretleniyorsa Doğru.
validation_rule	validation_rule	string	Alanların doğrulanması için bir veya daha fazla kural, olası değerler "ZORUNLU" veya "İsteğE BAĞLI" şeklindedir.
Doğrulama	validation	FieldValidationValue
Görünür	visible	boolean	Alan PDF belgesinde gizli değilse True.
çok satırlı	multiline	boolean	Alan PDF belgesinde çok satırlıysa Doğru.
font	font	FontResponse
max_length	max_length	integer	Alana doldurulması için izin verilen en fazla içerik uzunluğu.
format_type	format_type	string	Alan bir metin kutusuysa, farklı giriş türlerini izleyebilir. Olası değerler ALFASAYıSAL, SAYI, METNEÇEVİr, E-POSTA, SAAT veya TARİh'tir.
yer tutucu	placeholder	string	Metin kutusu alanı için yer tutucu metin.
format	format	string	Alanın metin biçimi. Yalnızca tarih türü alanı için kullanılır. Olası değerler şunlardır: m/d m/d/yy m/d/yyy aa/gg/yy aa/gg/yyyy aa/yy aa/yyyy d-mmm d-mmm-yy d-mmm-yyyy dd-mmm-yy dd-mmm-yyyy yy-mm-dd yyyy-mm-dd mmm-yy mmm-yyyy mmmm-yy mmmm-yyyy mmmm d, yyyy gg/aa/yy ddmmmyyyy
color	color	string	Form alanlarındaki metnin rengi.
kenar_rengi	border_color	string	Form alanının kenarlık rengi.
araç ipucu	tooltip	string	form alanının araç ipucu.
field_rotation	field_rotation	integer	Alan Döndürme
hizalamak	align	string	Form alanı için metin hizalaması. Olası değerler şunlardır: "SAĞ", "SOL", "MERKEZ" veya "YASLA"
dimensions	dimensions	FieldDimenssionResponse

RadioFieldResponse

Name	Yol	Tür	Description
required	required	boolean	Pdf'de alan gerekiyorsa True
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
tab_order	tab_order	integer	PDF belgesinde sekme sırası.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string
value	value	boolean	Alanın değeri.
read_only	read_only	boolean	Alan PDF belgesinde salt okunur olarak işaretlenmişse Doğru.
validation_rule	validation_rule	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
radio_group_name	radio_group_name	string	Alanın ait olduğu grup adı.
kontrol edildi	checked	boolean	Doğru, alan seçiliyse
Görünür	visible	boolean	Alan PDF belgesinde gizli değilse True.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Form alanlarındaki metnin rengi.
kenar_rengi	border_color	string	Form alanının kenarlık rengi.
araç ipucu	tooltip	string	form alanının araç ipucu.
field_rotation	field_rotation	integer	Alan Döndürme

Onay KutusuAlanResponse

Name	Yol	Tür	Description
required	required	boolean	Pdf'de alan gerekiyorsa True
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
tab_order	tab_order	integer	PDF belgesinde sekme sırası
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
türü	type	string
value	value	boolean	Alanın değeri.
read_only	read_only	boolean	Alan PDF belgesinde salt okunur olarak işaretleniyorsa Doğru.
kontrol edildi	checked	boolean	Alan seçiliyse True.
Görünür	visible	boolean	Alan PDF belgesinde gizli değilse True.
validation_rule	validation_rule	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
dimensions	dimensions	FieldDimenssionResponse
color	color	string	Form alanlarındaki metnin rengi.
kenar_rengi	border_color	string	Form alanının kenarlık rengi.
araç ipucu	tooltip	string	form alanının araç ipucu.
field_rotation	field_rotation	integer	Alan Döndürme

DropdownFieldResponse

Name	Yol	Tür	Description
required	required	boolean	Pdf'de alan gerekiyorsa True
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
tab_order	tab_order	integer	PDF belgesinde sekme sırası.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
validation_rule	validation_rule	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
read_only	read_only	boolean	Alan PDF belgesinde salt okunur olarak işaretleniyorsa Doğru.
value	value	string	alanının değeri.
choices	choices	array of string	Açılan listeden değer seçebileceğiniz seçenekler.
Görünür	visible	boolean	Alan PDF belgesinde gizli değilse True.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Form alanlarındaki metnin rengi.
kenar_rengi	border_color	string	Form alanının kenarlık rengi.
araç ipucu	tooltip	string	form alanının araç ipucu.
field_rotation	field_rotation	integer	Alan Döndürme

ListBoxFieldResponse

Name	Yol	Tür	Description
order	order	integer	Bu alanın atandığı alıcının sırası. Alan kimseye atanmamışsa değer null olur.
tab_order	tab_order	integer	PDF belgesinde sekme sırası.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
Katıştırılmış	embedded	boolean	True, if alanı PDF belgesinin bir parçasıysa.
validation_rule	validation_rule	string	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
read_only	read_only	boolean	Alan PDF belgesinde salt okunur olarak işaretleniyorsa Doğru.
value	value	string	Alanın değeri.
choices	choices	array of string	Açılan listeden değer seçebileceğiniz seçenekler.
Görünür	visible	boolean	Alan PDF belgesinde gizli değilse True.
dimensions	dimensions	FieldDimenssionResponse
font	font	FontResponse
color	color	string	Form alanlarındaki metnin rengi.
kenar_rengi	border_color	string	Form alanının kenarlık rengi.
araç ipucu	tooltip	string	form alanının araç ipucu.
field_rotation	field_rotation	integer	Alan Döndürme

FontResponse

Name	Yol	Tür	Description
name	name	string	Metin alanının yazı tipi adı. Kullanıcı tanımlı alanlar için SigningHub yalnızca "COURIER", "HELVETICA" desteği sunar. PDF dosyasındaki mevcut alanlar söz konusu olduğunda, yazı tipi değeri PDF'de ayarlanan herhangi bir şey olabilir.
size	size	integer	Metin alanı için yazı tipi boyutu.
embedded_size	embedded_size	double	Özgün PDF belgesindeki yazı tipinin boyutu.

QrCodeResponse

Name	Yol	Tür	Description
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
türü	type	string	QR gibi Alan Türü PDF_FIELD_TYPE
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
value	value	string	QrCode tarafından oluşturulan base64 taslak modunda zamanında sağlanacaktır
dimensions	dimensions	FieldDimenssionResponse
veriler	data	string	QR kodunda kodlanacak düz metin verileri. Varsayılan değer, ilgili belgeye erişmek için oluşturulan URL'dir. Örneğin{ base_url}/document/{document_unique_id}
options	options	QrCodeOptions
color	color	QrCodeColor
logo	logo	QrCodeLogo

AttachmentFieldResponse

Name	Yol	Tür	Description
order	order	integer	Bu alanın atandığı alıcının sırası.
display_order	display_order	integer	Sıralamayı SigningHub görüntüleyicisine göre görüntüleyin.
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
process_status	process_status	string	Alanın işlenip işlenmediği. Olası değerler UN_PROCESSED, İşLENDİ şeklindedir.
processed_on	processed_on	string	Belgenin işlendiği tarih saati.
processed_as	processed_as	string	Alanı COLLABORATOR, DELEGATEE, GROUP_MEMBER veya OWNER olarak işleyen kullanıcı.
processed_by	processed_by	string	Alanı işleyen kullanıcının e-posta adresi.
attachmentRefId	attachmentRefId	integer	İliştirme başvuru kimliği
not	note	string	İliştirme notu Yalnızca "ZORUNLU" ek kuralı durumunda
validation_rule	validation_rule	ValidationRule	Alanların olası değerlerini doğrulamaya yönelik bir veya daha fazla kural "ZORUNLU" veya "İSTEĞE BAĞLI" şeklindedir.
dimensions	dimensions	FieldDimenssionResponse

CommentFieldResponse

Name	Yol	Tür	Description
kimlik	id	integer	Açıklama alanı kimliği
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
unread_count	unread_count	integer	Okunmamış açıklamalar
özel	private	boolean	Özel
recipients	recipients	array of CommentFieldRecipientResponse	Alıcı
dimensions	dimensions	FieldDimenssionResponse

UniqueIdentifierFieldResponse

Name	Yol	Tür	Description
field_name	field_name	string	Alanın benzersiz tanımlayıcısı.
value	value	string	Alanın değeri.
page_no	page_no	integer	Alanın bulunduğu belgenin sayfa numarası.
font	font	FontResponse
dimensions	dimensions	FieldDimenssionResponse

CommentFieldRecipientResponse

Name	Yol	Tür	Description
user_name	user_name	string	Kullanıcı adı
user_email	user_email	string	Kullanıcı e-posta adresi

nesne

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