Nitro Sign (előzetes verzió)

A Nitro Sign API biztonságos, végpontok közötti eSignature-munkafolyamatokat tesz lehetővé azáltal, hogy lehetővé teszi az alkalmazások számára a digitális aláírási folyamatok létrehozását, kezelését és nyomon követését. Képes borítékok létrehozására, dokumentumok feltöltésére, résztvevők hozzáadására, aláírási sorrend meghatározására és dokumentumok aláírásra való küldésére teljesen automatizált, API-alapú megközelítéssel.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate régió kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket: - Azure Government régiók - Azure Kína régiói - Amerikai Védelmi Minisztérium (DoD)
Power Apps	prémium	Az összes Power Apps régió kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate régió kivéve a következőket: - USA kormánya (GCC) - Amerikai kormány (GCC High) - A 21Vianet által üzemeltetett China Cloud - Amerikai Védelmi Minisztérium (DoD)

Contact
Név	Nitro-támogatás
URL	https://www.gonitro.com/support
Email	prosupport@sfdc.gonitro.com

Összekötő metaadatai
Publisher	Nitro PDF
Webhely	https://www.gonitro.com/
Adatvédelmi irányelvek	https://www.gonitro.com/legal/privacy-policy
Categories	Termelékenység; Informatikai műveletek

Nitro Sign Connector

Áttekintés

A Nitro Sign-összekötő biztonságos, végpontok közötti eSignature-munkafolyamatokat tesz lehetővé közvetlenül Power Automate és Power Apps. Lehetővé teszi, hogy az alkalmazások aláírási borítékokat hozzanak létre és kezeljenek, dokumentumokat töltsenek fel és rendezhessenek át, résztvevőket adhatnak hozzá, aláírási sorrendet határozhatnak meg, aláírási és adatmezőket helyezhetnek el, dokumentumokat küldhetnek aláírásra, nyomon követhetik az előrehaladást, és letölthetik az eredeti, lezárt és naplózási nyomkövetési fájlokat – mindezt teljesen automatizált, API-alapú megközelítéssel.

Publisher: Nitro Software

Prerequisites

A Nitro Sign ezen az összekötőn keresztül történő használatához a következőkre lesz szüksége:

Nitro-fiók, amelyen engedélyezve van a Nitro Sign
https://developers.gonitro.com/
Egyéni összekötő képességekkel rendelkező Microsoft PowerApps vagy Power Automate csomag.

Authentication

A Nitro Sign gépről gépre OAuth 2.0-t használ az ügyfél hitelesítő adataival , hogy hozzáférési jogkivonatokat hozzon létre AZ API-kérésekhez.

Hogyan működik?

Létrehoz egy API-alkalmazást a Nitro önkiszolgáló portálján, és lekérte a társított ügyfélazonosítót és ügyfélkulcsot.
Az összekötő úgy hitelesít, hogy kicseréli ezeket a hitelesítő adatokat egy Tulajdonos hozzáférési jogkivonatra.
A jogkivonat ezután a Nitro Sign API-hívások engedélyezésére szolgál.

Hitelesítő adatok létrehozása & olvassa el a részletes útmutatót:
https://developers.gonitro.com/docs/authentication/credentials

Kapcsolat létrehozása Power Automate/Power Apps

Amikor hozzáadja az összekötőt egy folyamathoz vagy alkalmazáshoz:

Kattintson az Új kapcsolat hozzáadása elemre.
Adja meg az ügyfélazonosítót és az ügyfél titkos kódját (a Nitro fejlesztői portálján).
Válassza ki Nitro-régióját (Európa, Egyesült Államok vagy APAC) – a Nitro-fiókjához társított régiót.
Mentse a kapcsolatot – első használatkor az összekötő kicseréli az ügyfél-azonosítót és az ügyfél titkos kódját egy rövid élettartamú hozzáférési jogkivonatra az OAuth 2.0 ügyfél hitelesítő adatainak megadásakor, gyorsítótárazva és automatikusan megújítva. A hitelesítő adatok csak a jogkivonat beszerzésére szolgálnak; az ezt követő API-hívásokat egy tulajdonosi jogkivonat hitelesíti az Ön nevében.

Megjegyzés: Nincs szükség felhasználói interaktív bejelentkezésre; ez a folyamat kiszolgálóról kiszolgálóra/ alkalmazásról alkalmazásra forgatókönyvekhez lett kialakítva.

Támogatott műveletek

Az összekötő az aláírási munkafolyamat négy erőforrása – borítékok, dokumentumok, mezők és résztvevők – köré csoportosítja a műveleteket, valamint a kész fájlok lekérésére szolgáló letöltési műveletek készletét.

1. Borítékok

A boríték egy aláírási kérelem dokumentumainak, résztvevőinek és mezőinek tárolója.

