Nitro Sign Enterprise Verified (Önizleme)

Nitro Sign Enterprise Verified, çok miktarda imza yöntemi ve en katı (uluslararası) ulusal düzenlemelere uyumluluk sunan ünlü bir dijital imza çözümüdür. NSEV, herhangi bir kağıt tabanlı süreci benzersiz bir kullanıcı deneyimiyle uçtan uca dijital akışa dönüştürmenizi sağlar. İmzalama işlemini tam olarak istediğiniz gibi düzenleyin ve doğrudan sık kullandığınız iş uygulamalarından tüm belge türlerini gönderin, imzalayın ve izleyin.

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	Nitro Desteği
URL	https://www.gonitro.com/support
E-posta	service@gonitro.com

Bağlayıcı Meta Verileri
Publisher	Nitro Software Belçika NV
Web sitesi	https://www.gonitro.com
Gizlilik ilkesi	https://www.gonitro.com/legal/privacy-policy
Kategoriler	BT İşlemleri; Verimli -lik

Nitro Sign Enterprise Doğrulanmış Bağlayıcısı

Akıllı Belge Çözümleri uzmanı Nitro Software, Power Automate için Nitro Sign Enterprise Doğrulanmış Bağlayıcısı'nı kullanıma hazır hale getirdi. Bağlayıcı, şirketlerin dijital imza gerektiren belgeleri doğrudan Microsoft Teams'den Word, SharePoint, Dynamics, OneDrive ve diğer birçok microsoft 365 uygulamasından iletmesine olanak tanır. Nitro Sign Enterprise Verified - eski adıyla Nitro Sign Premium ve Connective eSignatures.

Önkoşullar

Bağlayıcıyı kullanmaya başlamak için Nitro Sign Enterprise Verified aboneliği gereklidir. Nitro Software'deki kişinize ulaşın veya kimlik bilgilerini almak için web sitemizdeki yardım ve destek sayfamıza gidin.

Documentation

Bu sayfa, kullanılabilir farklı eylemleri daha ayrıntılı olarak ayrıntılı olarak inceleyecek ve bu eylemlerin uygulanabileceği farklı yöntemler hakkında içgörü sağlayacaktır.

Daha fazla bilgi için belge web sitemize göz atmaktan veya yardım ve destek sayfamız ya da destek posta kutumuz aracılığıyla destek ekibine ulaşmaktan çekinmeyin: mailto:service@gonitro.com. API belgeleri Postman biçiminde de kullanılabilir.

Bu belge içinde kullanılan farklı terimleri açıklamak için bir sözlük mevcuttur

Desteklenen İşlemler

Nitro Sign Enterprise Verified bağlayıcısı, Nitro Sign Enterprise Verified api v4'lerini temel alır. API, dış uygulamaların imzalama akışları oluşturmak ve yönetmek için bu belgede listelenen özelliklerle tümleştirilmesine ve kullanılmasına olanak tanıyan bir REST API'dir.

Kullanılabilir eylemler farklı gruplar halinde gruplandırılabilir

Eylem Grubu	Kullanılabilir Eylemler
Packages	Tüm paketleri alma
	Kimliğine Göre Paket Al
	Paket Durumunu Al
	Yeni paket oluşturma (standart veya anlık)
	Kimliğine Göre Paket Silme
	Paketin durumunu güncelleştirme
	Paketin bitiş tarihini alma
	Paketin bitiş tarihini güncelleştirme
	İmzalayanları Atla
	Anımsatıcı gönder
	Paket İndirme
	Paketin denetim kaydını indirme
Documents	Pakete belge ekleme
	Paketten imzalı belge indirme
Proje Katılımcıları	Bir Paydaşı Kimliğine Göre Silme
	Paketin tüm paydaşlarını alma
	Pakete paydaş ekleme
İşlem	Paketin tüm işlem adımlarını alma
İşlem	Paket işlemine bir adım ekleme
İşlem	Paketin işlem adımlarının üzerine yazma
İşlem	İşlem adımının tüm eylemlerini alma
İşlem	Bir işlem adımını ve tüm aktörlerini silme
İşlem	İşlem adımına aktör ekleme
İşlem	Geçerli işlem adımındaki tüm eylemleri alma
Other	Uygulamadaki tüm dilleri etkinleştirme
	Pakete atanabilecek tüm temaları alma
	Paketin atanabileceği tüm belge gruplarını alma
	Yapılandırılmış tüm imzalama yöntemlerini alma

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Varsayılan	Bağlantı oluşturmak için parametreler.	Tüm bölgeler	Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim	Türü	Description	Gerekli
Nitro sign konağı	String	Nitro Sign ortamınıza ana bilgisayar ve yol, örneğin contoso.sign.gonitro.com/esig	Doğru
API kullanıcı adı	securestring	API'ye erişmek için API kullanıcı adı	Doğru
API parolası	securestring	API'ye erişmek için API parolası	Doğru

