Nitro-tecken (förhandsversion)
Nitro Sign API möjliggör säkra eSignature-arbetsflöden från slutpunkt till slutpunkt genom att tillåta program att skapa, hantera och spåra digitala signeringsprocesser. Det ger funktioner för att skapa kuvert, ladda upp dokument, lägga till deltagare, definiera signeringsordning och skicka dokument för signatur via en helt automatiserad, API-driven metod.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regioner |
|---|---|---|
| Copilot Studio | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Premium | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Nitro-stöd |
| URL | https://www.gonitro.com/support |
| prosupport@sfdc.gonitro.com |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Nitro PDF |
| Webbplats | https://www.gonitro.com/ |
| Sekretesspolicy | https://www.gonitro.com/legal/privacy-policy |
| Kategorier | Produktivitet; IT-åtgärder |
Nitro Sign Connector
Översikt
Nitro Sign-anslutningsappen möjliggör säkra eSignature-arbetsflöden från slutpunkt till slutpunkt direkt från Power Automate och Power Apps. Det låter program skapa och hantera signeringskuvert, ladda upp och ordna om dokument, lägga till deltagare och definiera signeringsordning, placera signatur- och datafält, skicka dokument för signatur, spåra förlopp och ladda ned de ursprungliga, förseglade och spårningsfilerna – allt via en helt automatiserad, API-driven metod.
Publisher: Nitro Software
Förutsättningar
Om du vill använda Nitro Sign via den här anslutningsappen behöver du:
- Ett Nitro-konto med Nitro Sign aktiverat
https://developers.gonitro.com/ - En Microsoft PowerApps- eller Power Automate plan med anpassade anslutningsfunktioner.
Authentication
Nitro Sign använder maskin-till-dator OAuth 2.0 med klientautentiseringsuppgifter bevilja för att generera åtkomsttoken för API-begäranden.
Så här fungerar det
- Du skapar ett API-program i Nitros självbetjäningsportal och hämtar det associerade klient-ID:t och klienthemligheten.
- Anslutningsappen autentiserar genom att utbyta dessa autentiseringsuppgifter mot en bearer-åtkomsttoken.
- Token används sedan för att auktorisera efterföljande Nitro Sign API-anrop.
Skapa autentiseringsuppgifter och läs den detaljerade guiden:
https://developers.gonitro.com/docs/authentication/credentials
Skapa en anslutning i Power Automate/Power Apps
När du lägger till anslutningsappen i ett flöde eller en app:
- Klicka på Lägg till en ny anslutning.
- Ange ditt klient-ID och klienthemlighet (utfärdat i Nitro-utvecklarportalen).
- Välj din Nitro-region (Europa, United States eller APAC) – den region som är associerad med ditt Nitro-konto.
- Spara anslutningen – vid första användningen byter anslutningsappen ut ditt klient-ID och klienthemlighet mot en kortlivad åtkomsttoken med hjälp av OAuth 2.0-klientautentiseringsuppgifterna beviljar, cachelagrar det och förnyar det automatiskt. Dina autentiseringsuppgifter används bara för att hämta token. efterföljande API-anrop autentiseras med en ägartoken åt dig.
Obs! Ingen användar-interaktiv inloggning krävs; det här flödet är utformat för scenarier för server-till-server/app-till-app.
Åtgärder som stöds
Anslutningsappen grupperar sina åtgärder kring de fyra resurserna i ett signeringsarbetsflöde – kuvert, dokument, fält och deltagare – plus en uppsättning nedladdningsåtgärder för att hämta färdiga filer.
1. Kuvert
Ett kuvert är containern för dokument, deltagare och fält i en enda signeringsbegäran.
Lista kuvert
Returnerar alla kuvert som är associerade med programmet i kontot. Resultaten är sidnumrerade: svaret innehåller en markörtoken nästa sida , som du kan ange till den valfria parametern Sida efter för att hämta nästa sida (eller Sida före till sida bakåt). Båda markörparametrarna är under Avancerat och behövs bara när du går igenom stora resultatuppsättningar.Skapa kuvert
Skapar ett nytt kuvert med ett namn, meddelande (ämne + brödtext, med dynamiska variabler som$(sender_name_or_email)och$(envelope_name)) och signeringsläge:-
parallel— Alla deltagare meddelas samtidigt och kan signera oberoende av varandra. -
sequential— Deltagarna meddelas en i taget, i den ordning de lades till.
-
Hämta kuvert efter ID
Hämtar information om ett specifikt kuvert med dess UUID.Uppdatera kuvert
Uppdaterar kuvertets namn, meddelandeinställningar och/eller signeringsläge. Alla fält är valfria.Ta bort kuvert efter ID
Tar bort ett kuvert och alla associerade dokument, fält och deltagare permanent. Detta kan inte ångras.Skicka kuvert för signering
Skickar kuvertet till deltagarna för signaturinsamling. Innan du skickar ska kuvertet normalt ha sina dokument, deltagare och signeringsfält tillagda (via Skapa dokument efter kuvert-ID, Skapa deltagare efter kuvert-ID och Skapa fält efter dokument-ID). Alla dokument i kuvertet måste ha en uppladdad status innan kuvertet kan skickas.Skicka påminnelser för kuvert
Utlöser påminnelsemeddelanden till väntande deltagare. Om inga meddelandeinställningar anges används standardmeddelandemallen som konfigurerats för kuvertet.Avbryt kuvert efter ID
Avbryter signeringsbegäran. Endast kuvert som redan har skickats för signering kan avbrytas.
2. Dokument
Dokument är de filer som bifogas ett kuvert och signeras av deltagarna.
Lista dokument efter kuvert-ID
Hämtar alla dokument som är associerade med ett kuvert.Skapa dokument efter kuvert-ID
Laddar upp ett dokument till ett befintligt kuvert. Ange filen plus enkla, inskrivna fält – ingen handskriven JSON:- Dokumentfil – filen som ska laddas upp.
- Dokumentnamn – namnet som dokumentet ska lagras under.
-
Innehållstyp(avancerat, valfritt) – filens MIME-typ; standardvärdet är
application/pdf. När de utelämnas godkänns endast PDF-filer.
Hämta dokument efter ID
Hämtar information för ett visst dokument i ett kuvert.Uppdatera dokument efter ID
Uppdaterar dokumentmetadata. För närvarande kan endast dokumentnamnet ändras.Ta bort dokument efter ID
Tar bort ett dokument permanent från ett kuvert.Ändra ordning på dokument efter kuvert-ID
Ändrar ordning på dokumenten i ett kuvert baserat på en angiven lista över dokument-ID:t.
3. Fält
Fält är de interaktiva elementen (signatur, initialer, datum osv.) som placeras i ett dokument och tilldelas till en deltagare.
Lista fält efter dokument-ID
Hämtar alla fält som är associerade med ett visst dokument.Skapa fält efter dokument-ID
Skapar ett eller flera fält i ett dokument och tilldelar dem till deltagarna. Ange ett objekt för ett enda fält eller flera objekt för en massbegäran. Varje fält anger:-
participantID— deltagaren som tilldelats fältet. -
type— en avsignature,initials,name,date,title, ,company,checkbox,custom. -
page— sidnumret (1-baserad indexering). -
X Position, Y Position, Width, Height – fältets position och storlek, var och en anges som ett separat tal i punkter (X/Y mäts från sidans vänstra/övre kant). Dessa ersätter den tidigare enskilda
boundingBoxmatrisen, så varje värde är ett skrivet fält i användargränssnittet i stället för en handbyggd lista. - Valfritt:
required(standardtrue) och – under Avancerat –format(t.ex.MM/DD/YYYYför datumfält) ochmodifiable.
-
Uppdatera fält efter ID
Uppdaterar egenskaperna för ett befintligt fält. Fältettypemåste anges och måste matcha den befintliga fälttypen – det används för att identifiera fältschemat och ändrar inte fälttypen.Ta bort fält efter ID
Tar bort ett fält permanent från ett dokument.
4. Deltagare
Deltagarna är de personer som får kuvertet – antingen för att signera det eller för att hållas informerade.
Lista deltagare efter kuvert-ID
Hämtar alla deltagare som är associerade med ett kuvert.Skapa deltagare efter kuvert-ID
Lägger till en eller flera deltagare i ett kuvert. Ange ett objekt för en enskild deltagare eller flera objekt för en massbegäran. Varje deltagare anger:-
email— deltagarens e-postadress. -
role—signer(kan ha fält tilldelade för signering) ellercc(skrivskyddad åtkomst). -
authentication(avancerat, valfritt) – för närvarande Åtkomstkod: en statisk åtkomstkod som deltagaren måste ange före signering. Öppna endast det här avsnittet om deltagaren ska autentiseras innan signering.
-
Uppdatera deltagare efter ID
Uppdaterar en deltagares autentiseringsinställningar. Det går inte att ändra e-postmeddelandet för deltagaren.Ta bort deltagare efter ID
Tar bort en deltagare permanent från ett kuvert.
5. Nedladdningar
Hämta de färdiga filerna när dokumenten har signerats och förseglats.
Ladda ned originalkuvert
Laddar ned de ursprungliga osignerade dokumenten från ett kuvert som ett ZIP-arkiv .Ladda ned förseglat kuvert
Laddar ned de förseglade signerade dokumenten, tillsammans med spårningsloggen, som ett ZIP-arkiv .Ladda ned förseglat dokument efter ID
Laddar ned ett enda förseglat signerat dokument som en PDF-fil .Ladda ned granskningsspår för kuvert
Laddar ned den fullständiga spårningsloggen för ett kuvert som en PDF-fil .
Nedladdningsåtgärder exponerar inbyggda filnamn och filinnehållstoken (plus filinnehållstyp). Släpp filinnehåll direkt i filinmatningen i ett nedströmssteg, t.ex. OneDrive/SharePoint Skapa fil, och Filnamn i filnamnsindata. Inget
body('Action_Name')uttryck eller manuellt skrivet filnamn krävs. Anslutningsappen omsluter den nedladdade ZIP- eller PDF-filen till ett JSON-kuvert så Power Automate ytbehandlar dessa som vanliga token för dynamiskt innehåll.
Typiskt signeringsarbetsflöde
Ett fullständigt signeringsflöde kedjar åtgärderna ovan i ordning. Ett vanligt Power Automate flöde ser ut så här:
-
Skapa kuvert – ange namn, meddelandeämne/brödtext och signeringsläge (
parallelellersequential). Spara det returnerade kuvert-ID:t. -
Skapa dokument efter kuvert-ID – ladda upp en eller flera filer till kuvertet (med hjälp av kuvert-ID från steg 1). Spara varje returnerat dokument-ID.
(Valfritt)Ändra ordning på dokument efter kuvert-ID – ange dokumentordningen. - Skapa deltagare efter kuvert-ID – lägg till undertecknare och cc-mottagare med deras åtkomstkodsautentisering. Spara varje returnerat deltagar-ID.
- Skapa fält efter dokument-ID – placera signaturer/datum/etc. fält på varje dokument och tilldela dem till deltagarna (med hjälp av dokument-ID från steg 2 och deltagar-ID från steg 3).
- Skicka kuvert för signering – skicka kuvertet. Alla dokument måste ha den uppladdade statusen först.
- (Medan du väntar)Skicka påminnelser för kuvert för att knuffa deltagare eller Avbryt kuvert med ID för att stoppa begäran.
- (När det är klart)Ladda ned förseglat kuvert / Ladda ned förseglat dokument efter ID / Ladda ned granskningsloggen för kuvert för att hämta de färdiga filerna.
Tips: Kuvert-ID, dokument-ID och deltagar-ID som returneras av create actions flödar naturligt till de senare åtgärderna via Power Automate väljare för dynamiskt innehåll – välj ID-token från den överordnade åtgärden i stället för att skriva den.
Fel och begränsning
Nitro Sign-API:et kan returnera följande fel:
- 400 – Felaktig begäran
- 401 – Obehörig
- 404 – Hittades inte
- 409 – Konflikt (t.ex. att agera på ett kuvert i ett tillstånd som inte tillåter åtgärden)
- 413 – Innehållet är för stort
- 415 – Medietyp som inte stöds
- 422 – Entitet som inte kan bearbetas
- 500 – Internt serverfel
Throttling
- API-anrop per anslutning: 100 per 60 sekunder.
Plattformsgränser
Filstorlek
- Maximalt: 25 MB per begäran
Gäller både åtgärder med en fil och flera filer.
Antal sidor
- Maximalt: 250 sidor per enskilt dokument
Totalt antal kombinerade sidor i flera dokument kan överstiga 250.
Kvarhållningstid
- Indata- och utdatafiler tas bort ~15 minuter efter att åtgärden har slutförts.
Notes
- Åtgärder för hantering av kuvert, dokument, fält och deltagare returnerar JSON.
- Nedladdningsåtgärder returnerar filen (ZIP eller PDF) som omsluts i ett JSON-kuvert som exponerar filnamn, filinnehållstyp och filinnehåll som inbyggda token, så att resultaten kan länkas till en nedströmsfilåtgärd utan uttryck.
- Signeringsläget (
parallelvssequential) anges när kuvertet skapas och kan ändras med Uppdatera kuvert innan kuvertet skickas. - Deltagarautentisering stöder för närvarande endast åtkomstkod .
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Name | Type | Description | Required |
|---|---|---|---|
| Nitro-klient-ID | securestring | Ditt Nitro-programklient-ID | Sann |
| Nitro-klienthemlighet | securestring | Din Nitro-programklienthemlighet | Sann |
| Nitro-region | string | Välj Nitro API-regionen för ditt konto. | Sann |
Åtgärder
| Avbryt kuvert efter ID |
Avbryter signeringsbegäran för ett Nitro Sign-kuvert. Endast kuvert som har skickats för signering kan avbrytas. |
| Hämta dokument efter ID |
Hämtar information för ett specifikt dokument i ett Nitro Sign-kuvert. |
| Hämta kuvert efter ID |
Hämtar information om ett specifikt Nitro Sign-kuvert med dess unika kuvert-ID. |
| Ladda ned förseglat dokument efter ID |
Laddar ned ett enda förseglat signerat dokument från ett Nitro Sign-kuvert som en PDF-fil. |
| Ladda ned förseglat kuvert |
Laddar ned de förseglade signerade dokumenten från ett Nitro Sign-kuvert, tillsammans med spårningsspåret, som ett ZIP-arkiv. |
| Ladda ned granskningsspår för kuvert |
Laddar ned PDF-filen som innehåller den fullständiga granskningsloggen för det valda Nitro Sign-kuvertet. |
| Ladda ned originalkuvert |
Laddar ned de ursprungliga osignerade dokumenten från ett Nitro Sign-kuvert som ett ZIP-arkiv. |
| Lista deltagare efter kuvert-ID |
Hämtar alla deltagare som är associerade med ett specifikt Nitro Sign-kuvert. |
| Lista dokument efter kuvert-ID |
Hämtar alla dokument som är associerade med ett specifikt Nitro Sign-kuvert. |
| Lista fält efter dokument-ID |
Hämtar alla fält som är associerade med ett specifikt dokument i ett Nitro Sign-kuvert. |
| Lista kuvert |
Slutpunkten Listkuvert returnerar alla kuvert som är associerade med ett program i ett konto. |
| Skapa deltagare efter kuvert-ID |
Lägger till en eller flera deltagare i ett Nitro Sign-kuvert. Om du vill lägga till en enskild deltagare anger du ett objekt i matrisen Deltagare. Om du vill lägga till flera deltagare anger du flera objekt. |
| Skapa dokument efter kuvert-ID |
Laddar upp ett dokument till ett befintligt Nitro Sign-kuvert. Dokumentet kan senare användas i signeringsarbetsflödet. |
| Skapa fält efter dokument-ID |
Skapar ett eller flera fält i ett dokument och tilldelar dem till deltagarna. Om du vill skapa ett enda fält anger du ett objekt i matrisen Fält. Om du vill skapa flera fält anger du flera objekt. |
| Skapa kuvert |
Skapar ett nytt Nitro Sign-kuvert som senare kan fyllas i med dokument, deltagare, fält och skickas för signering. |
| Skicka kuvert för signering |
Skickar ett Nitro Sign-kuvert till deltagarna för signatursamling. Innan du använder den här åtgärden bör kuvertet normalt ha dokument, deltagare och signeringsfält tillagda med hjälp av Skapa dokument med kuvert-ID, Skapa deltagare efter kuvert-ID och Skapa fält med dokument-ID. Alla dokument i kuvertet måste ha en uppladdad status innan kuvertet kan skickas. |
| Skicka påminnelser för kuvert |
Utlöser påminnelsemeddelanden till väntande deltagare i ett angivet Nitro Sign-kuvert. Om inga meddelandeinställningar anges används standardmeddelandemallen som konfigurerats för kuvertet. |
| Ta bort deltagare efter ID |
Tar bort en deltagare permanent från ett Nitro Sign-kuvert. |
| Ta bort dokument efter ID |
Tar bort ett dokument permanent från ett Nitro Sign-kuvert. |
| Ta bort fält efter ID |
Tar bort ett fält permanent från ett dokument i ett Nitro Sign-kuvert. |
| Ta bort kuvert efter ID |
Tar bort ett Nitro Sign-kuvert permanent. Det går inte att ångra den här åtgärden och alla associerade dokument, fält och deltagare tas också bort. |
| Uppdatera deltagare efter ID |
Uppdaterar autentiseringsinställningarna för en deltagare i ett Nitro Sign-kuvert. Det går inte att uppdatera e-postmeddelandet för deltagaren. |
| Uppdatera dokument efter ID |
Uppdaterar ett befintligt dokuments metadata i ett Nitro Sign-kuvert. För närvarande kan endast dokumentnamnet uppdateras. |
| Uppdatera fält efter ID |
Uppdaterar egenskaperna för ett befintligt fält i ett Nitro Sign-dokument. Fälttypen måste anges och måste matcha den befintliga fälttypen. det används av API:et för att identifiera fältschemat och ändrar inte fälttypen. |
| Uppdatera kuvert |
Uppdaterar ett befintligt Nitro Sign-kuvert. Du kan ändra kuvertets namn, meddelandeinställningar, signeringsläge eller valfri kombination av dessa fält. |
| Ändra ordning på dokument efter kuvert-ID |
Ordnar om dokument som är associerade med ett specifikt Nitro Sign-kuvert baserat på den angivna listan över dokument-ID:n. |
Avbryt kuvert efter ID
Avbryter signeringsbegäran för ett Nitro Sign-kuvert. Endast kuvert som har skickats för signering kan avbrytas.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som ska avbrytas. |
Returer
Svar som returneras efter att ett Nitro Sign-kuvert har begärts eller skapats.
- Body
- EnvelopeResponse
Hämta dokument efter ID
Hämtar information för ett specifikt dokument i ett Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet som ska hämtas. |
Returer
Nitro Signera dokumentinformation.
- Body
- DocumentResponse
Hämta kuvert efter ID
Hämtar information om ett specifikt Nitro Sign-kuvert med dess unika kuvert-ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som ska hämtas. |
Returer
Svar som returneras efter att ett Nitro Sign-kuvert har begärts eller skapats.
- Body
- EnvelopeResponse
Ladda ned förseglat dokument efter ID
Laddar ned ett enda förseglat signerat dokument från ett Nitro Sign-kuvert som en PDF-fil.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller det förseglade dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar det förseglade dokument som ska laddas ned. |
Returer
Nedladdad fil omsluten som ett JSON-kuvert.
- Body
- FileDownloadResponse
Ladda ned förseglat kuvert
Laddar ned de förseglade signerade dokumenten från ett Nitro Sign-kuvert, tillsammans med spårningsspåret, som ett ZIP-arkiv.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars förseglade dokument ska laddas ned. |
Returer
Nedladdad fil omsluten som ett JSON-kuvert.
- Body
- FileDownloadResponse
Ladda ned granskningsspår för kuvert
Laddar ned PDF-filen som innehåller den fullständiga granskningsloggen för det valda Nitro Sign-kuvertet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars spårningslogg ska laddas ned. |
Returer
Nedladdad fil omsluten som ett JSON-kuvert.
- Body
- FileDownloadResponse
Ladda ned originalkuvert
Laddar ned de ursprungliga osignerade dokumenten från ett Nitro Sign-kuvert som ett ZIP-arkiv.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars ursprungliga dokument ska laddas ned. |
Returer
Nedladdad fil omsluten som ett JSON-kuvert.
- Body
- FileDownloadResponse
Lista deltagare efter kuvert-ID
Hämtar alla deltagare som är associerade med ett specifikt Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars deltagare ska hämtas. |
Returer
Svar som returneras när deltagare som är associerade med ett Nitro Sign-kuvert visas.
Lista dokument efter kuvert-ID
Hämtar alla dokument som är associerade med ett specifikt Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars dokument ska hämtas. |
Returer
Svaret returnerades när dokument som är associerade med ett Nitro Sign-kuvert visas.
Lista fält efter dokument-ID
Hämtar alla fält som är associerade med ett specifikt dokument i ett Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet vars fält ska hämtas. |
Returer
Svaret returnerades när ett eller flera fält skapades.
- Body
- FieldsResponse
Lista kuvert
Slutpunkten Listkuvert returnerar alla kuvert som är associerade med ett program i ett konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida efter
|
pageAfter | string |
Valfri markörtoken som används för att hämta nästa sida med kuvert. Använd värdet nextPage som returnerades av föregående svar. |
|
|
Sida före
|
pageBefore | string |
Valfri markörtoken som används för att hämta föregående sida med kuvert. Använd inte tillsammans med Sid efter. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert
|
items | array of EnvelopeSummaryResponse |
Listan över kuvert. |
|
Nästa sida
|
nextPage | string |
Markörtoken som kan användas som Sida efter för att hämta nästa sida med kuvert. |
Skapa deltagare efter kuvert-ID
Lägger till en eller flera deltagare i ett Nitro Sign-kuvert. Om du vill lägga till en enskild deltagare anger du ett objekt i matrisen Deltagare. Om du vill lägga till flera deltagare anger du flera objekt.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet där deltagarna ska läggas till. |
|
Email
|
True |
Deltagarens e-postadress. |
||
|
Role
|
role | True | string |
Deltagarrollen. En undertecknare kan ha fält tilldelade för signering. En cc-deltagare har skrivskyddad åtkomst. |
|
Autentiseringstyp
|
type | string |
Optional. Välj en autentiseringsmetod för deltagaren. Om det anges ska du också ange en åtkomstkod. |
|
|
Åtkomstkod
|
accessCode | string |
Krävs endast när autentiseringstyp har angetts. Lämna tomt om deltagarautentisering inte krävs. |
Returer
Svaret returnerades när en eller flera deltagare skapades.
- Body
- ParticipantsResponse
Skapa dokument efter kuvert-ID
Laddar upp ett dokument till ett befintligt Nitro Sign-kuvert. Dokumentet kan senare användas i signeringsarbetsflödet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet där dokumentet ska laddas upp. |
|
Dokumentnamn
|
documentName | True | string |
Namnet på dokumentet som ska laddas upp. Det här värdet används för att skapa dokumentmetadata som skickas till Nitro. |
|
Innehållstyp
|
contentType | string |
Innehållstypen för det uppladdade dokumentet. För PDF-filer använder du program/pdf. När utelämnas från metadata accepteras endast PDF-filer. |
|
|
Dokumentfil
|
payload | True | file |
Dokumentfilen som ska laddas upp till kuvertet. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dokument-ID
|
ID | uuid |
Ett unikt UUID som identifierar det uppladdade dokumentet. |
|
Dokumentnamn
|
name | string |
Namnet på det uppladdade dokumentet. |
|
Skapad vid
|
createdAt | string |
Tidsstämpel som anger när dokumentet skapades. |
|
Dokumentstatus
|
status | string |
Bearbetningsstatus för det uppladdade dokumentet. |
Skapa fält efter dokument-ID
Skapar ett eller flera fält i ett dokument och tilldelar dem till deltagarna. Om du vill skapa ett enda fält anger du ett objekt i matrisen Fält. Om du vill skapa flera fält anger du flera objekt.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet där fält ska skapas. |
|
Deltagar-ID
|
participantID | True | uuid |
Den unika identifieraren för den deltagare som tilldelats fältet. |
|
Sida
|
page | True | integer |
Sidnumret där fältet ska placeras. Sidor använder 1-baserad indexering, så den första sidan är 1. |
|
Fälttyp
|
type | True | string |
Vilken typ av fält som ska skapas. |
|
X-position
|
x | True | float |
Fältets vågräta position, mätt från sidans vänstra kant i punkter. |
|
Y-position
|
y | True | float |
Fältets lodräta position, mätt från sidans övre kant i punkter. |
|
Bredd
|
width | True | float |
Fältets bredd i punkter. |
|
Höjd
|
height | True | float |
Höjden på fältet i punkter. |
|
Required
|
required | boolean |
Anger om deltagaren måste slutföra det här fältet. |
|
|
Format
|
format | string |
Valfritt format för fälttyper som stöder formatering, till exempel datumfält. Exempel: MM/DD/ÅÅÅÅ. |
|
|
Kan ändras
|
modifiable | boolean |
Anger om fältvärdet kan ändras av deltagaren, där det stöds av fälttypen. |
Returer
Svaret returnerades när ett eller flera fält skapades.
- Body
- FieldsResponse
Skapa kuvert
Skapar ett nytt Nitro Sign-kuvert som senare kan fyllas i med dokument, deltagare, fält och skickas för signering.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvertnamn
|
name | True | string |
Kuvertets namn. Det behöver inte vara unikt. |
|
Signeringsläge
|
mode | True | string |
Definierar signeringsordningen. Använd parallell för att meddela alla deltagare samtidigt eller sekventiellt för att meddela deltagarna en i taget i den ordning de lades till. |
|
Meddelandeämne
|
subject | True | string |
Ämnesraden i e-postmeddelandet som skickas till signeringsdeltagare. Dynamiska variabler stöds, till exempel: $(sender_name_or_email) begär din signatur. |
|
Meddelandets text
|
body | True | string |
E-postmeddelandet som skickas till signeringsdeltagarna. Dynamiska variabler stöds, till exempel: Hej,\nSignera $(envelope_name)\nTack,\n$(sender_name_or_email). |
Returer
Svar som returneras efter att ett Nitro Sign-kuvert har begärts eller skapats.
- Body
- EnvelopeResponse
Skicka kuvert för signering
Skickar ett Nitro Sign-kuvert till deltagarna för signatursamling. Innan du använder den här åtgärden bör kuvertet normalt ha dokument, deltagare och signeringsfält tillagda med hjälp av Skapa dokument med kuvert-ID, Skapa deltagare efter kuvert-ID och Skapa fält med dokument-ID. Alla dokument i kuvertet måste ha en uppladdad status innan kuvertet kan skickas.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som ska skickas för signering. |
Returer
Sammanfattningsinformation om ett Nitro Sign-kuvert.
Skicka påminnelser för kuvert
Utlöser påminnelsemeddelanden till väntande deltagare i ett angivet Nitro Sign-kuvert. Om inga meddelandeinställningar anges används standardmeddelandemallen som konfigurerats för kuvertet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet för vilket påminnelsemeddelanden ska skickas. |
|
Meddelandeämne
|
subject | string |
Ämnesraden i e-postmeddelandet som skickas till signeringsdeltagare. Dynamiska variabler stöds, till exempel: $(sender_name_or_email) begär din signatur. |
|
|
Meddelandets text
|
body | string |
E-postmeddelandet som skickas till signeringsdeltagarna. Dynamiska variabler stöds, till exempel: Hej,\nSignera $(envelope_name)\nTack,\n$(sender_name_or_email). |
Ta bort deltagare efter ID
Tar bort en deltagare permanent från ett Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller deltagaren. |
|
Deltagar-ID
|
participantID | True | uuid |
Ett unikt UUID som identifierar deltagaren som ska tas bort. |
Ta bort dokument efter ID
Tar bort ett dokument permanent från ett Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet som ska tas bort. |
Ta bort fält efter ID
Tar bort ett fält permanent från ett dokument i ett Nitro Sign-kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet som innehåller fältet. |
|
Fält-ID
|
fieldID | True | uuid |
Ett unikt UUID som identifierar det fält som ska tas bort. |
Ta bort kuvert efter ID
Tar bort ett Nitro Sign-kuvert permanent. Det går inte att ångra den här åtgärden och alla associerade dokument, fält och deltagare tas också bort.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som ska tas bort. |
Uppdatera deltagare efter ID
Uppdaterar autentiseringsinställningarna för en deltagare i ett Nitro Sign-kuvert. Det går inte att uppdatera e-postmeddelandet för deltagaren.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller deltagaren. |
|
Deltagar-ID
|
participantID | True | uuid |
Ett unikt UUID som identifierar deltagaren som ska uppdateras. |
|
Autentiseringstyp
|
type | string |
Optional. Välj en autentiseringsmetod för deltagaren. Om det anges ska du också ange en åtkomstkod. |
|
|
Åtkomstkod
|
accessCode | string |
Krävs endast när autentiseringstyp har angetts. Lämna tomt om deltagarautentisering inte krävs. |
Returer
Information om Nitro Sign-deltagare.
- Body
- ParticipantResponse
Uppdatera dokument efter ID
Uppdaterar ett befintligt dokuments metadata i ett Nitro Sign-kuvert. För närvarande kan endast dokumentnamnet uppdateras.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet som ska uppdateras. |
|
Dokumentnamn
|
name | True | string |
Det nya namnet på dokumentet. |
Returer
Nitro Signera dokumentinformation.
- Body
- DocumentResponse
Uppdatera fält efter ID
Uppdaterar egenskaperna för ett befintligt fält i ett Nitro Sign-dokument. Fälttypen måste anges och måste matcha den befintliga fälttypen. det används av API:et för att identifiera fältschemat och ändrar inte fälttypen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som innehåller dokumentet. |
|
Dokument-ID
|
documentID | True | uuid |
Ett unikt UUID som identifierar dokumentet som innehåller fältet. |
|
Fält-ID
|
fieldID | True | uuid |
Ett unikt UUID som identifierar det fält som ska uppdateras. |
|
Fälttyp
|
type | True | string |
Den aktuella typen av fält som uppdateras. Det här värdet krävs av API:et och måste matcha den befintliga fälttypen. den ändrar inte fälttypen. |
|
Deltagar-ID
|
participantID | uuid |
Den unika identifieraren för den deltagare som tilldelats fältet. |
|
|
Sida
|
page | integer |
Sidnumret där fältet visas. Sidor använder 1-baserad indexering. |
|
|
X-position
|
x | float |
Optional. Fältets vågräta position, mätt från sidans vänstra kant i punkter. |
|
|
Y-position
|
y | float |
Optional. Fältets lodräta position, mätt från sidans övre kant i punkter. |
|
|
Bredd
|
width | float |
Optional. Fältets bredd i punkter. |
|
|
Höjd
|
height | float |
Optional. Höjden på fältet i punkter. |
|
|
Required
|
required | boolean |
Anger om deltagaren måste slutföra det här fältet. |
|
|
Format
|
format | string |
Fältformatet, om tillämpligt. Datumfält kan till exempel använda ett format som MM/DD/ÅÅÅÅ. |
|
|
Kan ändras
|
modifiable | boolean |
Anger om fältvärdet kan ändras, i förekommande fall. |
Returer
Fältinformation för Nitro Sign.
- Body
- FieldResponse
Uppdatera kuvert
Uppdaterar ett befintligt Nitro Sign-kuvert. Du kan ändra kuvertets namn, meddelandeinställningar, signeringsläge eller valfri kombination av dessa fält.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet som ska uppdateras. |
|
Kuvertnamn
|
name | string |
Det uppdaterade kuvertnamnet. Det behöver inte vara unikt. |
|
|
Meddelandeämne
|
subject | string |
Ämnesraden i e-postmeddelandet som skickas till signeringsdeltagare. Dynamiska variabler stöds, till exempel: $(sender_name_or_email) begär din signatur. |
|
|
Meddelandets text
|
body | string |
E-postmeddelandet som skickas till signeringsdeltagarna. Dynamiska variabler stöds, till exempel: Hej,\nSignera $(envelope_name)\nTack,\n$(sender_name_or_email). |
|
|
Signeringsläge
|
mode | string |
Definierar signeringsordningen. Använd parallell för att meddela alla deltagare samtidigt eller sekventiellt för att meddela deltagarna en i taget i den ordning de lades till. |
Returer
Svar som returneras efter att ett Nitro Sign-kuvert har begärts eller skapats.
- Body
- EnvelopeResponse
Ändra ordning på dokument efter kuvert-ID
Ordnar om dokument som är associerade med ett specifikt Nitro Sign-kuvert baserat på den angivna listan över dokument-ID:n.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeID | True | uuid |
Ett unikt UUID som identifierar kuvertet vars dokument ska ordnas om. |
|
Dokument-ID
|
order | True | array of uuid |
En matris med dokument-ID:n som representerar den nya ordningen för dokument i kuvertet. |
Returer
Svaret returnerades när dokument som är associerade med ett Nitro Sign-kuvert visas.
Definitioner
Kuvertnotifiering
Inställningar för e-postavisering för ett Nitro Sign-kuvert.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Meddelandeämne
|
subject | string |
Ämnesraden i e-postmeddelandet som skickas till signeringsdeltagare. Dynamiska variabler stöds, till exempel: $(sender_name_or_email) begär din signatur. |
|
Meddelandets text
|
body | string |
E-postmeddelandet som skickas till signeringsdeltagarna. Dynamiska variabler stöds, till exempel: Hej,\nSignera $(envelope_name)\nTack,\n$(sender_name_or_email). |
EnvelopeSummaryResponse
Sammanfattningsinformation om ett Nitro Sign-kuvert.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
ID | uuid |
Ett unikt UUID som identifierar kuvertet. |
|
Skapad vid
|
createdAt | date-time |
UTC-tidsstämpel som anger när kuvertet skapades. |
|
Senast ändrad vid
|
lastModifiedAt | date-time |
UTC-tidsstämpel som anger när kuvertet senast ändrades. |
|
Kuvertnamn
|
name | string |
Kuvertets namn. |
|
Kuvertstatus
|
status | string |
Kuvertets interna status. |
EnvelopeResponse
Svar som returneras efter att ett Nitro Sign-kuvert har begärts eller skapats.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
ID | uuid |
Ett unikt UUID som identifierar kuvertet. |
|
Skapad vid
|
createdAt | date-time |
UTC-tidsstämpel som anger när kuvertet skapades. |
|
Senast ändrad vid
|
lastModifiedAt | date-time |
UTC-tidsstämpel som anger när kuvertet senast ändrades. |
|
Kuvertnamn
|
name | string |
Kuvertets namn. |
|
Kuvertstatus
|
status | string |
Kuvertets interna status. |
|
Signeringsläge
|
mode | string |
Signeringsläget som konfigurerats för kuvertet. |
|
avisering
|
notification | EnvelopeNotification |
Inställningar för e-postavisering för ett Nitro Sign-kuvert. |
ListDocumentsByEnvelopeIDResponse
Svaret returnerades när dokument som är associerade med ett Nitro Sign-kuvert visas.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Documents
|
items | array of DocumentResponse |
Listan över dokument som är associerade med kuvertet. |
DocumentResponse
Nitro Signera dokumentinformation.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dokument-ID
|
ID | uuid |
Ett unikt UUID som identifierar dokumentet. |
|
Dokumentnamn
|
name | string |
Namnet på dokumentet. |
|
Skapad vid
|
createdAt | date-time |
UTC-tidsstämpel som anger när dokumentet skapades. |
|
Storlek i byte
|
sizeBytes | integer |
Dokumentstorleken i byte. |
|
Antal sidor
|
numPages | integer |
Antalet sidor i dokumentet. |
|
Dokumentstatus
|
status | string |
Dokumentets aktuella status. |
FieldsResponse
Svaret returnerades när ett eller flera fält skapades.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fields
|
items | array of FieldResponse |
Fälten som skapades i den här begäran. |
FieldResponse
Fältinformation för Nitro Sign.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fält-ID
|
ID | uuid |
Ett unikt UUID som identifierar fältet. |
|
Deltagar-ID
|
participantID | uuid |
Den unika identifieraren för den deltagare som tilldelats fältet. |
|
Dokument-ID
|
documentID | uuid |
Den unika identifieraren för det dokument som fältet tillhör. |
|
Sida
|
page | integer |
Sidnumret där fältet visas. |
|
Avgränsningsruta
|
boundingBox | array of float |
En matris med fyra tal i formatet [x, y, bredd, höjd], mätt i punkter. |
|
Required
|
required | boolean |
Anger om deltagaren måste slutföra det här fältet. |
|
Fälttyp
|
type | string |
Typ av fält. |
|
Format
|
format | string |
Fältformatet, om tillämpligt. |
|
Kan ändras
|
modifiable | boolean |
Anger om fältvärdet kan ändras, i förekommande fall. |
DeltagareResponse
Svaret returnerades när en eller flera deltagare skapades.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Participants
|
items | array of ParticipantResponse |
Deltagarna som skapats i den här begäran. |
ParticipantsListResponse
Svar som returneras när deltagare som är associerade med ett Nitro Sign-kuvert visas.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Participants
|
items | array of ParticipantResponse |
De deltagare som är associerade med kuvertet. |
|
Totalt antal deltagare
|
total | integer |
Det totala antalet deltagare som är tillgängliga i samlingen. |
ParticipantResponse
Information om Nitro Sign-deltagare.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Deltagar-ID
|
ID | uuid |
Ett unikt UUID som identifierar deltagaren. |
|
Email
|
Deltagarens e-postadress. |
||
|
Role
|
role | string |
Deltagarens roll. |
|
authentication
|
authentication | ParticipantAuthenticationResponse |
Autentiseringsinställningar som returneras för en deltagare. |
ParticipantAuthenticationResponse
Autentiseringsinställningar som returneras för en deltagare.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Autentiseringstyp
|
type | string |
Autentiseringstypen deltagare. |
|
Åtkomstkod
|
accessCode | string |
Åtkomstkoden som har konfigurerats för deltagaren. |
FileDownloadResponse
Nedladdad fil omsluten som ett JSON-kuvert.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Filnamn
|
fileName | string |
Namnet på den nedladdade filen som härleds från svaret Content-Disposition-huvudet (till exempel result.zip eller result.pdf). Släpp den här token direkt i filnamnsindata för en nedströmsåtgärd, till exempel OneDrive eller SharePoint Skapa fil. |
|
Filinnehållstyp
|
fileContentType | string |
MIME-typen för den nedladdade filen, till exempel program/zip eller program/pdf. |
|
Filinnehåll
|
fileContent | byte |
Det base64-kodade filinnehållet. Släpp den här token direkt i indata för filinnehåll i en nedströmsåtgärd (till exempel OneDrive eller SharePoint Skapa fil eller någon annan Nitro-åtgärd) – inget uttryck krävs. |