Borítékok listázása
Az alkalmazáshoz tartozó összes borítékot adja vissza a fiókban. Az eredmények lapszámozottak: a válasz tartalmaz egy Következő oldal kurzor jogkivonatot, amelyet az opcionális Page After paraméternek adhat meg a következő oldal (vagy a Lap előtt lap hátrafelé) lekéréséhez. Mindkét kurzorparaméter a Speciális területen található, és csak nagy eredményhalmazok használata esetén szükséges.
Boríték létrehozása
Létrehoz egy új borítékot névvel, értesítési üzenettel (tárgy + törzs, dinamikus változókkal, például $(sender_name_or_email) és $(envelope_name)), és aláírási móddal:
- parallel – minden résztvevőt egyidejűleg értesítünk, és egymástól függetlenül tudnak aláírni.
- sequential – a résztvevőket egyenként, a hozzáadásuk sorrendjében értesítik.
Boríték lekérése azonosító szerint
Lekéri egy adott boríték részleteit az UUID alapján.
Boríték frissítése
Frissíti a boríték nevét, az értesítési beállításokat és/vagy az aláírási módot. Az összes mező megadása nem kötelező.
Boríték törlése azonosító szerint
Véglegesen törli a borítékot és az összes kapcsolódó dokumentumot, mezőt és résztvevőt. Ezt nem lehet visszavonni.
Boríték küldése aláíráshoz
Elküldi a borítékot a résztvevőknek aláírásgyűjtés céljából. A küldés előtt a borítéknak általában hozzá kell adni a dokumentumait, a résztvevőket és az aláírási mezőket ( a Dokumentum létrehozása borítékazonosító alapján, Résztvevő(k) létrehozása borítékazonosító alapján, valamint Mező(ek) létrehozása dokumentumazonosító alapján). A borítékban lévő összes dokumentumnak feltöltött állapotúnak kell lennie a boríték elküldése előtt.
Emlékeztetők küldése borítékhoz
Emlékeztető értesítések aktiválása függőben lévő résztvevőknek. Ha nincsenek megadva értesítési beállítások, a rendszer a borítékhoz konfigurált alapértelmezett értesítési sablont használja.
Boríték lemondása azonosító szerint
Megszakítja az aláírási kérelmet. Csak az aláírásra már elküldött borítékok törölhetők.

2. Dokumentumok

A dokumentumok a borítékhoz csatolt és a résztvevők által aláírt fájlok.

Dokumentumok listázása borítékazonosító szerint
Lekéri a borítékhoz társított összes dokumentumot.
Dokumentum létrehozása borítékazonosító alapján
Dokumentum feltöltése meglévő borítékba. Adja meg a fájlt egyszerű, beírt mezőkkel – nincs kézzel írt JSON:
- Dokumentumfájl – a feltöltendő fájl.
- Dokumentum neve – a dokumentum tárolására használt név.
- Tartalomtípus (speciális, nem kötelező) – a fájl MIME-típusa; alapértelmezett érték: .> Ha nincs megadva, a rendszer csak PDF-fájlokat fogad el.
Dokumentum lekérése azonosító alapján
Egy adott dokumentum adatait kéri le egy borítékban.
Dokumentum frissítése azonosító szerint
Frissíti a dokumentum metaadatait. Jelenleg csak a dokumentum neve módosítható.
Dokumentum törlése azonosító szerint
Véglegesen töröl egy dokumentumot egy borítékból.
Dokumentumok átrendezés borítékazonosító szerint
A dokumentumok egy borítékban való átrendezése a dokumentumazonosítók megadott listája alapján.

3. Mezők

A mezők a dokumentumon elhelyezett és egy résztvevőhöz rendelt interaktív elemek (aláírás, monogramok, dátum stb.).

Mezők listázása dokumentumazonosító szerint
Lekéri az adott dokumentumhoz társított összes mezőt.
Mező(ek) létrehozása dokumentumazonosító szerint
Létrehoz egy vagy több mezőt egy dokumentumon, és hozzárendeli őket a résztvevőkhöz. Adjon meg egy elemet egyetlen mezőhöz, vagy több elemet egy tömeges kérelemhez. Minden mező a következőt adja meg:
- participantID – a mezőhöz rendelt résztvevő.
- type— az egyik signature, initials, name, date, title, company, . customcheckbox
- page — az oldalszám (1-alapú indexelés).
- X Pozíció, Y pozíció, Szélesség, Magasság – a mező pozíciója és mérete, amelyek mindegyike külön számként van megadva a pontokban (az X/Y az oldal bal/felső szélétől mérve). Ezek lecserélik az előző egyetlen boundingBox tömböt, így minden érték egy gépelt mező a felhasználói felületen, nem pedig egy kézzel összeállított lista.
- Nem kötelező: required (alapértelmezett true), és – a Speciális területen – format (például MM/DD/YYYY dátummezők esetén) és modifiable.
Mező frissítése azonosító szerint
Meglévő mező tulajdonságainak frissítése. A mezőt type meg kell adni, és meg kell egyeznie a meglévő mezőtípussal – a mezőséma azonosítására szolgál, és nem módosítja a mezőtípust.
Mező törlése azonosító szerint
Véglegesen töröl egy mezőt egy dokumentumból.

4. Résztvevők

A résztvevők azok, akik megkapják a borítékot – vagy aláírják, vagy folyamatosan tájékoztatják őket.

Résztvevők listázása borítékazonosító szerint
Lekéri a borítékhoz társított összes résztvevőt.
Résztvevő(k) létrehozása borítékazonosító szerint
Egy vagy több résztvevőt ad hozzá egy borítékhoz. Adjon meg egy elemet egyetlen résztvevőnek, vagy több elemet egy tömeges kéréshez. Minden résztvevő a következőt adja meg:
- email – a résztvevő e-mail-címe.
- role — signer (rendelkezhet aláíráshoz hozzárendelt mezőkkel) vagy cc (írásvédett hozzáféréssel).
- authentication (speciális, nem kötelező) – jelenleg hozzáférési kód: a résztvevőnek az aláírás előtt meg kell adnia egy statikus hozzáférési kódot. Ezt a szakaszt csak akkor nyissa meg, ha a résztvevőnek hitelesítenie kell magát az aláírás előtt.
Résztvevő frissítése azonosító szerint
Frissíti a résztvevők hitelesítési beállításait. A résztvevő e-mail-címe nem módosítható.
Résztvevő törlése azonosító szerint
Véglegesen törli a résztvevőket egy borítékból.

5. Letöltések

A dokumentumok aláírása és lezárása után kérje le a kész fájlokat.

Eredeti boríték letöltése
Letölti az eredeti aláíratlan dokumentumokat egy borítékból ZIP-archívumként .
Lezárt boríték letöltése
Zip-archívumként letölti a lezárt aláírt dokumentumokat, valamint az auditnaplót.
Lezárt dokumentum letöltése azonosító szerint
Egyetlen lezárt aláírt dokumentumot tölt le PDF-fájlként .
Boríték auditnaplójának letöltése
Letölti a boríték teljes ellenőrzési nyomvonalát PDF-fájlként .

