Nitro İşareti (Önizleme)

Nitro Sign API,uygulamaların dijital imzalama işlemleri oluşturmasına, yönetmesine ve izlemesine olanak tanıyarak güvenli, uçtan uca eSignature iş akışları sağlar. Zarf oluşturma, belgeleri karşıya yükleme, katılımcı ekleme, imza siparişi tanımlama ve imza için belgeleri tam otomatik, API temelli bir yaklaşımla gönderme özellikleri sağlar.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Service	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)

Contact
İsim	Nitro desteği
URL	https://www.gonitro.com/support
E-posta	prosupport@sfdc.gonitro.com

Bağlayıcı Meta Verileri
Publisher	Nitro PDF
Web Sitesi	https://www.gonitro.com/
Gizlilik ilkesi	https://www.gonitro.com/legal/privacy-policy
Kategoriler	Verimli -lik; BT işlemleri

Nitro İşaret Bağlayıcısı

Genel bakış

Nitro Sign bağlayıcısı, doğrudan Power Automate ve Power Apps güvenli, uçtan uca eSignature iş akışları sağlar. Uygulamaların imza zarfları oluşturmasına ve yönetmesine, belgeleri karşıya yüklemesine ve yeniden sıralamasına, katılımcı eklemesine ve imzalama sırası tanımlamasına, imza ve veri alanları yerleştirmesine, imza için belge göndermesine, ilerleme durumunu izlemesine ve özgün, korumalı ve denetim izi dosyalarını indirmesine olanak tanır. Tamamen otomatik, API temelli bir yaklaşımla.

Publisher: Nitro Software

Prerequisites

Bu bağlayıcı aracılığıyla Nitro Sign'ı kullanmak için şunları yapmanız gerekir:

Nitro Sign'ın etkinleştirildiği bir Nitro hesabı
https://developers.gonitro.com/
Özel Bağlayıcı özelliklerine sahip bir Microsoft PowerApps veya Power Automate planı.

Authentication

Nitro Sign, API istekleri için erişim belirteçleri oluşturmak üzere İstemci Kimlik Bilgileri izniyle makineden makineye OAuth 2.0 kullanır.

Nasıl çalışır?

Nitro'nun self servis portalındabir API uygulaması oluşturur ve ilişkili İstemci Kimliğini ve Gizli Anahtarı alırsınız.
Bağlayıcı, taşıyıcı erişim belirteci için bu kimlik bilgilerini değiştirerek kimlik doğrulaması yapar.
Daha sonra belirteç, sonraki Nitro Sign API çağrılarını yetkilendirmek için kullanılır.

Kimlik bilgileri oluşturma ve ayrıntılı kılavuzu okuma:
https://developers.gonitro.com/docs/authentication/credentials

Power Automate /Power Apps'da bağlantı oluşturma

Bağlayıcıyı bir akışa veya uygulamaya eklerken:

Yeni bağlantı ekle'ye tıklayın.
İstemci Kimliğinizi ve Gizli Anahtarınızı (Nitro geliştirici portalında verilen) girin.
Nitro Hesabınızla ilişkili bölge olan Nitro Bölgenizi (Avrupa, Birleşik Devletler veya APAC) seçin.
Bağlantıyı kaydedin; ilk kullanımda bağlayıcı, OAuth 2.0 İstemci Kimlik Bilgileri iznini kullanarak İstemci Kimliğinizi ve İstemci Gizli Anahtarınızı kısa süreli bir erişim belirteci ile değiştirir, önbelleğe alır ve otomatik olarak yeniler. Kimlik bilgileriniz yalnızca belirteci almak için kullanılır; sonraki API çağrılarının kimliği sizin yerinize taşıyıcı belirteçle doğrulanır.

Not: Kullanıcı etkileşimli oturum açma gerekmez; bu akış, sunucudan sunucuya / uygulamadan uygulamaya senaryolar için tasarlanmıştır.

Desteklenen İşlemler

Bağlayıcı, eylemlerini bir imzalama iş akışının dört kaynağı ( Zarflar, Belgeler, Alanlar ve Katılımcılar ) ve tamamlanmış dosyaları almak için bir dizi İndirme eylemi etrafında gruplandırır.

1. Zarflar

Zarf, tek bir imzalama isteğindeki belgeler, katılımcılar ve alanlar için kapsayıcıdır.

Zarfları Listele
Hesaptaki uygulamayla ilişkili tüm zarfları döndürür. Sonuçlar sayfalandırılmıştır: yanıt, sonraki sayfayı almak için isteğe bağlı Page After parametresine sağlayabileceğiniz bir Sonraki Sayfa imleç belirteci içerir (veya sayfa geri gitmek için Sayfa Öncesi). her iki imleç parametresi gelişmiş'in altındadır ve yalnızca büyük sonuç kümelerinde gezinirken gereklidir.
Zarf Oluştur
Ad, bildirim iletisi (ve gibi $(sender_name_or_email)$(envelope_name)dinamik değişkenler içeren konu + gövde) ve imzalama modu içeren yeni bir zarf oluşturur:
- parallel — tüm katılımcılara aynı anda bildirim gönderilir ve bağımsız olarak imzalayabilirler.
- sequential — Katılımcılara, eklendikleri sırayla birer birer bildirim gönderilir.
Kimliğine Göre Zarfı Al
UUID'sine göre belirli bir zarfa ilişkin ayrıntıları alır.
Zarfı Güncelleştir
Zarf adını, bildirim ayarlarını ve/veya imzalama modunu güncelleştirir. Tüm alanlar isteğe bağlıdır.
Kimliğine Göre Zarfı Sil
Zarfı ve tüm ilişkili belgeleri, alanları ve katılımcıları kalıcı olarak siler. Bu geri alınamaz.
İmzalama için Zarf Gönder
Zarfı imza toplama için katılımcılara gönderir. Göndermeden önce, zarfın normalde belgeleri, katılımcıları ve imzalama alanları eklenmelidir ( Zarf Kimliğine Göre Belge Oluştur, Zarf Kimliğine Göre Katılımcı Oluştur ve Belge Kimliğine Göre Alanlar Oluştur aracılığıyla). Zarfın gönderilebilmesi için zarftaki tüm belgelerin karşıya yüklenmiş durumu olmalıdır.
Zarf için Anımsatıcı Gönder
Bekleyen katılımcılara anımsatıcı bildirimleri tetikler. Bildirim ayarı sağlanmazsa zarf için yapılandırılan varsayılan bildirim şablonu kullanılır.
Kimliğine Göre Zarfı İptal Et
İmzalama isteğini iptal eder. Yalnızca imza için önceden gönderilmiş zarflar iptal edilebilir.