Azaltma Sınırları

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

Eylemler

Belgeyi Paketten İndir	Paketten imzalı bir belge indirin. Her belge PDF veya XML dosyası olarak indirilir.
Bir işlem adımını ve tüm aktörlerini silme	Bir işlem adımını ve tüm aktörlerini siler.
Geçerli işlem adımındaki tüm eylemleri alma	Paralel olarak tamamlanabilir geçerli eylem kümesini alır.
İmzalayanları Atla	Bu çağrı, henüz tamamlanmamış tüm imzalayanları atlar ve durumlarını 'Atlandı' olarak ayarlar ve paketin tamamı 'Bitti' olarak işaretlenir.
İşlem adımına aktör ekleme	İşlem adımına aktör ekler.
İşlem adımının tüm eylemlerini alma	İşlemden paralel olarak tamamlanabilir belirli bir eylem kümesini alır.
Kimliğine Göre Paket Al	Bir paketi kimliğine göre alır.
Kimliğine Göre Paketi Sil	Paketi kimliğine göre siler.
Paket Anımsatıcıları Gönder	Şirket ilkesi, belgenin belirli bir zaman aralığı içinde işlenmesini gerektirebilir. "Anımsatıcı gönder" çağrısı tetiklendiğinde, imzalamamış olan herkes aranacak ve anımsatıcı olarak ek bir bildirim gönderilecektir.
Paket Durumunu Al	Paketin geçerli durumunu alır.
Paket Durumunu Güncelleştir	Paketin durumunu güncelleştirir.
Pakete atanabilecek tüm temaları alma	Bir pakete atanabilecek tüm temaları alır. MaxQuantity ve continuationToken sağlayarak sonucu sayfalandırmak mümkündür
Pakete belge ekleme	Var olan bir pakete belge ekler.
Pakete paydaş ekleme	Pakete paydaş ekler
Paketi İndir	Belirli bir paketteki tüm belgeleri Zip dosyası olarak indirmek için kullanılır.
Paketin bitiş tarihini alma	Paketin bitiş tarihini alma
Paketin bitiş tarihini güncelleştirme	Paketin bitiş tarihini güncelleştirme
Paketin denetim kaydını indirme	Paketin ömrü hakkında imzalı bir denetim izi indirin.
Paketin işlem adımlarının üzerine yazma	Her aktör kümesinin paralel olarak gerçekleştirilebilecek eylemler olduğu bir 2B dizi kullanarak bir paketteki tüm aktörlerin üzerine yazar.
Paketin işlemine bir adım ekleme	Paketin işlemine bir dizi eylem ekler.
Paketin tüm paydaşlarını alma	Paketin paydaşlarını alır
Paketlerin atanabileceği tüm belge gruplarını alma	Paketlerin atanabileceği tüm belge gruplarını alır
Paydaşı kimliğine göre silme	Paydaşı kimliğine göre siler.
Tüm işlem adımlarını alma	Pakette gerçekleştirilmesi gereken tüm eylemleri alır.
Tüm paketleri alma	Tüm paketleri alır, bunlar creationDate'a göre sıralanır
Uygulamada etkinleştirilmiş tüm dilleri alma	Uygulamada etkinleştirilmiş tüm dilleri alır
Yeni paket oluşturma (standart veya anlık)	Yeni bir paket oluşturur. Varsayılan olarak paket taslak olarak oluşturulur. İmzalama için hemen hazır olan bir anlık paket oluşturmak için özelliğini olarak Pendingayarlayınstatus. Not: Uç POST /packages nokta hem standart hem de anlık paketler oluşturmanıza olanak tanır.
Şu anda yapılandırılmış olan tüm imzalama yöntemlerini döndürme	Şu anda yapılandırılmış olan tüm imzalama yöntemlerini döndürür

Belgeyi Paketten İndir

İşlem Kimliği:

Documents_DownloadDocumentFromPackage