A letöltési műveletek elérhetővé teszik a picker-natív fájlnevet és a fájltartalom-jogkivonatokat (valamint a fájltartalom típusát). A fájltartalmat közvetlenül egy alsóbb rétegbeli lépés ( például OneDrive/ SharePoint Fájl létrehozása ) fájlbemenetébe és fájlnévbe csepegtetheti. Nincs body('Action_Name') szükség kifejezésre vagy manuálisan beírt fájlnévre; az összekötő egy JSON-borítékba burkolja a letöltött ZIP-t vagy PDF-fájlt, hogy Power Automate ezeket szokásos dinamikus tartalom jogkivonatként jeleníthesse meg.

Tipikus aláírási munkafolyamat

A teljes aláírási folyamat sorrendbe rendezi a fenti műveleteket. Egy gyakori Power Automate folyamat a következőképpen néz ki:

Boríték létrehozása – adja meg a nevet, az értesítés tárgyát/törzsét és az aláírási módot (parallel vagy sequential). Mentse a visszaadott borítékazonosítót.
Dokumentum létrehozása borítékazonosító szerint – töltsön fel egy vagy több fájlt a borítékba (az 1. lépés borítékazonosítójával). Mentse az összes visszaadott dokumentumazonosítót.
(Nem kötelező)Dokumentumok átrendezése borítékazonosító szerint – állítsa be a dokumentum sorrendjét.
Résztvevők létrehozása borítékazonosító alapján – adja hozzá az aláírókat és a másolatot kapó címzetteket a hozzáférési kód hitelesítésével. Mentse az egyes visszaadott résztvevők azonosítóját.
Mező(k) létrehozása dokumentumazonosító szerint – aláírás/dátum/stb. mezőket helyezhet el minden dokumentumon, és hozzárendelheti őket a résztvevőkhöz (a 2. lépés dokumentumazonosítójával és a 3. lépésben szereplő résztvevőazonosítóval).
Boríték küldése aláírásra – küldje el a borítékot. Először minden dokumentumnak a feltöltött állapotban kell lennie.
(Amíg függőben van)Emlékeztető küldése a borítékhoz a résztvevők elmozdításához, vagy a Boríték törlése azonosító alapján a kérés leállításához.
(Ha elkészült)Töltse le a lezárt borítékot / , töltse le a lezárt dokumentumot azonosító / alapján, töltse le a boríték ellenőrzési nyomvonalát a kész fájlok lekéréséhez.

Tipp: A létrehozási műveletek által visszaadott borítékazonosító, dokumentumazonosító és résztvevőazonosító természetesen Power Automate dinamikus tartalomválasztóján keresztül áramlik a későbbi műveletekbe – a beírás helyett válassza ki az azonosító jogkivonatot a felsőbb rétegbeli műveletből.

Hibák > Szabályozás

A Nitro Sign API a következő hibákat eredményezheti:

400 – Hibás kérelem
401 – Jogosulatlan
404 – Nem található
409 – Ütközés (pl. olyan borítékon való működés, amely nem teszi lehetővé a műveletet)
413 – Túl nagy tartalom
415 – Nem támogatott médiatípus
422 – Feldolgozhatatlan entitás
500 – Belső kiszolgálóhiba

Throttling

API-hívások kapcsolatonként: 100 / 60 másodperc.

Platformkorlátok

Fájlméret

Maximum: 25 MB kérésenként
Az egy- és többfájlos műveletekre egyaránt vonatkozik.

Oldalszám

Maximum: 250 oldal/ dokumentum
Több dokumentum összes egyesített lapja meghaladhatja a 250-et.

Megőrzési idő

A bemeneti és kimeneti fájlok a művelet befejezése után ~15 perccel törlődnek.

Jegyzetek

A boríték-, dokumentum-, mező- és résztvevőkezelési műveletek JSON-t adnak vissza.
A letöltési műveletek egy JSON-borítékba burkolt fájlt (ZIP vagy PDF) adnak vissza, amely kiválasztó-natív jogkivonatként adja vissza a fájlnevet, a fájltartalom típusát és a fájltartalmat , így az eredmények kifejezés nélkül láncolhatók egy alsóbb rétegbeli fájlműveletbe.
Az aláírási mód (parallel vs sequential. ) a boríték létrehozásakor van beállítva, és a boríték elküldése előtt módosítható a Boríték frissítése funkcióval.
A résztvevők hitelesítése jelenleg csak az Access Code-ot támogatja.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:


Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Required
Nitro-ügyfélazonosító	securestring	A Nitro-alkalmazás ügyfélazonosítója	True
Nitro-ügyfél titkos kódja	securestring	A Nitro-alkalmazás ügyfélkódja	True
Nitro régió	karakterlánc	Válassza ki a Fiókjához tartozó Nitro API-régiót.	True

Műveletek