2. Belgeler

Belgeler, bir zarfa eklenmiş ve katılımcılar tarafından imzalanmış dosyalardır.

Belgeleri Zarf Kimliğine Göre Listeleme
Bir zarfla ilişkili tüm belgeleri alır.
Zarf Kimliğine Göre Belge Oluştur
Belgeyi var olan bir zarfa yükler. Dosyayı ve basit, yazılı alanları sağlayın; elle yazılmış JSON yok:
- Belge Dosyası — karşıya yüklenecek dosya.
- Belge Adı — belgenin altında depo istediğiniz addır.
- İçerik Türü(gelişmiş, isteğe bağlı) — dosyanın MIME türü; varsayılan değeridirapplication/pdf. Atlandığında yalnızca PDF dosyaları kabul edilir.
Kimliğine Göre Belge Al
Zarftaki belirli bir belgenin ayrıntılarını alır.
Belgeyi Kimliğine Göre Güncelleştir
Belge meta verilerini güncelleştirir. Şu anda yalnızca belge adı değiştirilebilir.
Kimliğine Göre Belgeyi Sil
Zarftan belgeyi kalıcı olarak siler.
Belgeleri Zarf Kimliğine Göre Yeniden Sırala
Sağlanan belge kimlikleri listesine göre zarftaki belgeleri yeniden sıralar.

3. Alanlar

Alanlar, belgeye yerleştirilen ve katılımcıya atanan etkileşimli öğelerdir (imza, baş harfler, tarih vb.).

Alanları Belge Kimliğine Göre Listele
Belirli bir belgeyle ilişkili tüm alanları alır.
Belge Kimliğine Göre Alan Oluşturma
Belgede bir veya daha fazla alan oluşturur ve bunları katılımcılara atar. Tek bir alan için bir öğe veya toplu istek için birden çok öğe sağlayın. Her alan şu değerleri belirtir:
- participantID — alana atanan katılımcı.
- type— , signature, initials, name, , date, title, , company, checkbox. custom
- page — sayfa numarası (1 tabanlı dizin oluşturma).
- X Konumu, Y Konumu, Genişlik, Yükseklik — her biri nokta cinsinden ayrı bir sayı olarak girilen alanın konumu ve boyutu (X/Y, sayfanın sol/üst kenarından ölçülür). Bunlar önceki tek boundingBox dizinin yerini alır, bu nedenle her değer el ile oluşturulmuş bir liste yerine kullanıcı arabiriminde yazılan bir alan olur.
- İsteğe bağlı: required (varsayılan true), ve — Gelişmiş altında — format (ör. MM/DD/YYYY tarih alanları için) ve modifiable.
Alanı Kimliğine Göre Güncelleştir
Mevcut bir alanın özelliklerini güncelleştirir. Alan type sağlanmalıdır ve mevcut alan türüyle eşleşmelidir; alan şemasını tanımlamak için kullanılır ve alan türünü değiştirmez.
Alanı Kimliğine Göre Sil
Belgeden bir alanı kalıcı olarak siler.

4. Katılımcılar

Katılımcılar, zarfı imzalamak veya bilgilendirilmek üzere alan kişilerdir.

Katılımcıları Zarf Kimliğine Göre Listele
Bir zarfla ilişkili tüm katılımcıları alır.
Zarf Kimliğine Göre Katılımcı Oluşturma
Zarfa bir veya daha fazla katılımcı ekler. Tek bir katılımcı için bir öğe veya toplu istek için birden çok öğe sağlayın. Her katılımcının belirttiği:
- email — katılımcının e-posta adresi.
- role — signer (imza için atanmış alanlar olabilir) veya cc (salt okunur erişim).
- authentication (gelişmiş, isteğe bağlı) — şu anda Erişim Kodu: katılımcının imzalamadan önce sağlaması gereken statik bir erişim kodu. Bu bölümü yalnızca katılımcının imzalamadan önce kimlik doğrulaması yapması gerekiyorsa açın.
Katılımcıyı Kimliğine Göre Güncelleştir
Katılımcının kimlik doğrulama ayarlarını güncelleştirir. Katılımcı e-postası değiştirilemez.
Kimliğine Göre Katılımcıyı Sil
Bir katılımcıyı zarftan kalıcı olarak siler.

5. İndirmeler

Belgeler imzalanıp mühürlendikten sonra tamamlanmış dosyaları alın.

Orijinal Zarfı İndir
İmzalanmamış özgün belgeleri bir zarftan ZIP arşivi olarak indirir.
Korumalı Zarfı İndir
Korumalı imzalı belgeleri, denetim iziyle birlikte ZIP arşivi olarak indirir.
Kimliğine Göre Korumalı Belgeyi İndir
Tek bir korumalı imzalı belgeyi PDF dosyası olarak indirir.
Zarfın Denetim Kaydını İndir
Bir zarfın tam denetim kaydını PDF dosyası olarak indirir.

