Nitro-teken (preview)

Nitro Sign-API maakt veilige, end-to-end eSignature-werkstromen mogelijk door toepassingen toe te staan processen voor digitale ondertekening te maken, te beheren en bij te houden. Het biedt mogelijkheden voor het maken van enveloppen, het uploaden van documenten, het toevoegen van deelnemers, het definiëren van de handtekeningvolgorde en het verzenden van documenten voor handtekening via een volledig geautomatiseerde, API-gestuurde benadering.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate regio's behalve:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps regio's behalve:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate regio's behalve:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contact
Naam Nitro-ondersteuning
URL https://www.gonitro.com/support
Email prosupport@sfdc.gonitro.com
Connectormetagegevens
Uitgever Nitro PDF
Website https://www.gonitro.com/
Privacybeleid https://www.gonitro.com/legal/privacy-policy
Categorieën Productiviteit; IT-bewerkingen

Nitro-tekenconnector

Overzicht

De Nitro Sign-connector maakt veilige, end-to-end eSignature-werkstromen rechtstreeks vanuit Power Automate en Power Apps mogelijk. Hiermee kunnen toepassingen enveloppen voor ondertekening maken en beheren, documenten uploaden en opnieuw ordenen, deelnemers toevoegen en ondertekeningsvolgorde definiëren, handtekening- en gegevensvelden plaatsen, documenten verzenden voor handtekening, voortgang bijhouden en de oorspronkelijke, verzegelde en audittrailbestanden downloaden, allemaal via een volledig geautomatiseerde, API-gestuurde benadering.

Publisher: Nitro Software


Prerequisites

Als u Nitro Sign via deze connector wilt gebruiken, hebt u het volgende nodig:

  • Een Nitro-account waarvoor Nitro Sign is ingeschakeld
    https://developers.gonitro.com/
  • Een Microsoft PowerApps of Power Automate plan met mogelijkheden voor aangepaste connectors.

Authentication

Nitro Sign maakt gebruik van machine-naar-machine OAuth 2.0 met de clientreferenties die worden verleend om toegangstokens voor API-aanvragen te genereren.

Hoe werkt het?

  • U maakt een API-toepassing in de selfserviceportal van Nitro en verkrijgt de bijbehorende client-id en clientgeheim.
  • De connector wordt geverifieerd door deze referenties uit te wisselen voor een Bearer-toegangstoken .
  • Het token wordt vervolgens gebruikt om volgende Nitro Sign API-aanroepen te autoriseren.

Referenties maken en de gedetailleerde handleiding lezen:
https://developers.gonitro.com/docs/authentication/credentials

Een verbinding maken in Power Automate/Power Apps

Wanneer u de connector toevoegt aan een stroom of app:

  1. Klik op Een nieuwe verbinding toevoegen.
  2. Voer uw client-id en clientgeheim in (uitgegeven in de Nitro-ontwikkelaarsportal).
  3. Selecteer uw Nitro-regio (Europa, Verenigde Staten of APAC) - de regio die is gekoppeld aan uw Nitro-account.
  4. Sla de verbinding op: bij eerste gebruik wisselt de connector uw client-id en clientgeheim uit voor een kortstondige toegangstoken met behulp van de toekenning van OAuth 2.0-clientreferenties, slaat deze in de cache op en wordt het automatisch vernieuwd. Uw referenties worden alleen gebruikt om het token te verkrijgen; volgende API-aanroepen worden namens u geverifieerd met een bearer-token.

Opmerking: er is geen gebruikers-interactieve aanmelding vereist; deze stroom is ontworpen voor server-naar-server-/app-naar-app-scenario's.

Ondersteunde bewerkingen

De connector groepeert de acties rond de vier resources van een ondertekeningswerkstroom, enveloppen, documenten, velden en deelnemers , plus een set downloadacties voor het ophalen van voltooide bestanden.

1. Enveloppen