Boríték auditnaplójának letöltése	Letölti a kijelölt Nitro Sign boríték teljes ellenőrzési nyomvonalát tartalmazó PDF-fájlt.
Boríték frissítése	Frissíti a meglévő Nitro Sign borítékot. Módosíthatja a boríték nevét, az értesítési beállításokat, az aláírási módot vagy a mezők bármely kombinációját.
Boríték küldése aláíráshoz	Nitro-aláírás borítékot küld a résztvevőknek aláírásgyűjtés céljából. A művelet használata előtt a borítéknak általában dokumentumokat, résztvevőket és aláírási mezőket kell hozzáadnia a Dokumentum létrehozása borítékazonosító alapján, a Résztvevők létrehozása borítékazonosító alapján, valamint a Mező(ek) létrehozása dokumentumazonosító alapján használatával. A borítékban lévő összes dokumentumnak feltöltött állapotúnak kell lennie a boríték elküldése előtt.
Boríték lekérése azonosító szerint	Egy adott Nitro Sign-boríték részleteit kéri le egyedi borítékazonosítójával.
Boríték lemondása azonosító szerint	Megszakítja a Nitro Sign-borítékra vonatkozó aláírási kérelmet. Csak az aláírásra küldött borítékok törölhetők.
Boríték létrehozása	Létrehoz egy új Nitro Sign-borítékot, amely később kitölthető dokumentumokkal, résztvevőkkel, mezőkkel, és elküldhető aláírásra.
Boríték törlése azonosító szerint	Véglegesen törli a Nitro Sign borítékot. Ez a művelet nem vonható vissza, és az összes kapcsolódó dokumentum, mező és résztvevő is törlődik.
Borítékok listázása	A Borítékok listázása végpont egy fiókban lévő alkalmazáshoz társított összes borítékot adja vissza.
Dokumentum frissítése azonosító szerint	Frissíti egy meglévő dokumentum metaadatait egy Nitro Sign-borítékon belül. Jelenleg csak a dokumentum neve frissíthető.
Dokumentum lekérése azonosító alapján	Lekéri egy adott dokumentum részleteit egy Nitro Sign-borítékban.
Dokumentum létrehozása borítékazonosító alapján	Feltölt egy dokumentumot egy meglévő Nitro Sign-borítékba. A dokumentum később használható az aláírási munkafolyamatban.
Dokumentum törlése azonosító szerint	Véglegesen töröl egy dokumentumot egy Nitro Sign-borítékból.
Dokumentumok listázása borítékazonosító szerint	Lekéri az adott Nitro Sign-borítékhoz társított összes dokumentumot.
Dokumentumok átrendezés borítékazonosító szerint	Az adott Nitro Sign-borítékhoz társított dokumentumokat átrendezi a dokumentumazonosítók megadott listája alapján.
Emlékeztetők küldése borítékhoz	Emlékeztető értesítéseket aktivál egy megadott Nitro Sign-boríték függőben lévő résztvevőinek. Ha nincsenek megadva értesítési beállítások, a rendszer a borítékhoz konfigurált alapértelmezett értesítési sablont használja.
Eredeti boríték letöltése	Letölti az eredeti aláíratlan dokumentumokat egy Nitro Sign borítékból ZIP-archívumként.
Lezárt boríték letöltése	Letölti a lezárt aláírt dokumentumokat egy Nitro Sign borítékból, valamint az audit nyomvonalról, ZIP archívumként.
Lezárt dokumentum letöltése azonosító szerint	Letölt egy lezárt aláírt dokumentumot egy Nitro Sign-borítékból PDF-fájlként.
Mező(ek) létrehozása dokumentumazonosító szerint	Létrehoz egy vagy több mezőt egy dokumentumon, és hozzárendeli őket a résztvevőkhöz. Egyetlen mező létrehozásához adjon meg egy elemet a Mezők tömbben. Több mező létrehozásához adjon meg több elemet.
Mező frissítése azonosító szerint	Frissíti a Nitro Sign-dokumentumok meglévő mezőinek tulajdonságait. A mezőtípust meg kell adni, és meg kell egyeznie a meglévő mezőtípussal; az API a mezőséma azonosítására használja, és nem módosítja a mezőtípust.
Mező törlése azonosító szerint	Véglegesen töröl egy mezőt egy dokumentumból egy Nitro Sign-borítékon belül.
Mezők listázása dokumentumazonosító szerint	Lekéri az adott dokumentumhoz tartozó összes mezőt egy Nitro Sign-borítékon belül.
Résztvevő(k) létrehozása borítékazonosító szerint	Hozzáad egy vagy több résztvevőt egy Nitro Sign-borítékhoz. Egyetlen résztvevő hozzáadásához adjon meg egy elemet a Résztvevők tömbben. Több résztvevő hozzáadásához adjon meg több elemet.
Résztvevő frissítése azonosító szerint	Frissíti a Nitro Sign-borítékban lévő résztvevők hitelesítési beállításait. A résztvevő e-mail-címe nem frissíthető.
Résztvevő törlése azonosító szerint	Véglegesen törli a résztvevőket egy Nitro Sign-borítékból.
Résztvevők listázása borítékazonosító szerint	Lekéri az adott Nitro Sign-borítékhoz társított összes résztvevőt.

Boríték auditnaplójának letöltése

Műveletazonosító:: DownloadAuditTrailOfEnvelope

Letölti a kijelölt Nitro Sign boríték teljes ellenőrzési nyomvonalát tartalmazó PDF-fájlt.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek az auditnaplóját le kell tölteni.

Válaszok

A letöltött fájl JSON-borítékként van becsomagolva.

Törzs: FileDownloadResponse

Boríték frissítése

Műveletazonosító:: UpdateEnvelope

Frissíti a meglévő Nitro Sign borítékot. Módosíthatja a boríték nevét, az értesítési beállításokat, az aláírási módot vagy a mezők bármely kombinációját.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a frissíteni kívánt borítékot.
Boríték neve	name		string	A frissített boríték neve. Nem kell egyedinek lennie.
Értesítés tárgya	subject		string	Az aláíró résztvevőknek küldött e-mail-értesítés tárgysora. A dinamikus változók támogatottak, például: $(sender_name_or_email) kéri az aláírást.
Értesítési törzs	body		string	Az aláíró résztvevőknek küldött e-mail törzs. A dinamikus változók támogatottak, például: Szia,\nÍrja alá a $(envelope_name)\nKöszönöm,\n$(sender_name_or_email).
Aláírási mód	mode		string	Meghatározza az aláírási sorrendet. A párhuzamos alkalmazással az összes résztvevőt egyidejűleg értesítheti, vagy egymást követő módon egyenként értesítheti a résztvevőket a hozzáadásuk sorrendjében.

Válaszok

A Nitro Sign boríték kérése vagy létrehozása után visszaadott válasz.

Törzs: EnvelopeResponse