İndirme eylemleri seçiciye özel Dosya Adı ve Dosya İçeriği belirteçlerini (artı Dosya İçerik Türü) kullanıma sunar. Dosya İçeriğini doğrudan bir aşağı akış adımının dosya girişine (örneğin, OneDrive /SharePoint Dosya Oluştur) ve Dosya Adı'nı dosya adı girişine bırakın. İfade body('Action_Name') veya el ile yazılan dosya adı gerekmez; bağlayıcı indirilen ZIP veya PDF'yi bir JSON zarfı içine sarmalar, böylece Power Automate bunları normal dinamik içerik belirteçleri olarak ortaya çıkar.

Tipik İmzalama İş Akışı

Tam bir imzalama akışı, yukarıdaki eylemleri sırayla zincirler. Yaygın bir Power Automate akışı şöyle görünür:

Zarf Oluştur — adı, bildirim konusunu/gövdesini ve imzalama modunu (parallel veya sequential) ayarlayın. Döndürülen Zarf Kimliğini kaydedin.
Zarf Kimliğine Göre Belge Oluştur — zarfa bir veya daha fazla dosya yükleyin (1. adımdaki Zarf Kimliğini kullanarak). Döndürülen her Belge Kimliğini kaydedin.
(İsteğe bağlı)Belgeleri Zarf Kimliğine Göre Yeniden Sırala — belge sırasını ayarlayın.
Zarf Kimliğine göre Katılımcı oluşturma — erişim kodu kimlik doğrulamasıyla imzalayanları ve BILGI alıcılarını ekleyin. Döndürülen her Katılımcı Kimliğini kaydedin.
Belge Kimliğine Göre Alanlar Oluşturma — her belgeye imza/tarih/vb. alanları yerleştirin ve bunları katılımcılara atayın (2. adımdaki Belge Kimliği ve 3. adımdaki Katılımcı Kimliği'ni kullanarak).
İmzalama için Zarf Gönder — zarfı gönderin. Tüm belgelerin önce karşıya yüklenen durumda olması gerekir.
(Beklerken)Katılımcıları itmek için Zarf anımsatıcıları gönderin veya isteği durdurmak için Zarfı Kimlikle İptal Et'i seçin.
(Tamamlandığında)Tamamlanan dosyaları almak için Korumalı Zarfı / İndir Kimlikle / Korumalı Belgeyiİndir Zarfın Denetim Kaydını İndirin.

İpucu: Oluşturma eylemleri tarafından döndürülen Zarf Kimliği, Belge Kimliği ve Katılımcı Kimliği, Power Automate dinamik içerik seçicisi aracılığıyla sonraki eylemlere doğal olarak akar; yazmak yerine yukarı akış eyleminden kimlik belirtecini seçin.

Hatalar ve Azaltma

Nitro Sign API'sinde aşağıdaki hatalar döndürülebilir:

400 — Hatalı istek
401 — Yetkisiz
404 — Bulunamadı
409 — Çakışma (örn. işleme izin vermeyen bir durumdaki bir zarf üzerinde hareket etme)
413 — İçerik çok büyük
415 — Desteklenmeyen medya türü
422 — İşlenemeyen varlık
500 — İç sunucu hatası

Throttling

Bağlantı başına API çağrıları: 60 saniyede 100.

Platform Sınırları

Dosya Boyutu

Maksimum: İstek başına 25 MB
Hem tek dosyalı hem de çok dosyalı işlemler için geçerlidir.

Sayfa Sayısı

Maksimum: Tek tek belge başına 250 sayfa
Birden çok belgede birleştirilmiş toplam sayfa sayısı 250'yi aşabilir.

Bekletme Süresi

Giriş ve çıkış dosyaları işlem tamamlandıktan yaklaşık 15 dakika sonra silinir.

Notes

Zarf, belge, alan ve katılımcı yönetimi eylemleri JSON döndürür.
İndirme eylemleri Dosya Adı, Dosya İçerik Türü ve Dosya İçeriğini seçici yerel belirteçler olarak kullanıma seçerek JSON zarfında sarmalanmış dosyayı (ZIP veya PDF) döndürür, böylece sonuçlar ifadeler olmadan aşağı akış dosyası eylemine zincirlenebilir.
İmzalama modu (parallel vs sequential) zarf oluşturulduğunda ayarlanır ve zarf gönderilmeden önce Zarfı Güncelleştir ile değiştirilebilir.
Katılımcı kimlik doğrulaması şu anda yalnızca Erişim Kodunu destekler.

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	Required
Nitro İstemci Kimliği	securestring	Nitro uygulamanızın İstemci Kimliği	True
Nitro İstemci Gizli Dizisi	securestring	Nitro uygulamanız İstemci Gizli Dizisi	True
Nitro Bölgesi	string	Hesabınız için Nitro API bölgesini seçin.	True

Eylemler

Alanları Belge Kimliğine Göre Listele	Nitro İşareti zarfı içindeki belirli bir belgeyle ilişkili tüm alanları alır.
Alanı Kimliğine Göre Güncelleştir	Nitro Sign belgesindeki mevcut bir alanın özelliklerini güncelleştirir. Alan türü sağlanmalıdır ve mevcut alan türüyle eşleşmelidir; api tarafından alan şemasını tanımlamak için kullanılır ve alan türünü değiştirmez.
Alanı Kimliğine Göre Sil	Nitro İşareti zarfı içindeki bir belgeden bir alanı kalıcı olarak siler.
Belge Kimliğine Göre Alan Oluşturma	Belgede bir veya daha fazla alan oluşturur ve bunları katılımcılara atar. Tek bir alan oluşturmak için Alanlar dizisinde bir öğe sağlayın. Birden çok alan oluşturmak için birden çok öğe sağlayın.
Belgeleri Zarf Kimliğine Göre Listeleme	Belirli bir Nitro İşareti zarfıyla ilişkili tüm belgeleri alır.
Belgeleri Zarf Kimliğine Göre Yeniden Sırala	Belirli bir Nitro sign zarfı ile ilişkili belgeleri, sağlanan belge kimlikleri listesine göre yeniden sıralar.
Belgeyi Kimliğine Göre Güncelleştir	Nitro İşareti zarfı içinde var olan bir belgenin meta verilerini güncelleştirir. Şu anda yalnızca belge adı güncelleştirilebilir.
İmzalama için Zarf Gönder	İmza toplama için katılımcılara nitro işareti zarfı gönderir. Bu eylemi kullanmadan önce, zarfta normalde Zarf Kimliğine Göre Belge Oluştur, Zarf Kimliğine Göre Katılımcı Oluştur ve Belge Kimliğine Göre Alan Oluştur kullanılarak belgeler, katılımcılar ve imzalama alanları eklenmelidir. Zarfın gönderilebilmesi için zarftaki tüm belgelerin karşıya yüklenmiş durumu olmalıdır.
Katılımcıları Zarf Kimliğine Göre Listele	Belirli bir Nitro sign zarfıyla ilişkili tüm katılımcıları alır.
Katılımcıyı Kimliğine Göre Güncelleştir	Nitro sign zarfı içindeki bir katılımcı için kimlik doğrulama ayarlarını güncelleştirir. Katılımcı e-postası güncelleştirilemiyor.
Kimliğine Göre Belge Al	Nitro İşareti zarfında belirli bir belgenin ayrıntılarını alır.
Kimliğine Göre Belgeyi Sil	Nitro İşareti zarfından bir belgeyi kalıcı olarak siler.
Kimliğine Göre Katılımcıyı Sil	Katılımcıyı Nitro Sign zarfından kalıcı olarak siler.
Kimliğine Göre Korumalı Belgeyi İndir	Nitro Sign zarfından pdf dosyası olarak tek bir korumalı imzalı belge indirir.
Kimliğine Göre Zarfı Al	Benzersiz zarf kimliğini kullanarak belirli bir Nitro Sign zarfı için ayrıntıları alır.
Kimliğine Göre Zarfı İptal Et	Nitro Sign zarfı için imzalama isteğini iptal eder. Yalnızca imzalama için gönderilmiş zarflar iptal edilebilir.
Kimliğine Göre Zarfı Sil	Nitro İşareti zarfı kalıcı olarak silinir. Bu işlem geri alınamaz ve ilişkili tüm belgeler, alanlar ve katılımcılar da silinir.
Korumalı Zarfı İndir	Korumalı imzalı belgeleri Nitro Sign zarfından ve denetim izinden zip arşivi olarak indirir.
Orijinal Zarfı İndir	Nitro Sign zarfından imzalanmamış özgün belgeleri ZIP arşivi olarak indirir.
Zarf için Anımsatıcı Gönder	Belirtilen nitro işareti zarfının bekleyen katılımcılarına anımsatıcı bildirimleri tetikler. Bildirim ayarı sağlanmazsa zarf için yapılandırılan varsayılan bildirim şablonu kullanılır.
Zarf Kimliğine Göre Belge Oluştur	Bir belgeyi mevcut nitro işareti zarfa yükler. Belge daha sonra imzalama iş akışında kullanılabilir.
Zarf Kimliğine Göre Katılımcı Oluşturma	Nitro sign zarfa bir veya daha fazla katılımcı ekler. Tek bir katılımcı eklemek için Katılımcılar dizisinde bir öğe sağlayın. Birden çok katılımcı eklemek için birden çok öğe sağlayın.
Zarf Oluştur	Daha sonra belgeler, katılımcılar, alanlar ile doldurulabilen ve imza için gönderilebilen yeni bir Nitro İşareti zarfı oluşturur.
Zarfları Listele	Zarfları Listele uç noktası, bir hesaptaki bir uygulamayla ilişkili tüm zarfları döndürür.
Zarfı Güncelleştir	Mevcut Bir Nitro İşareti zarfı güncelleştirir. Zarf adını, bildirim ayarlarını, imzalama modunu veya bu alanların herhangi bir bileşimini değiştirebilirsiniz.
Zarfın Denetim Kaydını İndir	Seçili Nitro İşareti zarfı için tam denetim kaydını içeren PDF dosyasını indirir.

Alanları Belge Kimliğine Göre Listele

İşlem Kimliği:: ListFieldsByDocumentID

Nitro İşareti zarfı içindeki belirli bir belgeyle ilişkili tüm alanları alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Alanları alınması gereken belgeyi tanımlayan benzersiz bir UUID.

Döndürülenler

Bir veya daha fazla alan oluşturulduktan sonra yanıt döndürüldü.

Body: FieldsResponse

Alanı Kimliğine Göre Güncelleştir

İşlem Kimliği:: UpdateFieldByID

Nitro Sign belgesindeki mevcut bir alanın özelliklerini güncelleştirir. Alan türü sağlanmalıdır ve mevcut alan türüyle eşleşmelidir; api tarafından alan şemasını tanımlamak için kullanılır ve alan türünü değiştirmez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Alanını içeren belgeyi tanımlayan benzersiz bir UUID.
Alan Kimliği	fieldID	True	uuid	Güncelleştirilecek alanı tanımlayan benzersiz bir UUID.
Alan Türü	type	True	string	Güncelleştirilmekte olan alanın geçerli türü. Bu değer API tarafından gereklidir ve mevcut alan türüyle eşleşmelidir; alan türünü değiştirmez.
Katılımcı Kimliği	participantID		uuid	Alana atanan katılımcının benzersiz tanımlayıcısı.
Sayfa	page		integer	Alanın görüntülendiği sayfa numarası. Sayfalar 1 tabanlı dizinleme kullanır.
X Konumu	x		float	Optional. Sayfanın sol kenarından nokta cinsinden ölçülen alanın yatay konumu.
Y Konumu	y		float	Optional. Sayfanın üst kenarından nokta cinsinden ölçülen alanın dikey konumu.
Genişlik	width		float	Optional. Alanın nokta cinsinden genişliği.
Yükseklik	height		float	Optional. Alanın nokta cinsinden yüksekliği.
Required	required		boolean	Katılımcının bu alanı tamamlaması gerekip gerekmediğini gösterir.
Format	format		string	Uygun olduğunda alan biçimi. Örneğin, tarih alanları AA/GG/YYYY gibi bir biçim kullanabilir.
Değiştirilebilir	modifiable		boolean	Alan değerinin, uygun olduğunda değiştirilebilir olup olmadığını gösterir.

Döndürülenler

Nitro İşareti alan ayrıntıları.

Body: FieldResponse

Alanı Kimliğine Göre Sil

İşlem Kimliği:: DeleteFieldByID

Nitro İşareti zarfı içindeki bir belgeden bir alanı kalıcı olarak siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Alanını içeren belgeyi tanımlayan benzersiz bir UUID.
Alan Kimliği	fieldID	True	uuid	Silinecek alanı tanımlayan benzersiz bir UUID.

Belge Kimliğine Göre Alan Oluşturma

İşlem Kimliği:: CreateFieldsByDocumentID

Belgede bir veya daha fazla alan oluşturur ve bunları katılımcılara atar. Tek bir alan oluşturmak için Alanlar dizisinde bir öğe sağlayın. Birden çok alan oluşturmak için birden çok öğe sağlayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Alanların oluşturulması gereken belgeyi tanımlayan benzersiz bir UUID.
Katılımcı Kimliği	participantID	True	uuid	Alana atanan katılımcının benzersiz tanımlayıcısı.
Sayfa	page	True	integer	Alanın yerleştirilmesi gereken sayfa numarası. Sayfalar 1 tabanlı dizin oluşturma kullanır, bu nedenle ilk sayfa 1'dir.
Alan Türü	type	True	string	Oluşturulacak alan türü.
X Konumu	x	True	float	Sayfanın sol kenarından nokta cinsinden ölçülen alanın yatay konumu.
Y Konumu	y	True	float	Sayfanın üst kenarından nokta cinsinden ölçülen alanın dikey konumu.
Genişlik	width	True	float	Alanın nokta cinsinden genişliği.
Yükseklik	height	True	float	Alanın nokta cinsinden yüksekliği.
Required	required		boolean	Katılımcının bu alanı tamamlaması gerekip gerekmediğini gösterir.
Format	format		string	Biçimlendirmeyi destekleyen alan türleri için isteğe bağlı biçim, örneğin tarih alanları. Örnek: AA/GG/YYYY.
Değiştirilebilir	modifiable		boolean	Alan değerinin, alan türü tarafından desteklendiği katılımcı tarafından değiştirilip değiştirilemeyeceğini gösterir.

Döndürülenler

Bir veya daha fazla alan oluşturulduktan sonra yanıt döndürüldü.

Body: FieldsResponse

Belgeleri Zarf Kimliğine Göre Listeleme

İşlem Kimliği:: ListDocumentsByEnvelopeID

Belirli bir Nitro İşareti zarfıyla ilişkili tüm belgeleri alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeleri alınması gereken zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro İşareti zarfı ile ilişkili belgeler listelenirken yanıt döndürüldü.

Body: ListDocumentsByEnvelopeIDResponse

Belgeleri Zarf Kimliğine Göre Yeniden Sırala

İşlem Kimliği:: ReorderDocumentsByEnvelopeID

Belirli bir Nitro sign zarfı ile ilişkili belgeleri, sağlanan belge kimlikleri listesine göre yeniden sıralar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeleri yeniden sıralanması gereken zarfı tanımlayan benzersiz bir UUID.
Belge Kimlikleri	order	True	array of uuid	Zarftaki belgelerin yeni sırasını temsil eden belge kimlikleri dizisi.

Döndürülenler

Nitro İşareti zarfı ile ilişkili belgeler listelenirken yanıt döndürüldü.

Body: ListDocumentsByEnvelopeIDResponse

Belgeyi Kimliğine Göre Güncelleştir

İşlem Kimliği:: UpdateDocumentByID

Nitro İşareti zarfı içinde var olan bir belgenin meta verilerini güncelleştirir. Şu anda yalnızca belge adı güncelleştirilebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Güncelleştirilecek belgeyi tanımlayan benzersiz bir UUID.
Belge Adı	name	True	string	Belgenin yeni adı.

Döndürülenler

Nitro sign belge ayrıntıları.

Body: DocumentResponse

İmzalama için Zarf Gönder

İşlem Kimliği:: SendEnvelopeForSigning

İmza toplama için katılımcılara nitro işareti zarfı gönderir. Bu eylemi kullanmadan önce, zarfta normalde Zarf Kimliğine Göre Belge Oluştur, Zarf Kimliğine Göre Katılımcı Oluştur ve Belge Kimliğine Göre Alan Oluştur kullanılarak belgeler, katılımcılar ve imzalama alanları eklenmelidir. Zarfın gönderilebilmesi için zarftaki tüm belgelerin karşıya yüklenmiş durumu olmalıdır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	İmzalama için gönderilecek zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro İşareti zarfı hakkında özet bilgiler.

Body: EnvelopeSummaryResponse

Katılımcıları Zarf Kimliğine Göre Listele

İşlem Kimliği:: ListParticipantsByEnvelopeID

Belirli bir Nitro sign zarfıyla ilişkili tüm katılımcıları alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Katılımcılarının alınması gereken zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro İşareti zarfı ile ilişkili katılımcılar listelenirken yanıt döndürüldü.

Body: ParticipantsListResponse

Katılımcıyı Kimliğine Göre Güncelleştir

İşlem Kimliği:: UpdateParticipantByID

Nitro sign zarfı içindeki bir katılımcı için kimlik doğrulama ayarlarını güncelleştirir. Katılımcı e-postası güncelleştirilemiyor.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Katılımcıyı içeren zarfı tanımlayan benzersiz bir UUID.
Katılımcı Kimliği	participantID	True	uuid	Güncelleştirilecek katılımcıyı tanımlayan benzersiz bir UUID.
Kimlik Doğrulaması Türü	type		string	Optional. Katılımcı için bir kimlik doğrulama yöntemi seçin. Belirtilirse, bir Erişim Kodu da sağlanmalıdır.
Erişim Kodu	accessCode		string	Yalnızca Kimlik Doğrulama Türü belirtildiğinde gereklidir. Katılımcı kimlik doğrulaması gerekmiyorsa boş bırakın.

Döndürülenler

Nitro Sign katılımcı ayrıntıları.

Body: ParticipantResponse

Kimliğine Göre Belge Al

İşlem Kimliği:: GetDocumentByID

Nitro İşareti zarfında belirli bir belgenin ayrıntılarını alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Alınacak belgeyi tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro sign belge ayrıntıları.

Body: DocumentResponse

Kimliğine Göre Belgeyi Sil

İşlem Kimliği:: DeleteDocumentByID

Nitro İşareti zarfından bir belgeyi kalıcı olarak siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	Silinecek belgeyi tanımlayan benzersiz bir UUID.

Kimliğine Göre Katılımcıyı Sil

İşlem Kimliği:: DeleteParticipantByID

Katılımcıyı Nitro Sign zarfından kalıcı olarak siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Katılımcıyı içeren zarfı tanımlayan benzersiz bir UUID.
Katılımcı Kimliği	participantID	True	uuid	Silinecek katılımcıyı tanımlayan benzersiz bir UUID.

Kimliğine Göre Korumalı Belgeyi İndir

İşlem Kimliği:: DownloadSealedDocumentByID

Nitro Sign zarfından pdf dosyası olarak tek bir korumalı imzalı belge indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Korumalı belgeyi içeren zarfı tanımlayan benzersiz bir UUID.
Belge Kimliği	documentID	True	uuid	İndirilmesi gereken korumalı belgeyi tanımlayan benzersiz bir UUID.

Döndürülenler

İndirilen dosya JSON zarfı olarak sarmalanmış.

Body: FileDownloadResponse

Kimliğine Göre Zarfı Al

İşlem Kimliği:: GetEnvelopeByID

Benzersiz zarf kimliğini kullanarak belirli bir Nitro Sign zarfı için ayrıntıları alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Alınacak zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro İşareti zarfı istendikten veya oluşturulduktan sonra yanıt döndürülür.

Body: EnvelopeResponse

Kimliğine Göre Zarfı İptal Et

İşlem Kimliği:: CancelEnvelopeByID

Nitro Sign zarfı için imzalama isteğini iptal eder. Yalnızca imzalama için gönderilmiş zarflar iptal edilebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	İptal edilen zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

Nitro İşareti zarfı istendikten veya oluşturulduktan sonra yanıt döndürülür.

Body: EnvelopeResponse

Kimliğine Göre Zarfı Sil

İşlem Kimliği:: DeleteEnvelopeByID

Nitro İşareti zarfı kalıcı olarak silinir. Bu işlem geri alınamaz ve ilişkili tüm belgeler, alanlar ve katılımcılar da silinir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Silinecek zarfı tanımlayan benzersiz bir UUID.

Korumalı Zarfı İndir

İşlem Kimliği:: DownloadSealedEnvelope

Korumalı imzalı belgeleri Nitro Sign zarfından ve denetim izinden zip arşivi olarak indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Korumalı belgeleri indirilmesi gereken zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

İndirilen dosya JSON zarfı olarak sarmalanmış.

Body: FileDownloadResponse

Orijinal Zarfı İndir

İşlem Kimliği:: DownloadOriginalEnvelope

Nitro Sign zarfından imzalanmamış özgün belgeleri ZIP arşivi olarak indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Özgün belgeleri indirilmesi gereken zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

İndirilen dosya JSON zarfı olarak sarmalanmış.

Body: FileDownloadResponse

Zarf için Anımsatıcı Gönder

İşlem Kimliği:: SendRemindersForEnvelope

Belirtilen nitro işareti zarfının bekleyen katılımcılarına anımsatıcı bildirimleri tetikler. Bildirim ayarı sağlanmazsa zarf için yapılandırılan varsayılan bildirim şablonu kullanılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Anımsatıcı bildirimlerinin gönderilmesi gereken zarfı tanımlayan benzersiz bir UUID.
Bildirim Konusu	subject		string	İmzalama katılımcılarına gönderilen e-posta bildiriminin konu satırı. Dinamik değişkenler desteklenir, örneğin: $(sender_name_or_email) imzanızı ister.
Bildirim Gövdesi	body		string	İmzalama katılımcılarına gönderilen e-posta gövdesi. Dinamik değişkenler desteklenir, örneğin: Merhaba,\nLütfen $(envelope_name)\nTeşekkürler\n$(sender_name_or_email) imzalayın.

Zarf Kimliğine Göre Belge Oluştur

İşlem Kimliği:: CreateDocumentByEnvelopeID

Bir belgeyi mevcut nitro işareti zarfa yükler. Belge daha sonra imzalama iş akışında kullanılabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Belgenin yüklendiği zarfı tanımlayan benzersiz bir UUID.
Belge Adı	documentName	True	string	Karşıya yüklenecek belgenin adı. Bu değer Nitro'ya gönderilen belge meta verilerini oluşturmak için kullanılır.
İçerik Türü	contentType		string	Karşıya yüklenen belgenin içerik türü. PDF dosyaları için uygulama/pdf kullanın. Meta verilerden atlandığında yalnızca PDF dosyaları kabul edilir.
Belge Dosyası	payload	True	file	Zarfa yüklenecek belge dosyası.

Döndürülenler

Name	Yol	Tür	Description
Belge Kimliği	ID	uuid	Karşıya yüklenen belgeyi tanımlayan benzersiz bir UUID.
Belge Adı	name	string	Karşıya yüklenen belgenin adı.
Oluşturulma Tarihi	createdAt	string	Belgenin ne zaman oluşturulduğunu gösteren zaman damgası.
Belge Durumu	status	string	Karşıya yüklenen belgenin işleme durumu.

Zarf Kimliğine Göre Katılımcı Oluşturma

İşlem Kimliği:: CreateParticipantsByEnvelopeID

Nitro sign zarfa bir veya daha fazla katılımcı ekler. Tek bir katılımcı eklemek için Katılımcılar dizisinde bir öğe sağlayın. Birden çok katılımcı eklemek için birden çok öğe sağlayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Katılımcıların eklenmesi gereken zarfı tanımlayan benzersiz bir UUID.
E-posta	email	True	email	Katılımcının e-posta adresi.
Rolü	role	True	string	Katılımcı rolü. İmzalayan, imzalama için atanmış alanlara sahip olabilir. Bilgi katılımcısı salt okunur erişime sahiptir.
Kimlik Doğrulaması Türü	type		string	Optional. Katılımcı için bir kimlik doğrulama yöntemi seçin. Belirtilirse, bir Erişim Kodu da sağlanmalıdır.
Erişim Kodu	accessCode		string	Yalnızca Kimlik Doğrulama Türü belirtildiğinde gereklidir. Katılımcı kimlik doğrulaması gerekmiyorsa boş bırakın.

Döndürülenler

Bir veya daha fazla katılımcı oluşturulduktan sonra yanıt döndürüldü.

Body: ParticipantsResponse

Zarf Oluştur

İşlem Kimliği:: CreateEnvelope

Daha sonra belgeler, katılımcılar, alanlar ile doldurulabilen ve imza için gönderilebilen yeni bir Nitro İşareti zarfı oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Adı	name	True	string	Zarfın adı. Benzersiz olması gerekmez.
İmzalama Modu	mode	True	string	İmzalama sırasını tanımlar. Tüm katılımcıları aynı anda bilgilendirmek için paralel kullanın veya katılımcıları eklendikleri sırayla tek tek bilgilendirmek için sıralı olarak kullanın.
Bildirim Konusu	subject	True	string	İmzalama katılımcılarına gönderilen e-posta bildiriminin konu satırı. Dinamik değişkenler desteklenir, örneğin: $(sender_name_or_email) imzanızı ister.
Bildirim Gövdesi	body	True	string	İmzalama katılımcılarına gönderilen e-posta gövdesi. Dinamik değişkenler desteklenir, örneğin: Merhaba,\nLütfen $(envelope_name)\nTeşekkürler\n$(sender_name_or_email) imzalayın.

Döndürülenler

Nitro İşareti zarfı istendikten veya oluşturulduktan sonra yanıt döndürülür.

Body: EnvelopeResponse

Zarfları Listele

İşlem Kimliği:: ListEnvelopes

Zarfları Listele uç noktası, bir hesaptaki bir uygulamayla ilişkili tüm zarfları döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sonraki Sayfa	pageAfter		string	Zarfların sonraki sayfasını almak için kullanılan isteğe bağlı imleç belirteci. Önceki yanıt tarafından döndürülen nextPage değerini kullanın.
Önceki Sayfa	pageBefore		string	Önceki zarf sayfasını almak için kullanılan isteğe bağlı imleç belirteci. Page After ile birlikte kullanmayın.

Döndürülenler

Name	Yol	Tür	Description
Zarf	items	array of EnvelopeSummaryResponse	Zarf listesi.
Sonraki Sayfa	nextPage	string	Sonraki zarf sayfasını almak için Page After olarak kullanılabilen imleç belirteci.

Zarfı Güncelleştir

İşlem Kimliği:: UpdateEnvelope

Mevcut Bir Nitro İşareti zarfı güncelleştirir. Zarf adını, bildirim ayarlarını, imzalama modunu veya bu alanların herhangi bir bileşimini değiştirebilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Güncelleştirilecek zarfı tanımlayan benzersiz bir UUID.
Zarf Adı	name		string	Güncelleştirilmiş zarf adı. Benzersiz olması gerekmez.
Bildirim Konusu	subject		string	İmzalama katılımcılarına gönderilen e-posta bildiriminin konu satırı. Dinamik değişkenler desteklenir, örneğin: $(sender_name_or_email) imzanızı ister.
Bildirim Gövdesi	body		string	İmzalama katılımcılarına gönderilen e-posta gövdesi. Dinamik değişkenler desteklenir, örneğin: Merhaba,\nLütfen $(envelope_name)\nTeşekkürler\n$(sender_name_or_email) imzalayın.
İmzalama Modu	mode		string	İmzalama sırasını tanımlar. Tüm katılımcıları aynı anda bilgilendirmek için paralel kullanın veya katılımcıları eklendikleri sırayla tek tek bilgilendirmek için sıralı olarak kullanın.

Döndürülenler

Nitro İşareti zarfı istendikten veya oluşturulduktan sonra yanıt döndürülür.

Body: EnvelopeResponse

Zarfın Denetim Kaydını İndir

İşlem Kimliği:: DownloadAuditTrailOfEnvelope

Seçili Nitro İşareti zarfı için tam denetim kaydını içeren PDF dosyasını indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Zarf Kimliği	envelopeID	True	uuid	Denetim izinin indirilmesi gereken zarfı tanımlayan benzersiz bir UUID.

Döndürülenler

İndirilen dosya JSON zarfı olarak sarmalanmış.

Body: FileDownloadResponse

Tanımlar

Zarf Açıklama

Nitro sign zarfı için bildirim e-posta ayarları.

Name	Yol	Tür	Description
Bildirim Konusu	subject	string	İmzalama katılımcılarına gönderilen e-posta bildiriminin konu satırı. Dinamik değişkenler desteklenir, örneğin: $(sender_name_or_email) imzanızı ister.
Bildirim Gövdesi	body	string	İmzalama katılımcılarına gönderilen e-posta gövdesi. Dinamik değişkenler desteklenir, örneğin: Merhaba,\nLütfen $(envelope_name)\nTeşekkürler\n$(sender_name_or_email) imzalayın.

EnvelopeSummaryResponse

Nitro İşareti zarfı hakkında özet bilgiler.

Name	Yol	Tür	Description
Zarf Kimliği	ID	uuid	Zarfı tanımlayan benzersiz bir UUID.
Oluşturulma Tarihi	createdAt	date-time	Zarfın ne zaman oluşturulduğunu gösteren UTC zaman damgası.
Son Değiştirme Tarihi	lastModifiedAt	date-time	Zarfın en son ne zaman değiştirildiğini gösteren UTC zaman damgası.
Zarf Adı	name	string	Zarfın adı.
Zarf Durumu	status	string	Zarfın iç durumu.

ZarfResponse

Nitro İşareti zarfı istendikten veya oluşturulduktan sonra yanıt döndürülür.

Name	Yol	Tür	Description
Zarf Kimliği	ID	uuid	Zarfı tanımlayan benzersiz bir UUID.
Oluşturulma Tarihi	createdAt	date-time	Zarfın ne zaman oluşturulduğunu gösteren UTC zaman damgası.
Son Değiştirme Tarihi	lastModifiedAt	date-time	Zarfın en son ne zaman değiştirildiğini gösteren UTC zaman damgası.
Zarf Adı	name	string	Zarfın adı.
Zarf Durumu	status	string	Zarfın iç durumu.
İmzalama Modu	mode	string	Zarf için yapılandırılmış imzalama modu.
bildirim	notification	EnvelopeNotification	Nitro sign zarfı için bildirim e-posta ayarları.

ListDocumentsByEnvelopeIDResponse

Nitro İşareti zarfı ile ilişkili belgeler listelenirken yanıt döndürüldü.

Name	Yol	Tür	Description
Documents	items	array of DocumentResponse	Zarfla ilişkilendirilmiş belgelerin listesi.

DocumentResponse

Nitro sign belge ayrıntıları.

Name	Yol	Tür	Description
Belge Kimliği	ID	uuid	Belgeyi tanımlayan benzersiz bir UUID.
Belge Adı	name	string	Belgenin adı.
Oluşturulma Tarihi	createdAt	date-time	Belgenin ne zaman oluşturulduğunu gösteren UTC zaman damgası.
Bayt cinsinden boyut	sizeBytes	integer	Bayt cinsinden belge boyutu.
Sayfa Sayısı	numPages	integer	Belgedeki sayfa sayısı.
Belge Durumu	status	string	Belgenin geçerli durumu.

FieldsResponse

Bir veya daha fazla alan oluşturulduktan sonra yanıt döndürüldü.

Name	Yol	Tür	Description
Fields	items	array of FieldResponse	Bu istekte oluşturulan alanlar.

FieldResponse

Nitro İşareti alan ayrıntıları.

Name	Yol	Tür	Description
Alan Kimliği	ID	uuid	Alanı tanımlayan benzersiz bir UUID.
Katılımcı Kimliği	participantID	uuid	Alana atanan katılımcının benzersiz tanımlayıcısı.
Belge Kimliği	documentID	uuid	Alanın ait olduğu belgenin benzersiz tanımlayıcısı.
Sayfa	page	integer	Alanın görüntülendiği sayfa numarası.
Sınırlayıcı Kutu	boundingBox	array of float	Nokta cinsinden ölçülen [x, y, width, height] biçiminde dört sayıdan oluşan bir dizi.
Required	required	boolean	Katılımcının bu alanı tamamlaması gerekip gerekmediğini gösterir.
Alan Türü	type	string	Alan türü.
Format	format	string	Uygun olduğunda alan biçimi.
Değiştirilebilir	modifiable	boolean	Alan değerinin, uygun olduğunda değiştirilebilir olup olmadığını gösterir.

KatılımcılarResponse

Bir veya daha fazla katılımcı oluşturulduktan sonra yanıt döndürüldü.

Name	Yol	Tür	Description
Participants	items	array of ParticipantResponse	Bu istekte oluşturulan katılımcılar.

ParticipantsListResponse

Nitro İşareti zarfı ile ilişkili katılımcılar listelenirken yanıt döndürüldü.

Name	Yol	Tür	Description
Participants	items	array of ParticipantResponse	Zarfla ilişkili katılımcılar.
Toplam Katılımcı Sayısı	total	integer	Koleksiyonda bulunan toplam katılımcı sayısı.

ParticipantResponse

Nitro Sign katılımcı ayrıntıları.

Name	Yol	Tür	Description
Katılımcı Kimliği	ID	uuid	Katılımcıyı tanımlayan benzersiz bir UUID.
E-posta	email	email	Katılımcının e-posta adresi.
Rolü	role	string	Katılımcının rolü.
authentication	authentication	ParticipantAuthenticationResponse	Bir katılımcı için döndürülen kimlik doğrulama ayarları.

ParticipantAuthenticationResponse

Bir katılımcı için döndürülen kimlik doğrulama ayarları.

Name	Yol	Tür	Description
Kimlik Doğrulaması Türü	type	string	Katılımcı kimlik doğrulama türü.
Erişim Kodu	accessCode	string	Katılımcı için yapılandırılan erişim kodu.

FileDownloadResponse

İndirilen dosya JSON zarfı olarak sarmalanmış.

Name	Yol	Tür	Description
Dosya Adı	fileName	string	content-Disposition yanıt üst bilgisinden türetilen indirilen dosyanın adı (örneğin, result.zip veya result.pdf). Bu belirteci doğrudan OneDrive veya SharePoint Dosya Oluştur gibi bir aşağı akış eyleminin Dosya Adı girişine bırakın.
Dosya İçerik Türü	fileContentType	string	İndirilen dosyanın MIME türü, örneğin application/zip veya application/pdf.
Dosya İçeriği	fileContent	byte	base64 ile kodlanmış dosya içeriği. Bu belirteci doğrudan aşağı akış eyleminin Dosya İçeriği girişine (örneğin OneDrive veya SharePoint Dosya Oluştur veya başka bir Nitro eylemi) bırakın; ifade gerekmez.