Een envelop is de container voor de documenten, deelnemers en velden in één ondertekeningsaanvraag.

  • Enveloppen weergeven
    Retourneert alle enveloppen die zijn gekoppeld aan de toepassing in het account. Resultaten worden gepagineerd: het antwoord bevat een cursortoken volgende pagina , dat u kunt opgeven voor de optionele parameter Page After om de volgende pagina (of Pagina voor naar pagina achteruit) op te halen. Beide cursorparameters bevinden zich onder Geavanceerd en zijn alleen nodig bij het doorlopen van grote resultatensets.

  • Envelop maken
    Hiermee maakt u een nieuwe envelop met een naam, meldingsbericht (onderwerp + hoofdtekst, met dynamische variabelen zoals $(sender_name_or_email) en $(envelope_name)) en de ondertekeningsmodus:

    • parallel — alle deelnemers worden op hetzelfde moment op de hoogte gesteld en kunnen zich onafhankelijk ondertekenen.
    • sequential — deelnemers worden één voor één op de hoogte gesteld in de volgorde waarin zij zijn toegevoegd.
  • Envelop ophalen op id
    Hiermee worden details opgehaald voor een specifieke envelop door de UUID.

  • Envelop bijwerken
    Hiermee werkt u de envelopnaam, meldingsinstellingen en/of ondertekeningsmodus bij. Alle velden zijn optioneel.

  • Envelop verwijderen op id
    Hiermee verwijdert u een envelop en alle bijbehorende documenten, velden en deelnemers definitief. Dit kan niet ongedaan worden gemaakt.

  • Envelop verzenden voor ondertekening
    Hiermee wordt de envelop verzonden naar deelnemers voor het verzamelen van handtekeningen. Voordat de envelop wordt verzonden, moeten normaal gesproken de bijbehorende documenten, deelnemers en ondertekeningsvelden worden toegevoegd (via Document maken op envelop-id, Deelnemer(s) maken op envelop-id en Veld(en) maken op document-id. Alle documenten in de envelop moeten een geüploade status hebben voordat de envelop kan worden verzonden.

  • Herinneringen voor envelop verzenden
    Hiermee worden herinneringsmeldingen geactiveerd voor deelnemers die in behandeling zijn. Als er geen meldingsinstellingen worden opgegeven, wordt de standaardmeldingssjabloon gebruikt die is geconfigureerd voor de envelop.

  • Envelop annuleren op id
    Hiermee annuleert u de ondertekeningsaanvraag. Alleen enveloppen die al zijn verzonden voor ondertekening, kunnen worden geannuleerd.


2. Documenten

Documenten zijn de bestanden die zijn gekoppeld aan een envelop en ondertekend door deelnemers.

  • Documenten weergeven op envelop-id
    Hiermee worden alle documenten opgehaald die aan een envelop zijn gekoppeld.

  • Document maken op envelop-id
    Hiermee wordt een document geüpload naar een bestaande envelop. Geef het bestand op plus eenvoudige, getypte velden, zonder handgeschreven JSON:

    • Documentbestand : het bestand dat moet worden geüpload.
    • Documentnaam : de naam waaronder het document moet worden opgeslagen.
    • Inhoudstype(geavanceerd, optioneel) - het MIME-type van het bestand; is standaard ingesteld op application/pdf. Wanneer u dit weglaat, worden alleen PDF-bestanden geaccepteerd.
  • Document ophalen op id
    Hiermee worden details opgehaald voor een specifiek document in een envelop.

  • Document bijwerken op id
    Hiermee worden documentmetagegevens bijgewerkt. Op dit moment kan alleen de documentnaam worden gewijzigd.

  • Document verwijderen op id
    Hiermee verwijdert u een document definitief van een envelop.

  • Documenten opnieuw ordenen op envelop-id
    Hiermee worden de documenten in een envelop opnieuw gerangschikt op basis van een opgegeven lijst met document-id's.


3. Velden

Velden zijn de interactieve elementen (handtekening, initialen, datum, enzovoort) die op een document zijn geplaatst en aan een deelnemer zijn toegewezen.

  • Lijstvelden op document-id
    Hiermee worden alle velden opgehaald die zijn gekoppeld aan een specifiek document.

  • Veld(en) maken op document-id
    Hiermee maakt u een of meer velden in een document en wijst u deze toe aan deelnemers. Geef één item op voor één veld of meerdere items voor een bulkaanvraag. Elk veld geeft het volgende op:

    • participantID — de deelnemer die aan het veld is toegewezen.
    • type— een van signature, , initials, name, date, title, , company, , , checkbox. custom
    • page — het paginanummer (indexering op basis van 1).
    • X Position, Y Position, Width, Height — de positie en grootte van het veld, elk ingevoerd als een afzonderlijk getal in punten (X/Y worden gemeten vanaf de linker-/bovenrand van de pagina). Deze vervangen de vorige ene boundingBox matrix, dus elke waarde is een getypt veld in de gebruikersinterface in plaats van een handmatige lijst.
    • Optioneel: required (standaard true) en — onder Geavanceerdformat (bijvoorbeeld MM/DD/YYYY voor datumvelden) en modifiable.
  • Veld bijwerken op id
    Hiermee worden eigenschappen van een bestaand veld bijgewerkt. Het veld type moet worden opgegeven en moet overeenkomen met het bestaande veldtype. Het wordt gebruikt om het veldschema te identificeren en wijzigt het veldtype niet .

  • Veld verwijderen op id
    Hiermee verwijdert u een veld definitief uit een document.


4. Deelnemers

Deelnemers zijn de personen die de envelop ontvangen, ofwel om deze te ondertekenen of op de hoogte te worden gehouden.

  • Deelnemers weergeven op envelop-id
    Hiermee worden alle deelnemers opgehaald die zijn gekoppeld aan een envelop.

  • Deelnemer(s) maken op envelop-id
    Voegt een of meer deelnemers toe aan een envelop. Geef één item op voor één deelnemer of meerdere items voor een bulkaanvraag. Elke deelnemer geeft het volgende op:

    • email — het e-mailadres van de deelnemer.
    • rolesigner (kan velden hebben toegewezen voor ondertekening) of cc (alleen-lezentoegang).
    • authentication (geavanceerd, optioneel) - momenteel toegangscode: een statische toegangscode die de deelnemer moet opgeven voordat deze wordt ondertekend. Open deze sectie alleen als de deelnemer zich moet verifiëren voordat deze wordt ondertekend.
  • Deelnemer bijwerken op id
    Hiermee worden de verificatie-instellingen van een deelnemer bijgewerkt. Het e-mailadres van de deelnemer kan niet worden gewijzigd.

  • Deelnemer verwijderen op id
    Hiermee verwijdert u een deelnemer definitief uit een envelop.


5. Downloads

Haal de voltooide bestanden op zodra documenten zijn ondertekend en verzegeld.

  • Oorspronkelijke envelop downloaden
    Downloadt de oorspronkelijke niet-ondertekende documenten van een envelop als een ZIP-archief .

  • Verzegelde envelop downloaden
    Downloadt de verzegelde ondertekende documenten, samen met het audittrail, als een ZIP-archief .

  • Verzegeld document downloaden op id
    Hiermee downloadt u één verzegeld document als pdf-bestand .

  • Audittrail van envelop downloaden
    Hiermee downloadt u het volledige audittrail voor een envelop als PDF-bestand .

Downloadacties maken systeemeigen bestandsnaam en tokens voor bestandsinhoud beschikbaar (plus bestandsinhoudstype). Zet bestandsinhoud rechtstreeks neer in de bestandsinvoer van een downstreamstap, bijvoorbeeld OneDrive/SharePoint Bestand maken en bestandsnaam in de invoer van de bestandsnaam. Er is geen body('Action_Name') expressie of handmatig getypte bestandsnaam vereist. De connector verpakt het gedownloade ZIP- of PDF-bestand in een JSON-envelop, zodat Power Automate deze als gewone tokens voor dynamische inhoud weergeeft.


Typische werkstroom voor ondertekening

Een volledige ondertekeningsstroom koppelt de bovenstaande acties in volgorde. Een algemene Power Automate stroom ziet er als volgt uit:

  1. Envelop maken : stel de naam, het onderwerp/de hoofdtekst van de melding en de ondertekeningsmodus (parallel of sequential) in. Sla de geretourneerde envelop-id op.
  2. Document maken op envelop-id : upload een of meer bestanden naar de envelop (met behulp van de envelop-id uit stap 1). Sla elke geretourneerde document-id op.
    (Optioneel)Documenten opnieuw ordenen op envelop-id : stel de documentvolgorde in.
  3. Deelnemer(s) maken op envelop-id : voeg de ondertekenaars en CC-geadresseerden toe met hun verificatie via de toegangscode. Sla elke geretourneerde deelnemer-id op.
  4. Veld(en) maken op document-id : plaats handtekening-/datum-/etc.-velden in elk document en wijs deze toe aan deelnemers (met behulp van de document-id uit stap 2 en de deelnemer-id uit stap 3).
  5. Envelop verzenden voor ondertekening : verzend de envelop. Alle documenten moeten eerst de geüploade status hebben.
  6. (Terwijl dit in behandeling is)Verzend herinneringen voor envelop om deelnemers te vervelen, of annuleer envelop per id om de aanvraag te stoppen.
  7. (Wanneer voltooid)Download verzegeld / document / met idAudittrail van envelop downloaden om de voltooide bestanden op te halen.

Tip: De envelop-id, document-id en deelnemer-id die door de acties voor maken worden geretourneerd, stromen natuurlijk naar de latere acties via de kiezer voor dynamische inhoud van Power Automate: kies het id-token uit de upstream-actie in plaats van het te typen.


Fouten en beperking

De Nitro Sign-API kan de volgende fouten retourneren:

  • 400 — Ongeldige aanvraag
  • 401 — Niet geautoriseerd
  • 404 — Niet gevonden
  • 409 — Conflict (bijvoorbeeld handelen op een envelop in een toestand die de bewerking niet toestaat)
  • 413 — Inhoud te groot
  • 415 — Niet-ondersteund mediatype
  • 422 — Niet-verwerkte entiteit
  • 500 — Interne serverfout

Snelheidsbeperking

  • API-aanroepen per verbinding: 100 per 60 seconden.

Platformlimieten

Bestandsgrootte

  • Maximum: 25 MB per aanvraag
    Is van toepassing op bewerkingen met één bestand en meerdere bestanden.

Aantal pagina's

  • Maximum: 250 pagina's per afzonderlijk document
    Totaal aantal gecombineerde pagina's in meerdere documenten kan groter zijn dan 250.

Bewaartijd

  • Invoer- en uitvoerbestanden worden ongeveer 15 minuten na voltooiing van de bewerking verwijderd.

Opmerkingen

  • Envelop-, document-, veld- en deelnemersbeheeracties retourneren JSON.
  • Downloadacties retourneren het bestand (ZIP of PDF) dat is verpakt in een JSON-envelop met de bestandsnaam, het bestandstype en bestandsinhoud als systeemeigen tokens, zodat resultaten kunnen worden gekoppeld aan een downstreambestandsactie zonder expressies.
  • De ondertekeningsmodus (parallel vs sequential) wordt ingesteld wanneer de envelop wordt gemaakt en kan worden gewijzigd met Envelop bijwerken voordat de envelop wordt verzonden.
  • Verificatie van deelnemers ondersteunt momenteel alleen toegangscode .

Een verbinding maken

De connector ondersteunt de volgende verificatietypen:

Standaard Parameters voor het maken van verbinding. Alle regio's Niet deelbaar

Verstek

Van toepassing: Alle regio's

Parameters voor het maken van verbinding.

Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.

Naam Typ Description Required
Nitro-client-id beveiligde string Client-id van uw Nitro-toepassing True
Nitro-clientgeheim beveiligde string Clientgeheim van uw Nitro-toepassing True
Nitro-regio string Selecteer de Nitro-API-regio voor uw account. True

Acties

Audittrail van envelop downloaden

Hiermee downloadt u het PDF-bestand met het volledige audittrail voor de geselecteerde Nitro Sign-envelop.

Deelnemer(s) maken op envelop-id

Voegt een of meer deelnemers toe aan een Nitro Sign-envelop. Als u één deelnemer wilt toevoegen, geeft u één item op in de matrix Deelnemers. Als u meerdere deelnemers wilt toevoegen, geeft u meerdere items op.

Deelnemer bijwerken op id

Hiermee werkt u de verificatie-instellingen voor een deelnemer in een Nitro Sign-envelop bij. Het e-mailadres van de deelnemer kan niet worden bijgewerkt.

Deelnemer verwijderen op id

Hiermee verwijdert u een deelnemer definitief uit een Nitro Sign-envelop.

Deelnemers weergeven op envelop-id

Haalt alle deelnemers op die zijn gekoppeld aan een specifieke Nitro Sign-envelop.

Document bijwerken op id

Hiermee werkt u de metagegevens van een bestaand document bij in een Nitro Sign-envelop. Op dit moment kan alleen de documentnaam worden bijgewerkt.

Document maken op envelop-id

Uploadt een document naar een bestaande Nitro Sign-envelop. Het document kan later worden gebruikt in de werkstroom voor ondertekening.

Document ophalen op id

Hiermee worden details opgehaald voor een specifiek document in een Nitro Sign-envelop.

Document verwijderen op id

Hiermee verwijdert u een document definitief uit een Nitro Sign-envelop.

Documenten opnieuw ordenen op envelop-id

Hiermee rangschikt u de volgorde van documenten die zijn gekoppeld aan een specifieke Nitro Sign-envelop op basis van de opgegeven lijst met document-id's.

Documenten weergeven op envelop-id

Hiermee haalt u alle documenten op die zijn gekoppeld aan een specifieke Nitro Sign-envelop.

Envelop annuleren op id

Annuleert de ondertekeningsaanvraag voor een Nitro Sign-envelop. Alleen enveloppen die zijn verzonden voor ondertekening, kunnen worden geannuleerd.

Envelop bijwerken

Hiermee werkt u een bestaande Nitro Sign-envelop bij. U kunt de naam van de envelop, meldingsinstellingen, de ondertekeningsmodus of een combinatie van deze velden wijzigen.

Envelop maken

Hiermee maakt u een nieuwe Nitro Sign-envelop die later kan worden gevuld met documenten, deelnemers, velden en verzonden voor ondertekening.

Envelop ophalen op id

Hiermee haalt u details op voor een specifieke Nitro Sign-envelop met behulp van de unieke envelop-id.

Envelop verwijderen op id

Hiermee verwijdert u definitief een Nitro Sign-envelop. Deze bewerking kan niet ongedaan worden gemaakt en alle gekoppelde documenten, velden en deelnemers worden ook verwijderd.

Envelop verzenden voor ondertekening

Hiermee wordt een Nitro-tekenvelop verzonden naar deelnemers voor de handtekeningverzameling. Voordat u deze actie gebruikt, moeten voor de envelop normaal gesproken documenten, deelnemers en ondertekeningsvelden worden toegevoegd met behulp van Document maken op envelop-id, Deelnemer(s) maken op envelop-id en Veld(en) maken op document-id. Alle documenten in de envelop moeten een geüploade status hebben voordat de envelop kan worden verzonden.

Enveloppen weergeven

Het eindpunt List Envelopes retourneert alle enveloppen die zijn gekoppeld aan een toepassing in een account.

Herinneringen voor envelop verzenden

Hiermee worden herinneringsmeldingen geactiveerd voor deelnemers die in behandeling zijn bij een opgegeven Nitro Sign-envelop. Als er geen meldingsinstellingen worden opgegeven, wordt de standaardmeldingssjabloon gebruikt die is geconfigureerd voor de envelop.

Lijstvelden op document-id

Hiermee worden alle velden opgehaald die zijn gekoppeld aan een specifiek document binnen een Nitro Sign-envelop.

Oorspronkelijke envelop downloaden

Downloadt de oorspronkelijke niet-ondertekende documenten van een Nitro Sign-envelop als een ZIP-archief.

Veld(en) maken op document-id

Hiermee maakt u een of meer velden in een document en wijst u deze toe aan deelnemers. Als u één veld wilt maken, geeft u één item op in de matrix Velden. Als u meerdere velden wilt maken, geeft u meerdere items op.

Veld bijwerken op id

Hiermee worden eigenschappen van een bestaand veld in een Nitro Sign-document bijgewerkt. Het veldtype moet worden opgegeven en moet overeenkomen met het bestaande veldtype; het wordt gebruikt door de API om het veldschema te identificeren en wijzigt het veldtype niet.

Veld verwijderen op id

Hiermee verwijdert u een veld definitief uit een document in een Nitro Sign-envelop.

Verzegeld document downloaden op id

Hiermee downloadt u één verzegeld ondertekend document van een Nitro Sign-envelop als PDF-bestand.

Verzegelde envelop downloaden

Downloadt de verzegelde ondertekende documenten van een Nitro Sign-envelop, samen met het audittrail, als een ZIP-archief.

Audittrail van envelop downloaden

Hiermee downloadt u het PDF-bestand met het volledige audittrail voor de geselecteerde Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan het audittrail moet worden gedownload.

Retouren

Gedownload bestand dat is verpakt als een JSON-envelop.

Deelnemer(s) maken op envelop-id

Voegt een of meer deelnemers toe aan een Nitro Sign-envelop. Als u één deelnemer wilt toevoegen, geeft u één item op in de matrix Deelnemers. Als u meerdere deelnemers wilt toevoegen, geeft u meerdere items op.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop aangeeft waar deelnemers moeten worden toegevoegd.

Email
email True email

Het e-mailadres van de deelnemer.

Role
role True string

De rol van de deelnemer. Een ondertekenaar kan velden hebben toegewezen voor ondertekening. Een cc-deelnemer heeft alleen-lezentoegang.

Verificatietype
type string

Optional. Selecteer een verificatiemethode voor de deelnemer. Indien opgegeven, moet er ook een toegangscode worden opgegeven.

Toegangscode
accessCode string

Alleen vereist wanneer verificatietype is opgegeven. Laat leeg als verificatie van deelnemers niet is vereist.

Retouren

Antwoord geretourneerd na het maken van een of meer deelnemers.

Deelnemer bijwerken op id

Hiermee werkt u de verificatie-instellingen voor een deelnemer in een Nitro Sign-envelop bij. Het e-mailadres van de deelnemer kan niet worden bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met de deelnemer identificeert.

Deelnemer-id
participantID True uuid

Een unieke UUID die de deelnemer identificeert die moet worden bijgewerkt.

Verificatietype
type string

Optional. Selecteer een verificatiemethode voor de deelnemer. Indien opgegeven, moet er ook een toegangscode worden opgegeven.

Toegangscode
accessCode string

Alleen vereist wanneer verificatietype is opgegeven. Laat leeg als verificatie van deelnemers niet is vereist.

Retouren

Details van Nitro Sign-deelnemer.

Deelnemer verwijderen op id

Hiermee verwijdert u een deelnemer definitief uit een Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met de deelnemer identificeert.

Deelnemer-id
participantID True uuid

Een unieke UUID die de deelnemer identificeert die moet worden verwijderd.

Deelnemers weergeven op envelop-id

Haalt alle deelnemers op die zijn gekoppeld aan een specifieke Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan de deelnemers moeten worden opgehaald.

Retouren

Antwoord geretourneerd bij het weergeven van deelnemers die zijn gekoppeld aan een Nitro Sign-envelop.

Document bijwerken op id

Hiermee werkt u de metagegevens van een bestaand document bij in een Nitro Sign-envelop. Op dit moment kan alleen de documentnaam worden bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID waarmee het document wordt geïdentificeerd dat moet worden bijgewerkt.

Documentnaam
name True string

De nieuwe naam voor het document.

Retouren

Nitro Sign-documentdetails.

Document maken op envelop-id

Uploadt een document naar een bestaande Nitro Sign-envelop. Het document kan later worden gebruikt in de werkstroom voor ondertekening.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop aangeeft waar het document wordt geüpload.

Documentnaam
documentName True string

De naam van het te uploaden document. Deze waarde wordt gebruikt om de metagegevens van het document te bouwen die naar Nitro worden verzonden.

Inhoudstype
contentType string

Het inhoudstype van het geüploade document. Voor PDF-bestanden gebruikt u application/pdf. Wanneer deze worden weggelaten uit de metagegevens, worden alleen PDF-bestanden geaccepteerd.

Documentbestand
payload True file

Het documentbestand dat naar de envelop moet worden geüpload.

Retouren

Name Pad Type Description
Document-ID
ID uuid

Een unieke UUID die het geüploade document identificeert.

Documentnaam
name string

De naam van het geüploade document.

Gemaakt op
createdAt string

Tijdstempel die aangeeft wanneer het document is gemaakt.

Documentstatus
status string

De verwerkingsstatus van het geüploade document.

Document ophalen op id

Hiermee worden details opgehaald voor een specifiek document in een Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID die het document identificeert dat moet worden opgehaald.

Retouren

Nitro Sign-documentdetails.

Document verwijderen op id

Hiermee verwijdert u een document definitief uit een Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID waarmee het document wordt geïdentificeerd dat moet worden verwijderd.

Documenten opnieuw ordenen op envelop-id

Hiermee rangschikt u de volgorde van documenten die zijn gekoppeld aan een specifieke Nitro Sign-envelop op basis van de opgegeven lijst met document-id's.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan de documenten opnieuw moeten worden gerangschikt.

Document-ID's
order True array of uuid

Een matrix met document-id's die de nieuwe volgorde van documenten in de envelop vertegenwoordigen.

Retouren

Antwoord geretourneerd bij het weergeven van documenten die zijn gekoppeld aan een Nitro Sign-envelop.

Documenten weergeven op envelop-id

Hiermee haalt u alle documenten op die zijn gekoppeld aan een specifieke Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan de documenten moeten worden opgehaald.

Retouren

Antwoord geretourneerd bij het weergeven van documenten die zijn gekoppeld aan een Nitro Sign-envelop.

Envelop annuleren op id

Annuleert de ondertekeningsaanvraag voor een Nitro Sign-envelop. Alleen enveloppen die zijn verzonden voor ondertekening, kunnen worden geannuleerd.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die moet worden geannuleerd.

Retouren

Antwoord geretourneerd nadat een Nitro Sign-envelop is aangevraagd of gemaakt.

Envelop bijwerken

Hiermee werkt u een bestaande Nitro Sign-envelop bij. U kunt de naam van de envelop, meldingsinstellingen, de ondertekeningsmodus of een combinatie van deze velden wijzigen.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die moet worden bijgewerkt.

Envelopnaam
name string

De bijgewerkte envelopnaam. Het hoeft niet uniek te zijn.

Meldingsonderwerp
subject string

De onderwerpregel van de e-mailmelding die is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: $(sender_name_or_email) vraagt uw handtekening aan.

Hoofdtekst van melding
body string

De hoofdtekst van het e-mailbericht dat is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: Hallo,\nOnderteken de $(envelope_name)\nBedankt,\n$(sender_name_or_email).

Ondertekeningsmodus
mode string

Hiermee definieert u de ondertekeningsvolgorde. Gebruik parallel om alle deelnemers tegelijkertijd op de hoogte te stellen, of opeenvolgend om deelnemers één voor één op de hoogte te stellen in de volgorde waarin ze zijn toegevoegd.

Retouren

Antwoord geretourneerd nadat een Nitro Sign-envelop is aangevraagd of gemaakt.

Envelop maken

Hiermee maakt u een nieuwe Nitro Sign-envelop die later kan worden gevuld met documenten, deelnemers, velden en verzonden voor ondertekening.

Parameters

Name Sleutel Vereist Type Description
Envelopnaam
name True string

De naam van de envelop. Het hoeft niet uniek te zijn.

Ondertekeningsmodus
mode True string

Hiermee definieert u de ondertekeningsvolgorde. Gebruik parallel om alle deelnemers tegelijkertijd op de hoogte te stellen, of opeenvolgend om deelnemers één voor één op de hoogte te stellen in de volgorde waarin ze zijn toegevoegd.

Meldingsonderwerp
subject True string

De onderwerpregel van de e-mailmelding die is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: $(sender_name_or_email) vraagt uw handtekening aan.

Hoofdtekst van melding
body True string

De hoofdtekst van het e-mailbericht dat is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: Hallo,\nOnderteken de $(envelope_name)\nBedankt,\n$(sender_name_or_email).

Retouren

Antwoord geretourneerd nadat een Nitro Sign-envelop is aangevraagd of gemaakt.

Envelop ophalen op id

Hiermee haalt u details op voor een specifieke Nitro Sign-envelop met behulp van de unieke envelop-id.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die moet worden opgehaald.

Retouren

Antwoord geretourneerd nadat een Nitro Sign-envelop is aangevraagd of gemaakt.

Envelop verwijderen op id

Hiermee verwijdert u definitief een Nitro Sign-envelop. Deze bewerking kan niet ongedaan worden gemaakt en alle gekoppelde documenten, velden en deelnemers worden ook verwijderd.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die moet worden verwijderd.

Envelop verzenden voor ondertekening

Hiermee wordt een Nitro-tekenvelop verzonden naar deelnemers voor de handtekeningverzameling. Voordat u deze actie gebruikt, moeten voor de envelop normaal gesproken documenten, deelnemers en ondertekeningsvelden worden toegevoegd met behulp van Document maken op envelop-id, Deelnemer(s) maken op envelop-id en Veld(en) maken op document-id. Alle documenten in de envelop moeten een geüploade status hebben voordat de envelop kan worden verzonden.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die moet worden verzonden voor ondertekening.

Retouren

Samenvattingsinformatie over een Nitro Sign-envelop.

Enveloppen weergeven

Het eindpunt List Envelopes retourneert alle enveloppen die zijn gekoppeld aan een toepassing in een account.

Parameters

Name Sleutel Vereist Type Description
Pagina na
pageAfter string

Optioneel cursortoken dat wordt gebruikt om de volgende pagina enveloppen op te halen. Gebruik de nextPage-waarde die wordt geretourneerd door het vorige antwoord.

Pagina vóór
pageBefore string

Optioneel cursortoken dat wordt gebruikt om de vorige pagina met enveloppen op te halen. Gebruik niet samen met Page After.

Retouren

Name Pad Type Description
Enveloppen
items array of EnvelopeSummaryResponse

De lijst met enveloppen.

Volgende pagina
nextPage string

Cursortoken dat kan worden gebruikt als Pagina Na om de volgende pagina van enveloppen op te halen.

Herinneringen voor envelop verzenden

Hiermee worden herinneringsmeldingen geactiveerd voor deelnemers die in behandeling zijn bij een opgegeven Nitro Sign-envelop. Als er geen meldingsinstellingen worden opgegeven, wordt de standaardmeldingssjabloon gebruikt die is geconfigureerd voor de envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvoor herinneringsmeldingen moeten worden verzonden.

Meldingsonderwerp
subject string

De onderwerpregel van de e-mailmelding die is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: $(sender_name_or_email) vraagt uw handtekening aan.

Hoofdtekst van melding
body string

De hoofdtekst van het e-mailbericht dat is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: Hallo,\nOnderteken de $(envelope_name)\nBedankt,\n$(sender_name_or_email).

Lijstvelden op document-id

Hiermee worden alle velden opgehaald die zijn gekoppeld aan een specifiek document binnen een Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID die het document identificeert waarvan de velden moeten worden opgehaald.

Retouren

Antwoord geretourneerd na het maken van een of meer velden.

Oorspronkelijke envelop downloaden

Downloadt de oorspronkelijke niet-ondertekende documenten van een Nitro Sign-envelop als een ZIP-archief.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan de oorspronkelijke documenten moeten worden gedownload.

Retouren

Gedownload bestand dat is verpakt als een JSON-envelop.

Veld(en) maken op document-id

Hiermee maakt u een of meer velden in een document en wijst u deze toe aan deelnemers. Als u één veld wilt maken, geeft u één item op in de matrix Velden. Als u meerdere velden wilt maken, geeft u meerdere items op.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert.

Document-ID
documentID True uuid

Een unieke UUID die het document aangeeft waar velden moeten worden gemaakt.

Deelnemer-id
participantID True uuid

De unieke id van de deelnemer die aan het veld is toegewezen.

Pagina
page True integer

Het paginanummer waar het veld moet worden geplaatst. Pagina's maken gebruik van indexering op basis van 1, dus de eerste pagina is 1.

Veldtype
type True string

Het type veld dat moet worden gemaakt.

X-positie
x True float

De horizontale positie van het veld, gemeten vanaf de linkerrand van de pagina in punten.

Y-positie
y True float

De verticale positie van het veld, gemeten vanaf de bovenrand van de pagina in punten.

Breedte
width True float

De breedte van het veld in punten.

Hoogte
height True float

De hoogte van het veld in punten.

Required
required boolean

Geeft aan of de deelnemer dit veld moet voltooien.

Format
format string

Optionele indeling voor veldtypen die ondersteuning bieden voor opmaak, bijvoorbeeld datumvelden. Voorbeeld: MM/DD/JJJJ.

Wijzigbaar
modifiable boolean

Hiermee wordt aangegeven of de veldwaarde kan worden gewijzigd door de deelnemer, waarbij dit wordt ondersteund door het veldtype.

Retouren

Antwoord geretourneerd na het maken van een of meer velden.

Veld bijwerken op id

Hiermee worden eigenschappen van een bestaand veld in een Nitro Sign-document bijgewerkt. Het veldtype moet worden opgegeven en moet overeenkomen met het bestaande veldtype; het wordt gebruikt door de API om het veldschema te identificeren en wijzigt het veldtype niet.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID die het document met het veld identificeert.

Veld-id
fieldID True uuid

Een unieke UUID die het veld identificeert dat moet worden bijgewerkt.

Veldtype
type True string

Het huidige type van het veld dat wordt bijgewerkt. Deze waarde is vereist voor de API en moet overeenkomen met het bestaande veldtype. het veldtype wordt niet gewijzigd.

Deelnemer-id
participantID uuid

De unieke id van de deelnemer die aan het veld is toegewezen.

Pagina
page integer

Het paginanummer waar het veld wordt weergegeven. Pagina's maken gebruik van indexering op basis van 1.

X-positie
x float

Optional. De horizontale positie van het veld, gemeten vanaf de linkerrand van de pagina in punten.

Y-positie
y float

Optional. De verticale positie van het veld, gemeten vanaf de bovenrand van de pagina in punten.

Breedte
width float

Optional. De breedte van het veld in punten.

Hoogte
height float

Optional. De hoogte van het veld in punten.

Required
required boolean

Geeft aan of de deelnemer dit veld moet voltooien.

Format
format string

De veldindeling, indien van toepassing. Datumvelden kunnen bijvoorbeeld een notatie zoals MM/DD/JJJJ gebruiken.

Wijzigbaar
modifiable boolean

Geeft aan of de veldwaarde kan worden gewijzigd, indien van toepassing.

Retouren

Nitro Sign-velddetails.

Veld verwijderen op id

Hiermee verwijdert u een veld definitief uit een document in een Nitro Sign-envelop.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop met het document identificeert.

Document-ID
documentID True uuid

Een unieke UUID die het document met het veld identificeert.

Veld-id
fieldID True uuid

Een unieke UUID waarmee het veld wordt geïdentificeerd dat moet worden verwijderd.

Verzegeld document downloaden op id

Hiermee downloadt u één verzegeld ondertekend document van een Nitro Sign-envelop als PDF-bestand.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert die het verzegelde document bevat.

Document-ID
documentID True uuid

Een unieke UUID die het verzegelde document identificeert dat moet worden gedownload.

Retouren

Gedownload bestand dat is verpakt als een JSON-envelop.

Verzegelde envelop downloaden

Downloadt de verzegelde ondertekende documenten van een Nitro Sign-envelop, samen met het audittrail, als een ZIP-archief.

Parameters

Name Sleutel Vereist Type Description
Envelop-id
envelopeID True uuid

Een unieke UUID die de envelop identificeert waarvan de verzegelde documenten moeten worden gedownload.

Retouren

Gedownload bestand dat is verpakt als een JSON-envelop.

Definities

EnvelopNotification

E-mailinstellingen voor meldingen voor een Nitro Sign-envelop.

Name Pad Type Description
Meldingsonderwerp
subject string

De onderwerpregel van de e-mailmelding die is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: $(sender_name_or_email) vraagt uw handtekening aan.

Hoofdtekst van melding
body string

De hoofdtekst van het e-mailbericht dat is verzonden naar deelnemers aan het ondertekenen. Dynamische variabelen worden ondersteund, bijvoorbeeld: Hallo,\nOnderteken de $(envelope_name)\nBedankt,\n$(sender_name_or_email).

EnvelopSummaryResponse

Samenvattingsinformatie over een Nitro Sign-envelop.

Name Pad Type Description
Envelop-id
ID uuid

Een unieke UUID die de envelop identificeert.

Gemaakt op
createdAt date-time

UTC-tijdstempel die aangeeft wanneer de envelop is gemaakt.

Laatst gewijzigd op
lastModifiedAt date-time

UTC-tijdstempel die aangeeft wanneer de envelop voor het laatst is gewijzigd.

Envelopnaam
name string

De naam van de envelop.

Envelopstatus
status string

De interne status van de envelop.

EnvelopResponse

Antwoord geretourneerd nadat een Nitro Sign-envelop is aangevraagd of gemaakt.

Name Pad Type Description
Envelop-id
ID uuid

Een unieke UUID die de envelop identificeert.

Gemaakt op
createdAt date-time

UTC-tijdstempel die aangeeft wanneer de envelop is gemaakt.

Laatst gewijzigd op
lastModifiedAt date-time

UTC-tijdstempel die aangeeft wanneer de envelop voor het laatst is gewijzigd.

Envelopnaam
name string

De naam van de envelop.

Envelopstatus
status string

De interne status van de envelop.

Ondertekeningsmodus
mode string

De ondertekeningsmodus die is geconfigureerd voor de envelop.

bekendmaking
notification EnvelopeNotification

E-mailinstellingen voor meldingen voor een Nitro Sign-envelop.

ListDocumentsByEnvelopeIDResponse

Antwoord geretourneerd bij het weergeven van documenten die zijn gekoppeld aan een Nitro Sign-envelop.

Name Pad Type Description
Documents
items array of DocumentResponse

De lijst met documenten die aan de envelop zijn gekoppeld.

DocumentResponse

Nitro Sign-documentdetails.

Name Pad Type Description
Document-ID
ID uuid

Een unieke UUID die het document identificeert.

Documentnaam
name string

De naam van het document.

Gemaakt op
createdAt date-time

UTC-tijdstempel die aangeeft wanneer het document is gemaakt.

Grootte in bytes
sizeBytes integer

De documentgrootte in bytes.

Aantal pagina's
numPages integer

Het aantal pagina's in het document.

Documentstatus
status string

De huidige status van het document.

FieldsResponse

Antwoord geretourneerd na het maken van een of meer velden.

Name Pad Type Description
Fields
items array of FieldResponse

De velden die in deze aanvraag zijn gemaakt.

FieldResponse

Nitro Sign-velddetails.

Name Pad Type Description
Veld-id
ID uuid

Een unieke UUID die het veld identificeert.

Deelnemer-id
participantID uuid

De unieke id van de deelnemer die aan het veld is toegewezen.

Document-ID
documentID uuid

De unieke id van het document waartoe het veld behoort.

Pagina
page integer

Het paginanummer waar het veld wordt weergegeven.

Omsluitend kader
boundingBox array of float

Een matrix van vier getallen in de notatie [x, y, breedte, hoogte], gemeten in punten.

Required
required boolean

Geeft aan of de deelnemer dit veld moet voltooien.

Veldtype
type string

Het type veld.

Format
format string

De veldindeling, indien van toepassing.

Wijzigbaar
modifiable boolean

Geeft aan of de veldwaarde kan worden gewijzigd, indien van toepassing.

Deelnemers reageren

Antwoord geretourneerd na het maken van een of meer deelnemers.

Name Pad Type Description
Deelnemers
items array of ParticipantResponse

De deelnemers die in deze aanvraag zijn gemaakt.

ParticipantsListResponse

Antwoord geretourneerd bij het weergeven van deelnemers die zijn gekoppeld aan een Nitro Sign-envelop.

Name Pad Type Description
Deelnemers
items array of ParticipantResponse

De deelnemers die aan de envelop zijn gekoppeld.

Totaal aantal deelnemers
total integer

Het totale aantal deelnemers dat beschikbaar is in de verzameling.

ParticipantResponse

Details van Nitro Sign-deelnemer.

Name Pad Type Description
Deelnemer-id
ID uuid

Een unieke UUID die de deelnemer identificeert.

Email
email email

Het e-mailadres van de deelnemer.

Role
role string

De rol van de deelnemer.

authentication
authentication ParticipantAuthenticationResponse

Verificatie-instellingen die worden geretourneerd voor een deelnemer.

ParticipantAuthenticationResponse

Verificatie-instellingen die worden geretourneerd voor een deelnemer.

Name Pad Type Description
Verificatietype
type string

Het verificatietype van de deelnemer.

Toegangscode
accessCode string

De toegangscode die is geconfigureerd voor de deelnemer.

FileDownloadResponse

Gedownload bestand dat is verpakt als een JSON-envelop.

Name Pad Type Description
Bestandsnaam
fileName string

De naam van het gedownloade bestand, afgeleid van de header Content-Disposition (bijvoorbeeld result.zip of result.pdf). Zet dit token rechtstreeks neer in de bestandsnaaminvoer van een downstreamactie, zoals OneDrive of SharePoint Bestand maken.

Bestandsinhoudstype
fileContentType string

Het MIME-type van het gedownloade bestand, bijvoorbeeld toepassing/zip of toepassing/pdf.

Bestandsinhoud
fileContent byte

De met Base64 gecodeerde bestandsinhoud. Zet dit token rechtstreeks neer in de invoer van bestandsinhoud van een downstreamactie (bijvoorbeeld OneDrive of SharePoint Bestand maken of een andere Nitro-actie) - geen expressie vereist.