Boríték küldése aláíráshoz

Műveletazonosító:: SendEnvelopeForSigning

Nitro-aláírás borítékot küld a résztvevőknek aláírásgyűjtés céljából. A művelet használata előtt a borítéknak általában dokumentumokat, résztvevőket és aláírási mezőket kell hozzáadnia a Dokumentum létrehozása borítékazonosító alapján, a Résztvevők létrehozása borítékazonosító alapján, valamint a Mező(ek) létrehozása dokumentumazonosító alapján használatával. A borítékban lévő összes dokumentumnak feltöltött állapotúnak kell lennie a boríték elküldése előtt.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egy egyedi UUID, amely azonosítja az aláírásra küldendő borítékot.

Válaszok

A Nitro Sign borítékra vonatkozó összefoglaló információk.

Törzs: EnvelopeSummaryResponse

Boríték lekérése azonosító szerint

Műveletazonosító:: GetEnvelopeByID

Egy adott Nitro Sign-boríték részleteit kéri le egyedi borítékazonosítójával.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a lekérni kívánt borítékot.

Válaszok

A Nitro Sign boríték kérése vagy létrehozása után visszaadott válasz.

Törzs: EnvelopeResponse

Boríték lemondása azonosító szerint

Műveletazonosító:: CancelEnvelopeByID

Megszakítja a Nitro Sign-borítékra vonatkozó aláírási kérelmet. Csak az aláírásra küldött borítékok törölhetők.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egy egyedi UUID, amely azonosítja a visszavonni kívánt borítékot.

Válaszok

A Nitro Sign boríték kérése vagy létrehozása után visszaadott válasz.

Törzs: EnvelopeResponse

Boríték létrehozása

Műveletazonosító:: CreateEnvelope

Létrehoz egy új Nitro Sign-borítékot, amely később kitölthető dokumentumokkal, résztvevőkkel, mezőkkel, és elküldhető aláírásra.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték neve	name	True	string	A boríték neve. Nem kell egyedinek lennie.
Aláírási mód	mode	True	string	Meghatározza az aláírási sorrendet. A párhuzamos alkalmazással az összes résztvevőt egyidejűleg értesítheti, vagy egymást követő módon egyenként értesítheti a résztvevőket a hozzáadásuk sorrendjében.
Értesítés tárgya	subject	True	string	Az aláíró résztvevőknek küldött e-mail-értesítés tárgysora. A dinamikus változók támogatottak, például: $(sender_name_or_email) kéri az aláírást.
Értesítési törzs	body	True	string	Az aláíró résztvevőknek küldött e-mail törzs. A dinamikus változók támogatottak, például: Szia,\nÍrja alá a $(envelope_name)\nKöszönöm,\n$(sender_name_or_email).

Válaszok

A Nitro Sign boríték kérése vagy létrehozása után visszaadott válasz.

Törzs: EnvelopeResponse

Boríték törlése azonosító szerint

Műveletazonosító:: DeleteEnvelopeByID

Véglegesen törli a Nitro Sign borítékot. Ez a művelet nem vonható vissza, és az összes kapcsolódó dokumentum, mező és résztvevő is törlődik.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a törölni kívánt borítékot.

Borítékok listázása

Műveletazonosító:: ListEnvelopes

A Borítékok listázása végpont egy fiókban lévő alkalmazáshoz társított összes borítékot adja vissza.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal utána	pageAfter		string	A borítékok következő oldalának lekéréséhez nem kötelező kurzor jogkivonatot használni. Használja az előző válasz által visszaadott nextPage értéket.
Lap előtt	pageBefore		string	A borítékok előző oldalának lekéréséhez használható nem kötelező kurzor jogkivonata. Ne használja együtt a Page After parancsot.

Válaszok

Name	Elérési út	Típus	Description
Borítékok	items	array of EnvelopeSummaryResponse	A borítékok listája.
Következő oldal	nextPage	string	A borítékok következő oldalának lekéréséhez használható kurzor jogkivonata.

Dokumentum frissítése azonosító szerint

Műveletazonosító:: UpdateDocumentByID

Frissíti egy meglévő dokumentum metaadatait egy Nitro Sign-borítékon belül. Jelenleg csak a dokumentum neve frissíthető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja a frissíteni kívánt dokumentumot.
Dokumentum neve	name	True	string	A dokumentum új neve.

Válaszok

Nitro Sign-dokumentum részletei.

Törzs: DocumentResponse

Dokumentum lekérése azonosító alapján

Műveletazonosító:: GetDocumentByID

Lekéri egy adott dokumentum részleteit egy Nitro Sign-borítékban.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja a lekérni kívánt dokumentumot.

Válaszok

Nitro Sign-dokumentum részletei.

Törzs: DocumentResponse

Dokumentum létrehozása borítékazonosító alapján

Műveletazonosító:: CreateDocumentByEnvelopeID

Feltölt egy dokumentumot egy meglévő Nitro Sign-borítékba. A dokumentum később használható az aláírási munkafolyamatban.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egy egyedi UUID, amely azonosítja azt a borítékot, amelyben a dokumentum fel lesz töltve.
Dokumentum neve	documentName	True	string	A feltölteni kívánt dokumentum neve. Ez az érték a Nitronak küldött dokumentum metaadatainak összeállítására szolgál.
Tartalomtípus	contentType		string	A feltöltött dokumentum tartalomtípusa. PDF-fájlok esetén használja az alkalmazást/pdf-et. Ha nincs megadva a metaadatokból, a rendszer csak PDF-fájlokat fogad el.
Dokumentumfájl	payload	True	file	A borítékba feltölteni kívánt dokumentumfájl.

Válaszok

Name	Elérési út	Típus	Description
Dokumentumazonosító	ID	uuid	Egy egyedi UUID, amely azonosítja a feltöltött dokumentumot.
Dokumentum neve	name	string	A feltöltött dokumentum neve.
Létrehozás dátuma:	createdAt	string	A dokumentum létrehozásának idejét jelző időbélyeg.
Dokumentum állapota	status	string	A feltöltött dokumentum feldolgozási állapota.