Paketten imzalı bir belge indirin. Her belge PDF veya XML dosyası olarak indirilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
Pakette yer alan belgenin benzersiz tanımlayıcısı	documentId	True	string	Pakette yer alan belgenin benzersiz tanımlayıcısı

Döndürülenler

response

binary

Bir işlem adımını ve tüm aktörlerini silme

İşlem Kimliği:

Process_DeleteStep

Bir işlem adımını ve tüm aktörlerini siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
İşlem adımının dizini	stepIndex	True	integer	İşlem adımının dizini

Geçerli işlem adımındaki tüm eylemleri alma

İşlem Kimliği:

Process_GetCurrentStep

Paralel olarak tamamlanabilir geçerli eylem kümesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Döndürülenler

Name	Yol	Tür	Description
Eşya	Items	array of Response.Actor

İmzalayanları Atla

İşlem Kimliği:

Packages_SkipSigners

Bu çağrı, henüz tamamlanmamış tüm imzalayanları atlar ve durumlarını 'Atlandı' olarak ayarlar ve paketin tamamı 'Bitti' olarak işaretlenir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

İşlem adımına aktör ekleme

İşlem Kimliği:

Process_StepPost

İşlem adımına aktör ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
İşlem adımının dizini	stepIndex	True	integer	İşlem adımının dizini
Türü	Type	True	string	Pakette gerçekleştirilmesi gereken eylem türü
PaydaşKimliği	StakeholderId	True	string	Paketteki bir paydaşın tanımlayıcısı
SuppressNotifications	SuppressNotifications		boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl		url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Kimlik	Id		string	Var olan bir öğenin tanımlayıcısı. Kullanılırsa, diğer tüm alanlar boş olmalıdır.
Türü	Type		string	Öğenin türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
DocumentId	DocumentId		string	Paketteki belgenin tanımlayıcısı
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Language	Language		string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Döndürülenler

Body

Response.Actor

İşlem adımının tüm eylemlerini alma

İşlem Kimliği:

Process_GetStep

İşlemden paralel olarak tamamlanabilir belirli bir eylem kümesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
İşlem adımının dizini	stepIndex	True	integer	İşlem adımının dizini

Döndürülenler

Name	Yol	Tür	Description
Eşya	Items	array of Response.Actor

Kimliğine Göre Paket Al

İşlem Kimliği:

Packages_GetPackage

Bir paketi kimliğine göre alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Döndürülenler

Body

Response.Package.Get

Kimliğine Göre Paketi Sil

İşlem Kimliği:

Packages_DeleteById

Paketi kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Paket Anımsatıcıları Gönder

İşlem Kimliği:

Packages_SendReminders

Şirket ilkesi, belgenin belirli bir zaman aralığı içinde işlenmesini gerektirebilir. "Anımsatıcı gönder" çağrısı tetiklendiğinde, imzalamamış olan herkes aranacak ve anımsatıcı olarak ek bir bildirim gönderilecektir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Paket Durumunu Al

İşlem Kimliği:

Packages_GetStatus

Paketin geçerli durumunu alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket için benzersiz tanımlayıcı	packageId	True	string	Paket için benzersiz tanımlayıcı

Döndürülenler

Body

Response.Package.Status

Paket Durumunu Güncelleştir

İşlem Kimliği:

Packages_UpdateStatus

Paketin durumunu güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket için benzersiz tanımlayıcı	packageId	True	string	Paket için benzersiz tanımlayıcı
body	body	True	string

Pakete atanabilecek tüm temaları alma

İşlem Kimliği:

GetAllThemes

Bir pakete atanabilecek tüm temaları alır. MaxQuantity ve continuationToken sağlayarak sonucu sayfalandırmak mümkündür

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sonraki sonuç kümesini almak için belirteç	continuationToken		string	Sonraki sonuç kümesini almak için belirteç
Döndürülecek maksimum sonuç miktarı	maxQuantity		integer	Döndürülecek maksimum sonuç miktarı
Sonuçların sıralanma sırası	sortOrder		string	Sonuçların sıralanma sırası
sıralamak istediğiniz alanı belirtin	sortField		string	sıralamak istediğiniz alanı belirtin

Döndürülenler

Name	Yol	Tür	Description
DevamToken	ContinuationToken	string	Sonuçların sonraki sayfasını almak için belirteç
Eşya	Items	array of object	Temaları içeren liste
Kod	Items.Code	string	Temanın kodu
İsim	Items.Name	string	Temanın adı
MaxQuantity	MaxQuantity	integer	İstek başına döndürülecek en fazla sonuç sayısı
Total	Total	integer	Toplam sonuç sayısı.