Dokumentum törlése azonosító szerint

Műveletazonosító:: DeleteDocumentByID

Véglegesen töröl egy dokumentumot egy Nitro Sign-borítékból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egyedi UUID, amely azonosítja a törölni kívánt dokumentumot.

Dokumentumok listázása borítékazonosító szerint

Műveletazonosító:: ListDocumentsByEnvelopeID

Lekéri az adott Nitro Sign-borítékhoz társított összes dokumentumot.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek dokumentumait le kell kérni.

Válaszok

A Nitro Sign-borítékhoz társított dokumentumok listázásakor visszaadott válasz.

Törzs: ListDocumentsByEnvelopeIDResponse

Dokumentumok átrendezés borítékazonosító szerint

Műveletazonosító:: ReorderDocumentsByEnvelopeID

Az adott Nitro Sign-borítékhoz társított dokumentumokat átrendezi a dokumentumazonosítók megadott listája alapján.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek dokumentumait át kell rendezni.
Dokumentumazonosítók	order	True	array of uuid	Dokumentumazonosítók tömbje, amelyek a borítékon belüli dokumentumok új sorrendjét jelölik.

Válaszok

A Nitro Sign-borítékhoz társított dokumentumok listázásakor visszaadott válasz.

Törzs: ListDocumentsByEnvelopeIDResponse

Emlékeztetők küldése borítékhoz

Műveletazonosító:: SendRemindersForEnvelope

Emlékeztető értesítéseket aktivál egy megadott Nitro Sign-boríték függőben lévő résztvevőinek. Ha nincsenek megadva értesítési beállítások, a rendszer a borítékhoz konfigurált alapértelmezett értesítési sablont használja.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelyre emlékeztető értesítéseket kell küldeni.
Értesítés tárgya	subject		string	Az aláíró résztvevőknek küldött e-mail-értesítés tárgysora. A dinamikus változók támogatottak, például: $(sender_name_or_email) kéri az aláírást.
Értesítési törzs	body		string	Az aláíró résztvevőknek küldött e-mail törzs. A dinamikus változók támogatottak, például: Szia,\nÍrja alá a $(envelope_name)\nKöszönöm,\n$(sender_name_or_email).

Eredeti boríték letöltése

Műveletazonosító:: DownloadOriginalEnvelope

Letölti az eredeti aláíratlan dokumentumokat egy Nitro Sign borítékból ZIP-archívumként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek eredeti dokumentumait le kell tölteni.

Válaszok

A letöltött fájl JSON-borítékként van becsomagolva.

Törzs: FileDownloadResponse

Lezárt boríték letöltése

Műveletazonosító:: DownloadSealedEnvelope

Letölti a lezárt aláírt dokumentumokat egy Nitro Sign borítékból, valamint az audit nyomvonalról, ZIP archívumként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek lezárt dokumentumait le kell tölteni.

Válaszok

A letöltött fájl JSON-borítékként van becsomagolva.

Törzs: FileDownloadResponse

Lezárt dokumentum letöltése azonosító szerint

Műveletazonosító:: DownloadSealedDocumentByID

Letölt egy lezárt aláírt dokumentumot egy Nitro Sign-borítékból PDF-fájlként.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a lezárt dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja a letöltendő lezárt dokumentumot.

Válaszok

A letöltött fájl JSON-borítékként van becsomagolva.

Törzs: FileDownloadResponse

Mező(ek) létrehozása dokumentumazonosító szerint

Műveletazonosító:: CreateFieldsByDocumentID

Létrehoz egy vagy több mezőt egy dokumentumon, és hozzárendeli őket a résztvevőkhöz. Egyetlen mező létrehozásához adjon meg egy elemet a Mezők tömbben. Több mező létrehozásához adjon meg több elemet.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egy egyedi UUID, amely azonosítja a borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja azt a dokumentumot, amelyben mezőket kell létrehozni.
Résztvevő azonosítója	participantID	True	uuid	A mezőhöz rendelt résztvevő egyedi azonosítója.
Oldal	page	True	integer	Az oldalszám, ahová a mezőt el kell helyezni. A lapok 1-alapú indexelést használnak, így az első oldal 1.
Mezőtípus	type	True	string	A létrehozandó mező típusa.
X pozíció	x	True	float	A mező vízszintes pozíciója, a pontban lévő oldal bal szélétől mérve.
Y pozíció	y	True	float	A mező függőleges pozíciója, a pontban lévő oldal felső szélétől mérve.
Szélesség	width	True	float	A mező szélessége a pontokban.
Magasság	height	True	float	A mező magassága pontokban.
Required	required		boolean	Azt jelzi, hogy a résztvevőnek végre kell-e hajtania ezt a mezőt.
Format	format		string	Nem kötelező formátum a formázást támogató mezőtípusokhoz, például dátummezőkhöz. Példa: MM/DD/ÉÉÉÉ.
Módosítható	modifiable		boolean	Azt jelzi, hogy a mező értékét módosíthatja-e a résztvevő, ahol a mezőtípus támogatja.

Válaszok

Egy vagy több mező létrehozása után visszaadott válasz.

Törzs: FieldsResponse

Mező frissítése azonosító szerint

Műveletazonosító:: UpdateFieldByID

Frissíti a Nitro Sign-dokumentumok meglévő mezőinek tulajdonságait. A mezőtípust meg kell adni, és meg kell egyeznie a meglévő mezőtípussal; az API a mezőséma azonosítására használja, és nem módosítja a mezőtípust.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja a mezőt tartalmazó dokumentumot.
Mezőazonosító	fieldID	True	uuid	Egy egyedi UUID, amely azonosítja a frissíteni kívánt mezőt.
Mezőtípus	type	True	string	A frissítendő mező aktuális típusa. Ezt az értéket az API megköveteli, és meg kell egyeznie a meglévő mezőtípussal; nem módosítja a mezőtípust.
Résztvevő azonosítója	participantID		uuid	A mezőhöz rendelt résztvevő egyedi azonosítója.
Oldal	page		integer	Az oldalszám, ahol a mező megjelenik. A lapok 1-alapú indexelést használnak.
X pozíció	x		float	Optional. A mező vízszintes pozíciója, a pontban lévő oldal bal szélétől mérve.
Y pozíció	y		float	Optional. A mező függőleges pozíciója, a pontban lévő oldal felső szélétől mérve.
Szélesség	width		float	Optional. A mező szélessége a pontokban.
Magasság	height		float	Optional. A mező magassága pontokban.
Required	required		boolean	Azt jelzi, hogy a résztvevőnek végre kell-e hajtania ezt a mezőt.
Format	format		string	Adott esetben a mező formátuma. A dátummezők például az MM/DD/YYYY formátumot használhatják.
Módosítható	modifiable		boolean	Azt jelzi, hogy a mező értéke módosítható-e, ha van ilyen.

Válaszok

Nitro Sign mező részletei.

Törzs: FieldResponse

Mező törlése azonosító szerint

Műveletazonosító:: DeleteFieldByID

Véglegesen töröl egy mezőt egy dokumentumból egy Nitro Sign-borítékon belül.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egy egyedi UUID, amely azonosítja a mezőt tartalmazó dokumentumot.
Mezőazonosító	fieldID	True	uuid	Egyedi UUID, amely azonosítja a törölni kívánt mezőt.

Mezők listázása dokumentumazonosító szerint

Műveletazonosító:: ListFieldsByDocumentID

Lekéri az adott dokumentumhoz tartozó összes mezőt egy Nitro Sign-borítékon belül.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a dokumentumot tartalmazó borítékot.
Dokumentumazonosító	documentID	True	uuid	Egyedi UUID, amely azonosítja azt a dokumentumot, amelynek a mezőit le kell kérni.

Válaszok

Egy vagy több mező létrehozása után visszaadott válasz.

Törzs: FieldsResponse

Résztvevő(k) létrehozása borítékazonosító szerint

Műveletazonosító:: CreateParticipantsByEnvelopeID

Hozzáad egy vagy több résztvevőt egy Nitro Sign-borítékhoz. Egyetlen résztvevő hozzáadásához adjon meg egy elemet a Résztvevők tömbben. Több résztvevő hozzáadásához adjon meg több elemet.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egy egyedi UUID, amely azonosítja azt a borítékot, amelyben a résztvevőket fel kell venni.
Email	email	True	email	A résztvevő e-mail-címe.
Role	role	True	string	A résztvevő szerepköre. Az aláírókhoz hozzárendelhet mezőket az aláíráshoz. A másolatot kapó résztvevő írásvédett hozzáféréssel rendelkezik.
Hitelesítés típusa	type		string	Optional. Válasszon egy hitelesítési módszert a résztvevő számára. Ha meg van adva, hozzáférési kódot is meg kell adni.
Hozzáférési kód	accessCode		string	Csak hitelesítési típus megadása esetén szükséges. Hagyja üresen, ha nincs szükség résztvevő-hitelesítésre.

Válaszok

Egy vagy több résztvevő létrehozása után visszaadott válasz.

Törzs: ParticipantsResponse

Résztvevő frissítése azonosító szerint

Műveletazonosító:: UpdateParticipantByID

Frissíti a Nitro Sign-borítékban lévő résztvevők hitelesítési beállításait. A résztvevő e-mail-címe nem frissíthető.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a résztvevőt tartalmazó borítékot.
Résztvevő azonosítója	participantID	True	uuid	Egy egyedi UUID, amely azonosítja a frissíteni kívánt résztvevőt.
Hitelesítés típusa	type		string	Optional. Válasszon egy hitelesítési módszert a résztvevő számára. Ha meg van adva, hozzáférési kódot is meg kell adni.
Hozzáférési kód	accessCode		string	Csak hitelesítési típus megadása esetén szükséges. Hagyja üresen, ha nincs szükség résztvevő-hitelesítésre.

Válaszok

Nitro Sign-résztvevő adatai.

Törzs: ParticipantResponse

Résztvevő törlése azonosító szerint

Műveletazonosító:: DeleteParticipantByID

Véglegesen törli a résztvevőket egy Nitro Sign-borítékból.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja a résztvevőt tartalmazó borítékot.
Résztvevő azonosítója	participantID	True	uuid	Egyedi UUID, amely azonosítja a törölni kívánt résztvevőt.

Résztvevők listázása borítékazonosító szerint

Műveletazonosító:: ListParticipantsByEnvelopeID

Lekéri az adott Nitro Sign-borítékhoz társított összes résztvevőt.

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Boríték azonosítója	envelopeID	True	uuid	Egyedi UUID, amely azonosítja azt a borítékot, amelynek a résztvevőit le kell kérni.

Válaszok

A Nitro Sign-borítékhoz társított résztvevők listázásakor visszaadott válasz.

Törzs: ParticipantsListResponse

Definíciók

Borítéknemesítés

A Nitro Sign-boríték értesítési e-mail-beállításai.

Name	Elérési út	Típus	Description
Értesítés tárgya	subject	string	Az aláíró résztvevőknek küldött e-mail-értesítés tárgysora. A dinamikus változók támogatottak, például: $(sender_name_or_email) kéri az aláírást.
Értesítési törzs	body	string	Az aláíró résztvevőknek küldött e-mail törzs. A dinamikus változók támogatottak, például: Szia,\nÍrja alá a $(envelope_name)\nKöszönöm,\n$(sender_name_or_email).

EnvelopeSummaryResponse

A Nitro Sign borítékra vonatkozó összefoglaló információk.