Pakete belge ekleme

İşlem Kimliği:

Documents_AddToPackage

Var olan bir pakete belge ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket benzersiz tanımlayıcısı	packageId	True	string	Paket benzersiz tanımlayıcısı
İsim	Name	True	string	Belgenin adı
IsOptional	IsOptional		boolean	Belgenin imzalama için isteğe bağlı olup olmadığını gösterir
Language	Language	True	string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
ExternalReference	ExternalReference		string	Paket için dış başvuru
ProofCorrelationId	ProofCorrelationId		string	Genel olarak benzersiz tanımlayıcı
HedefTürü	TargetType		string	Yalnızca sunucu belge dönüştürmeleri için yapılandırıldığında çalışır.
TargetFormat	TargetFormat		string	Hedef biçim, ek dönüştürme yapılması gerekip gerekmediğini tanımlar.
PdfErrorHandling	PdfErrorHandling		string	Küçük kusurlar içeren PDF'lerle başa çıkma
İçerikTürü	ContentType	True	string	Belgenin MIME türü
Base64Data	Base64Data	True	byte	Base64 ile kodlanmış belge içeriği
Türü	Type	True	string	Öğenin türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Language	Language		string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Döndürülenler

Body

Response.Document

Pakete paydaş ekleme

İşlem Kimliği:

Packages_AddStakeholder

Pakete paydaş ekler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket için benzersiz tanımlayıcı	packageId	True	string	Paket için benzersiz tanımlayıcı
Türü	Type	True	string	Paydaş türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Language	Language	True	string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
İlk İsim	FirstName		string	Paydaşın adı
Soyadı	LastName	True	string	Paydaşın soyadı
E-posta Adresi	EmailAddress	True	email	E-posta adresi
Doğum tarihi	BirthDate		date
Telefon Numarası	PhoneNumber		string	Telefon numarası
AdditionalProperties	AdditionalProperties		object	Paydaşın yapılandırılabilir ek özellikleri
Türü	Type	True	string	Pakette gerçekleştirilmesi gereken eylem türü
SuppressNotifications	SuppressNotifications		boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl		url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Yönlendirme Türü	RedirectType		string
BackButtonUrl	BackButtonUrl		url	Oturumu kapattıktan sonra kullanıcının gönderildiği URL
Kimlik	Id		string	Var olan bir öğenin tanımlayıcısı. Kullanılırsa, diğer tüm alanlar boş olmalıdır.
Türü	Type		string	Öğenin türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
DocumentId	DocumentId		string	Paketteki belgenin tanımlayıcısı
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Language	Language		string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Döndürülenler

Body

Response.Stakeholder

Paketi İndir

İşlem Kimliği:

Packages_DownloadPackage

Belirli bir paketteki tüm belgeleri Zip dosyası olarak indirmek için kullanılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Döndürülenler

response

binary

Paketin bitiş tarihini alma

İşlem Kimliği:

Packages_GetExpiryDate

Paketin bitiş tarihini alma

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Döndürülenler

ISO 8601 biçiminde tarih-saat değeri

response

Common.DateTime

Paketin bitiş tarihini güncelleştirme

İşlem Kimliği:

Packages_PutExpiryDate

Paketin bitiş tarihini güncelleştirme

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
ExpiryTimestamp	ExpiryTimestamp		date-time	ISO 8601 biçiminde tarih-saat değeri

Paketin denetim kaydını indirme

İşlem Kimliği:

Packages_DownloadAuditTrail

Paketin ömrü hakkında imzalı bir denetim izi indirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
Dil 2 harfli ISO kodu (ISO 639-1)	culture	True	string	Dil 2 harfli ISO kodu (ISO 639-1)

Döndürülenler

response

binary

Paketin işlem adımlarının üzerine yazma

İşlem Kimliği:

Process_Put

Her aktör kümesinin paralel olarak gerçekleştirilebilecek eylemler olduğu bir 2B dizi kullanarak bir paketteki tüm aktörlerin üzerine yazar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
Türü	Type	True	string	Pakette gerçekleştirilmesi gereken eylem türü
PaydaşKimliği	StakeholderId	True	string	Paketteki bir paydaşın tanımlayıcısı
SuppressNotifications	SuppressNotifications		boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl		url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Kimlik	Id		string	Var olan bir öğenin tanımlayıcısı. Kullanılırsa, diğer tüm alanlar boş olmalıdır.
Türü	Type		string	Öğenin türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
DocumentId	DocumentId		string	Paketteki belgenin tanımlayıcısı
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Language	Language		string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Paketin işlemine bir adım ekleme