Name	Elérési út	Típus	Description
Boríték azonosítója	ID	uuid	Egy egyedi UUID, amely azonosítja a borítékot.
Létrehozás dátuma:	createdAt	date-time	UTC időbélyeg, amely azt jelzi, hogy mikor jött létre a boríték.
Utolsó módosítás dátuma:	lastModifiedAt	date-time	UTC időbélyeg, amely azt jelzi, hogy mikor módosították utoljára a borítékot.
Boríték neve	name	string	A boríték neve.
Boríték állapota	status	string	A boríték belső állapota.

Borítékresponse

A Nitro Sign boríték kérése vagy létrehozása után visszaadott válasz.

Name	Elérési út	Típus	Description
Boríték azonosítója	ID	uuid	Egy egyedi UUID, amely azonosítja a borítékot.
Létrehozás dátuma:	createdAt	date-time	UTC időbélyeg, amely azt jelzi, hogy mikor jött létre a boríték.
Utolsó módosítás dátuma:	lastModifiedAt	date-time	UTC időbélyeg, amely azt jelzi, hogy mikor módosították utoljára a borítékot.
Boríték neve	name	string	A boríték neve.
Boríték állapota	status	string	A boríték belső állapota.
Aláírási mód	mode	string	A borítékhoz konfigurált aláírási mód.
értesítés	notification	EnvelopeNotification	A Nitro Sign-boríték értesítési e-mail-beállításai.

ListDocumentsByEnvelopeIDResponse

A Nitro Sign-borítékhoz társított dokumentumok listázásakor visszaadott válasz.

Name	Elérési út	Típus	Description
Documents	items	array of DocumentResponse	A borítékhoz társított dokumentumok listája.

DocumentResponse

Nitro Sign-dokumentum részletei.

Name	Elérési út	Típus	Description
Dokumentumazonosító	ID	uuid	Egy egyedi UUID, amely azonosítja a dokumentumot.
Dokumentum neve	name	string	A dokumentum neve.
Létrehozás dátuma:	createdAt	date-time	UTC időbélyeg, amely jelzi a dokumentum létrehozásának idejét.
Méret bájtban	sizeBytes	integer	A dokumentum mérete bájtban.
Oldalak száma	numPages	integer	A dokumentum oldalainak száma.
Dokumentum állapota	status	string	A dokumentum aktuális állapota.

FieldsResponse

Egy vagy több mező létrehozása után visszaadott válasz.

Name	Elérési út	Típus	Description
Fields	items	array of FieldResponse	A kérelemben létrehozott mezők.

FieldResponse

Nitro Sign mező részletei.

Name	Elérési út	Típus	Description
Mezőazonosító	ID	uuid	Egy egyedi UUID, amely azonosítja a mezőt.
Résztvevő azonosítója	participantID	uuid	A mezőhöz rendelt résztvevő egyedi azonosítója.
Dokumentumazonosító	documentID	uuid	Annak a dokumentumnak az egyedi azonosítója, amelyhez a mező tartozik.
Oldal	page	integer	Az oldalszám, ahol a mező megjelenik.
Határolókeret	boundingBox	array of float	Négy számból álló tömb a következő formátumban: [x, y, szélesség, magasság], pontokban mérve.
Required	required	boolean	Azt jelzi, hogy a résztvevőnek végre kell-e hajtania ezt a mezőt.
Mezőtípus	type	string	A mező típusa.
Format	format	string	Adott esetben a mező formátuma.
Módosítható	modifiable	boolean	Azt jelzi, hogy a mező értéke módosítható-e, ha van ilyen.

ParticipantsResponse

Egy vagy több résztvevő létrehozása után visszaadott válasz.

Name	Elérési út	Típus	Description
Participants	items	array of ParticipantResponse	A kérésben létrehozott résztvevők.

ParticipantsListResponse

A Nitro Sign-borítékhoz társított résztvevők listázásakor visszaadott válasz.

Name	Elérési út	Típus	Description
Participants	items	array of ParticipantResponse	A borítékhoz társított résztvevők.
Résztvevők összesen	total	integer	A gyűjteményben elérhető résztvevők teljes száma.

ParticipantResponse

Nitro Sign-résztvevő adatai.

Name	Elérési út	Típus	Description
Résztvevő azonosítója	ID	uuid	Egy egyedi UUID, amely azonosítja a résztvevőt.
Email	email	email	A résztvevő e-mail-címe.
Role	role	string	A résztvevő szerepe.
hitelesítés	authentication	ParticipantAuthenticationResponse	A résztvevőkhöz visszaadott hitelesítési beállítások.

ParticipantAuthenticationResponse

A résztvevőkhöz visszaadott hitelesítési beállítások.

Name	Elérési út	Típus	Description
Hitelesítés típusa	type	string	A résztvevő hitelesítésének típusa.
Hozzáférési kód	accessCode	string	A résztvevőhöz konfigurált hozzáférési kód.

FileDownloadResponse

A letöltött fájl JSON-borítékként van becsomagolva.

Name	Elérési út	Típus	Description
Fájlnév	fileName	string	A letöltött fájl neve, amely a válasz Content-Disposition fejlécéből származik (például result.zip vagy result.pdf). Ezt a jogkivonatot közvetlenül egy alsóbb rétegbeli művelet, például a OneDrive vagy a fájl létrehozása SharePoint Fájlnév bemenetébe csepegtetheti.
Fájltartalom típusa	fileContentType	string	A letöltött fájl MIME-típusa, például alkalmazás/zip vagy alkalmazás/pdf.
Fájl tartalma	fileContent	byte	A base64 kódolású fájltartalom. Ezt a jogkivonatot közvetlenül egy alsóbb rétegbeli művelet fájltartalom-bemenetébe (például OneDrive vagy SharePoint Fájl létrehozása vagy egy másik Nitro-művelet) adhatja meg– nincs szükség kifejezésre.