İşlem Kimliği:

Process_PostStep

Paketin işlemine bir dizi eylem ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
Türü	Type	True	string	Pakette gerçekleştirilmesi gereken eylem türü
PaydaşKimliği	StakeholderId	True	string	Paketteki bir paydaşın tanımlayıcısı
SuppressNotifications	SuppressNotifications		boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl		url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Kimlik	Id		string	Var olan bir öğenin tanımlayıcısı. Kullanılırsa, diğer tüm alanlar boş olmalıdır.
Türü	Type		string	Öğenin türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
DocumentId	DocumentId		string	Paketteki belgenin tanımlayıcısı
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Language	Language		string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Döndürülenler

İşlem adımındaki bir dizi aktör.

response

array of Response.Actor

Paketin tüm paydaşlarını alma

İşlem Kimliği:

Packages_GetStakeholders

Paketin paydaşlarını alır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paket için benzersiz tanımlayıcı	packageId	True	string	Paket için benzersiz tanımlayıcı

Döndürülenler

response

array of Response.Stakeholder

Paketlerin atanabileceği tüm belge gruplarını alma

İşlem Kimliği:

GetDocumentGroups

Paketlerin atanabileceği tüm belge gruplarını alır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Aranacak belge grubu adı (veya bölümü)	name		string	Aranacak belge grubu adı (veya bölümü)

Döndürülenler

Name	Yol	Tür	Description
DocumentGroups	DocumentGroups	array of object	Belge gruplarının listesi
Kod	DocumentGroups.Code	string	Belge grubunun kodu
İsim	DocumentGroups.Name	string	Belge grubunun adı

Paydaşı kimliğine göre silme

İşlem Kimliği:

Stakeholder_DeleteById

Paydaşı kimliğine göre siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı
Paydaşın benzersiz tanımlayıcısı	stakeholderId	True	string	Paydaşın benzersiz tanımlayıcısı

Tüm işlem adımlarını alma

İşlem Kimliği:

Process_Get

Pakette gerçekleştirilmesi gereken tüm eylemleri alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Paketin benzersiz tanımlayıcısı	packageId	True	string	Paketin benzersiz tanımlayıcısı

Döndürülenler

Name	Yol	Tür	Description
		array of array
items		array of Response.Actor	İşlem adımındaki bir dizi aktör.

Tüm paketleri alma

İşlem Kimliği:

Packages_Get

Tüm paketleri alır, bunlar creationDate'a göre sıralanır

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alınacak sayfa numarası	pageNumber		integer	Alınacak sayfa numarası
Sayfa başına öğe sayısı	pageSize		integer	Sayfa başına öğe sayısı
Bu tarihten önce oluşturulan paketleri iade edin	createdBefore		date-time	Bu tarihten önce oluşturulan paketleri iade edin
Bu tarihten sonra oluşturulan paketleri iade	createdAfter		date-time	Bu tarihten sonra oluşturulan paketleri iade
Filtre uygulamak için paketlerin durumu	status		string	Filtre uygulamak için paketlerin durumu
Paketleri filtrelemek için belge grubu kodu	documentGroupCode		string	Paketleri filtrelemek için belge grubu kodu
Filtre uygulamak için paket başlatıcısının e-postası	initiator		email	Filtre uygulamak için paket başlatıcısının e-postası
Filtre eklenecek paketin adı	packageName		string	Filtre eklenecek paketin adı
Paketleri filtrelemek için dış başvuru	externalReference		string	Paketleri filtrelemek için dış başvuru
Sonucun nasıl sıralanacağını, varsayılanın azalan olduğunu belirtin	sort		string	Sonucun nasıl sıralanacağını, varsayılanın azalan olduğunu belirtin

Döndürülenler

Name	Yol	Tür	Description
PageNumber	PageNumber	integer	Geçerli sayfa numarası
PageSize	PageSize	integer	Sayfa başına öğe sayısı
TotalPages	TotalPages	integer	Toplam sayfa sayısı
TotalItems	TotalItems	integer	Toplam öğe sayısı
Eşya	Items	array of Response.Package.Get

Uygulamada etkinleştirilmiş tüm dilleri alma

İşlem Kimliği:

GetAllEnabledLanguages

Uygulamada etkinleştirilmiş tüm dilleri alır

Döndürülenler

Name	Yol	Tür	Description
EnabledLanguages	EnabledLanguages	array of object	Etkin dillerin listesi
Gösterim Adı	EnabledLanguages.DisplayName	string	Dilin görünen adı
NativeName	EnabledLanguages.NativeName	string	Dilin yerel adı
IsoCultureCode	EnabledLanguages.IsoCultureCode	string	Dilin 2 harfli ISO kodu (ISO 639-1)

Yeni paket oluşturma (standart veya anlık)

İşlem Kimliği:

Packages_CreatePackage

Yeni bir paket oluşturur. Varsayılan olarak paket taslak olarak oluşturulur. İmzalama için hemen hazır olan bir anlık paket oluşturmak için özelliğini olarak Pendingayarlayınstatus.

Not: Uç POST /packages nokta hem standart hem de anlık paketler oluşturmanıza olanak tanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	Name	True	string	Paketin adı
Initiator	Initiator	True	email	E-posta adresi
ExternalReference	ExternalReference		string	Paket için dış başvuru
Statü	Status		string	Oluşturulan paketin durumu. Göndermeden önce değiştirilebilen standart bir paket oluşturmak için kullanın "Draft" . İmzalama için hemen hazır olan bir anlık paket oluşturmak için kullanın "Pending" .
DocumentGroupCode	DocumentGroupCode		string	Paket için belge grubu kodu
Süre SonuTarihi	ExpiryDate		date-time	ISO 8601 biçiminde tarih-saat değeri
İsim	Name	True	string	Belgenin adı
IsOptional	IsOptional		boolean	Belgenin imzalama için isteğe bağlı olup olmadığını gösterir
Language	Language	True	string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
ExternalReference	ExternalReference		string	Paket için dış başvuru
ProofCorrelationId	ProofCorrelationId		string	Genel olarak benzersiz tanımlayıcı
HedefTürü	TargetType		string	Yalnızca sunucu belge dönüştürmeleri için yapılandırıldığında çalışır.
TargetFormat	TargetFormat		string	Hedef biçim, ek dönüştürme yapılması gerekip gerekmediğini tanımlar.
PdfErrorHandling	PdfErrorHandling		string	Küçük kusurlar içeren PDF'lerle başa çıkma
İçerikTürü	ContentType	True	string	Belgenin MIME türü
Base64Data	Base64Data	True	byte	Base64 ile kodlanmış belge içeriği
Türü	Type	True	string	Öğenin türü
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
İmzalamaMethods	SigningMethods		array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
Türü	Type	True	string	Paydaş türü
ExternalReference	ExternalReference		string	Paket için dış başvuru
Language	Language	True	string	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
İlk İsim	FirstName		string	Paydaşın adı
Soyadı	LastName	True	string	Paydaşın soyadı
E-posta Adresi	EmailAddress	True	email	E-posta adresi
Doğum tarihi	BirthDate		date
Telefon Numarası	PhoneNumber		string	Telefon numarası
AdditionalProperties	AdditionalProperties		object	Paydaşın yapılandırılabilir ek özellikleri
Türü	Type	True	string	Pakette gerçekleştirilmesi gereken eylem türü
SuppressNotifications	SuppressNotifications		boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl		url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Yönlendirme Türü	RedirectType		string
BackButtonUrl	BackButtonUrl		url	Oturumu kapattıktan sonra kullanıcının gönderildiği URL
ProcessStep	ProcessStep		integer	İşlem adımı numarası
DocumentIndex	DocumentIndex	True	integer	Paketteki belgenin dizini (0'dan başlayarak) - yalnızca Paket Oluştur uç noktasında kullanılabilir
Türü	Type	True	string	Öğenin türü
Sayfa	Page		integer	Belgenin sayfa numarası
Yukarı	Top		number	Piksel cinsinden üst konum
Sol	Left		number	Piksel cinsinden sol konum
Genişlik	Width		number	Öğenin genişliği
Yükseklik	Height		number	Öğesinin yüksekliği
İmzalamaMethods	SigningMethods	True	array of string
İsim	Name		string	İmzalama alanına eklenecek yasal bildirimin adı.
Content	Content		string	Özel yasal bildirim içeriği.
ThemeCode	ThemeCode		string	Paket temasının tanımlayıcısı
CallBackUrl	CallBackUrl		url	Eylemler gerçekleştirildikten sonra geri çağırma URL'si
NotificationCallBackUrl	NotificationCallBackUrl		url	İmzalayan yeni bir imzalama URL'si istediğinde geri arama URL'si
DefaultRedirectUrl	DefaultRedirectUrl		url	Eylem tamamlandıktan sonra URL'yi yeniden yönlendirme
F2fRedirectUrl	F2fRedirectUrl		url	Yüz yüze imzalamadan sonra URL'yi yeniden yönlendirme
IsUnsignedContentDownloadable	IsUnsignedContentDownloadable		boolean	İmzasız içeriğin indirilip indirilemeyeceği
IsReassignEnabled	IsReassignEnabled		boolean	Yeniden atamanın etkinleştirilip etkinleştirilmediği

Döndürülenler

Body

Response.Package.Get

Şu anda yapılandırılmış olan tüm imzalama yöntemlerini döndürme

İşlem Kimliği:

GetAllSigningMethods

Şu anda yapılandırılmış olan tüm imzalama yöntemlerini döndürür

Parametreler

Name	Anahtar	Gerekli	Tür	Description
yalnızca etkin/etkin olmayan imzalama yöntemlerini döndür	isActive		boolean	yalnızca etkin/etkin olmayan imzalama yöntemlerini döndür

Döndürülenler

response

array of ConfiguredSigningMethod

Tanımlar

ConfiguredSigningMethod

eSignatures'ta yapılandırılmış bir imzalama yöntemi

Name	Yol	Tür	Description
IsActive	IsActive	boolean	signingMethod'un yeni imzalama alanları oluşturmak için kullanılıp kullanılamayacağı
İsim	Name	string	İmzalama yönteminin yapılandırılmış adı
DisplayNames	DisplayNames	object	İmzalayana gösterilecek dil başına ad
DisplayNamesInitiator	DisplayNamesInitiator	object	Paket oluşturulurken başlatıcıya gösterilmesi gereken dil başına ad.
Açıklamalar	Descriptions	object	Paket oluşturma sırasında imzalama yöntemi hakkında daha fazla bilgi sağlamak için dil başına imzalama yönteminin açıklaması.
RequiredProperties	RequiredProperties	array of string	Zorunlu imzalama için gerekli özellikler
KeyPairs	KeyPairs	array of KeyPair	bu yöntemle imzalamak için kullanılabilecek kullanılabilir KeyPairs

KeyPair

imzalama anahtarı çiftinin gösterimi

Name	Yol	Tür	Description
İsim	Name	string	Anahtar çiftinin adı
DisplayNames	DisplayNames	object	Bir başlatıcıya gösterilecek dil başına ad

Common.Guid

Genel olarak benzersiz tanımlayıcı

Genel olarak benzersiz tanımlayıcı

string

Common.EmailAddress

E-posta adresi

E-posta adresi

email

Common.Language

Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

Bir ülkenin 2 harfli ISO kodu (ISO 639-1)

string

Common.PhoneNumber

Telefon numarası

Telefon numarası

string

Common.ExternalReference

Paket için dış başvuru

Paket için dış başvuru

string

Common.AdditionalProperties

Paydaşın yapılandırılabilir ek özellikleri

Name	Yol	Tür	Description
		object	Paydaşın yapılandırılabilir ek özellikleri

Common.DateTime

ISO 8601 biçiminde tarih-saat değeri

ISO 8601 biçiminde tarih-saat değeri

date-time

Package.Status

Paketin durumu

Paketin durumu

string

Package.Name

Paketin adı

Paketin adı

string

Document.Name

Belgenin adı

Belgenin adı

string

Document.Status

Belgenin durumu

Belgenin durumu

string

Document.DocumentOptions

İsteğe bağlı belge parametrelerini tanımlar

Name	Yol	Tür	Description
HedefTürü	TargetType	string	Yalnızca sunucu belge dönüştürmeleri için yapılandırıldığında çalışır.
TargetFormat	PdfOptions.TargetFormat	string	Hedef biçim, ek dönüştürme yapılması gerekip gerekmediğini tanımlar.
PdfErrorHandling	PdfOptions.PdfErrorHandling	string	Küçük kusurlar içeren PDF'lerle başa çıkma

Stakeholder.FirstName

Paydaşın adı

Paydaşın adı

string

Stakeholder.LastName

Paydaşın soyadı

Paydaşın soyadı

string

Actor.Type

Pakette gerçekleştirilmesi gereken eylem türü

Pakette gerçekleştirilmesi gereken eylem türü

string

Actor.Status

Aktörün durumu

Aktörün durumu

string

Element.Type

Öğenin türü

Öğenin türü

string

Element.Status

Öğenin durumu

Öğenin durumu

string

Element.Location

Name	Yol	Tür	Description
Sayfa	Page	integer	Belgenin sayfa numarası
Yukarı	Top	number	Piksel cinsinden üst konum
Sol	Left	number	Piksel cinsinden sol konum

Element.Dimensions

Name	Yol	Tür	Description
Genişlik	Width	number	Öğenin genişliği
Yükseklik	Height	number	Öğesinin yüksekliği

Response.Package.Get

Name	Yol	Tür	Description
Kimlik	Id	Common.Guid	Genel olarak benzersiz tanımlayıcı
İsim	Name	Package.Name	Paketin adı
Initiator	Initiator	Common.EmailAddress	E-posta adresi
ExternalReference	ExternalReference	Common.ExternalReference	Paket için dış başvuru
OluşturmaTarihi	CreationDate	Common.DateTime	ISO 8601 biçiminde tarih-saat değeri
Statü	Status	Package.Status	Paketin durumu
Süre SonuTarihi	ExpiryDate	Common.DateTime	ISO 8601 biçiminde tarih-saat değeri
Documents	Documents	array of Response.Document
Proje Katılımcıları	Stakeholders	array of Response.Stakeholder

Response.Document

Name	Yol	Tür	Description
Kimlik	Id	Common.Guid	Genel olarak benzersiz tanımlayıcı
Statü	Status	Document.Status	Belgenin durumu
DocumentOptions	DocumentOptions	Document.DocumentOptions	İsteğe bağlı belge parametrelerini tanımlar
İsim	Name	Document.Name	Belgenin adı
Language	Language	Common.Language	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
ExternalReference	ExternalReference	Common.ExternalReference	Paket için dış başvuru
ProofCorrelationId	ProofCorrelationId	Common.Guid	Genel olarak benzersiz tanımlayıcı

Response.Stakeholder

Name	Yol	Tür	Description
Türü	Type	string	Paydaş türü
ExternalReference	ExternalReference	Common.ExternalReference	Paket için dış başvuru
Kimlik	Id	Common.Guid	Genel olarak benzersiz tanımlayıcı
Language	Language	Common.Language	Bir ülkenin 2 harfli ISO kodu (ISO 639-1)
İlk İsim	FirstName	Stakeholder.FirstName	Paydaşın adı
Soyadı	LastName	Stakeholder.LastName	Paydaşın soyadı
E-posta Adresi	EmailAddress	Common.EmailAddress	E-posta adresi
Doğum tarihi	BirthDate	date
Telefon Numarası	PhoneNumber	Common.PhoneNumber	Telefon numarası
AdditionalProperties	AdditionalProperties	Common.AdditionalProperties	Paydaşın yapılandırılabilir ek özellikleri
Actors	Actors	array of Response.Actor

Response.Actor

Name	Yol	Tür	Description
Türü	Type	Actor.Type	Pakette gerçekleştirilmesi gereken eylem türü
Kimlik	Id	Common.Guid	Genel olarak benzersiz tanımlayıcı
PaydaşKimliği	StakeholderId	Common.Guid	Genel olarak benzersiz tanımlayıcı
Statü	Status	Actor.Status	Aktörün durumu
SuppressNotifications	SuppressNotifications	boolean	Aktör için bildirimleri gizleme
RedirectUrl	RedirectUrl	url	Aktörün eylemi tamamlandıktan sonra URL'yi yeniden yönlendirme
Elements	Elements	array of Response.Element

Response.Element

Name	Yol	Tür	Description
Türü	Type	Element.Type	Öğenin türü
Kimlik	Id	Common.Guid	Genel olarak benzersiz tanımlayıcı
ActorId	ActorId	Common.Guid	Genel olarak benzersiz tanımlayıcı
DocumentId	DocumentId	integer	Paketteki belgenin tanımlayıcısı
Statü	Status	Element.Status	Öğenin durumu
ExternalReference	ExternalReference	Common.ExternalReference	Paket için dış başvuru
Yer	Location	Element.Location
Boyutlar	Dimensions	Element.Dimensions
İmzalamaMethods	SigningMethods	array of string
UsedSigningMethod	UsedSigningMethod	string	Kullanılan imzalama yöntemi

Response.Package.Status

Name	Yol	Tür	Description
Statü	Status	Package.Status	Paketin durumu

ikili

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