Nitro Sign (Pré-visualização)

A Nitro Sign API permite fluxos de trabalho seguros e completos de assinatura eletrónica, permitindo que as aplicações criem, geram e acompanhem processos de assinatura digital. Oferece capacidades para criar envelopes, carregar documentos, adicionar participantes, definir a ordem de assinatura e enviar documentos para assinatura através de uma abordagem totalmente automatizada e orientada por API.

Este conector está disponível nos seguintes produtos e regiões:

Service Class Regiões
Estúdio Copiloto Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões Azure Government
     - Regiões Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões Power Apps exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contact
Name Suporte Nitro
URL https://www.gonitro.com/support
Email prosupport@sfdc.gonitro.com
Metadados do conector
Editora Nitro PDF
Sítio Web https://www.gonitro.com/
Política de privacidade https://www.gonitro.com/legal/privacy-policy
Categorias Produtividade; Operações de TI

Conector Nitro Sign

Descrição geral

O conector Nitro Sign permite fluxos de trabalho eSignature seguros e de ponta a ponta diretamente do Power Automate e Power Apps. Permite às aplicações criar e gerir envelopes de assinatura, carregar e reordenar documentos, adicionar participantes e definir a ordem de assinatura, colocar campos de assinatura e dados, enviar documentos para assinatura, acompanhar o progresso e descarregar os ficheiros originais, selados e de registo de auditoria — tudo através de uma abordagem totalmente automatizada e orientada por API.

Publisher: Software Nitro

Pré-requisitos

Para usar o Nitro Sign através deste conector, vai precisar de:

  • Uma conta Nitro com o Nitro Sign ativado
    https://developers.gonitro.com/
  • Um plano Microsoft PowerApps ou Power Automate com capacidades de Conector Personalizado.

Authentication

O Nitro Sign utiliza OAuth 2.0 máquina-a-máquina com a concessão de Credenciais do Cliente para gerar tokens de acesso para pedidos de API.

Como funciona

  • Cria uma aplicação API no portal de autoatendimento da Nitro e obtém o ID do Cliente e o Secret do Cliente associados.
  • O conector autentica-se trocando estas credenciais por um token de acesso Portador .
  • O token é então usado para autorizar chamadas subsequentes à API Nitro Sign.

Crie credenciais e leia o guia detalhado:
https://developers.gonitro.com/docs/authentication/credentials

Criar uma ligação no Power Automate / Power Apps

Ao adicionar o conector a um flow ou app:

  1. Clique em Adicionar uma nova ligação.
  2. Introduza o seu ID de Cliente e o Secret do Cliente (emitidos no portal de programadores da Nitro).
  3. Selecione a sua Região Nitro (Europa, Estados Unidos ou APAC) — a região associada à sua conta Nitro.
  4. Guarde a ligação — na primeira utilização, o conector troca o seu ID de Cliente e o Segredo do Cliente por um token de acesso de curta duração usando a concessão de Credenciais de Cliente OAuth 2.0, armazena-o em cache e renova-o automaticamente. As suas credenciais são usadas apenas para obter o token; as chamadas API subsequentes são autenticadas com um token portador em seu nome.

Nota: Não é necessário iniciar sessão interativo com o utilizador; Este fluxo foi concebido para cenários de servidor para servidor / aplicação para aplicação.

Operações suportadas

O conector agrupa as suas ações em torno dos quatro recursos de um fluxo de trabalho de assinatura — Envelopes, Documentos, Campos e Participantes — além de um conjunto de ações de Download para recuperar ficheiros finalizados.

1. Envelopes

Um envelope é o recipiente para os documentos, participantes e campos num único pedido de assinatura.

  • Envelopes de Lista
    Devolve todos os envelopes associados à candidatura na conta. Os resultados são paginados: a resposta inclui um token de cursor da Página Seguinte , que pode fornecer ao parâmetro opcional Página Depois para recuperar a página seguinte (ou Página Antes para a página invertida). Ambos os parâmetros do cursor estão em Avançado e só são necessários ao percorrer grandes conjuntos de resultados.

  • Criar Envelope
    Cria um novo envelope com um nome, mensagem de notificação (sujeito + corpo, com variáveis dinâmicas como $(sender_name_or_email) e $(envelope_name)), e modo de assinatura:

    • parallel — todos os participantes são notificados ao mesmo tempo e podem assinar de forma independente.
    • sequential — os participantes são notificados um de cada vez, pela ordem em que foram adicionados.

  • Obtenha o envelope por identificação
    Recupera detalhes de um envelope específico pelo seu UUID.

  • Envelope de Atualização
    Atualiza o nome do envelope, as definições de notificação e/ou o modo de assinatura. Todos os campos são opcionais.

  • Eliminar envelope por ID
    Elimina permanentemente um envelope e todos os documentos, campos e participantes associados. Isto não pode ser desfeito.

  • Enviar o envelope para assinatura
    Envia o envelope aos participantes para recolha de assinaturas. Antes de enviar, o envelope deve normalmente ter os seus documentos, participantes e campos de assinatura adicionados (via Criar Documento pelo ID do Envelope, Criar Participante(s) pelo ID do Envelope e Criar Campo(s) pelo ID do Documento). Todos os documentos no envelope devem ter um estado carregado antes de o envelope poder ser enviado.

  • Enviar Lembretes para o Envelope
    Ativa notificações de lembretes para participantes pendentes. Se não forem fornecidas definições de notificação, utiliza-se o modelo de notificação predefinido configurado para o envelope.

  • Cancelar envelope por ID
    Cancela o pedido de assinatura. Apenas envelopes que já tenham sido enviados para assinatura podem ser cancelados.

2. Documentos

Os documentos são os ficheiros anexados a um envelope e assinados pelos participantes.

  • Liste Documentos por ID do Envelope
    Recupera todos os documentos associados a um envelope.

  • Criar Documento pelo ID do Envelope
    Carrega um documento num envelope existente. Fornece o ficheiro mais campos simples e digitados — sem JSON manuscrito:

    • Ficheiro de Documento — o ficheiro a carregar.
    • Nome do Documento — o nome sob o qual se deve guardar o documento.
    • Tipo de Conteúdo(avançado, opcional) — o tipo MIME do ficheiro; por defeito para application/pdf. Quando omitidos, apenas ficheiros PDF são aceites.

  • Obtenha Documento por Identificação
    Recupera os detalhes de um documento específico num envelope.

  • Atualizar o Documento por ID
    Atualiza os metadados do documento. Atualmente, apenas o nome do documento pode ser alterado.

  • Apagar Documento por ID
    Apaga permanentemente um documento de um envelope.

  • Reordenar Documentos por ID do Envelope
    Reordena os documentos num envelope com base numa lista fornecida de IDs de documentos.

3. Campos

Os campos são os elementos interativos (assinatura, iniciais, data, etc.) colocados num documento e atribuídos a um participante.

  • Listar Campos por ID do Documento
    Recupera todos os campos associados a um documento específico.

  • Criar campo(s) por ID de documento
    Cria um ou mais campos num documento e atribui-os aos participantes. Fornece um item para um único campo, ou vários itens para um pedido em massa. Cada campo especifica:

    • participantID — o participante atribuído ao campo.
    • type — um de signature, initials, name, date, title, company, checkbox, custom.
    • page — o número da página (indexação baseada em 1).
    • Posição X, Posição Y, Largura, Altura — a posição e o tamanho do campo, cada um inserido como um número separado em pontos (X/Y são medidos a partir da borda esquerda/superior da página). Estes substituem o array único boundingBox anterior, por isso cada valor é um campo tipado na interface em vez de uma lista construída à mão.
    • Opcional: required (por defeito true), e — em Advanced — format (por exemplo, MM/DD/YYYY para campos de data) e modifiable.

  • Atualizar campo por ID
    Atualiza propriedades de um campo existente. O campo type deve ser fornecido e deve corresponder ao tipo de campo existente — é usado para identificar o esquema do campo e não altera o tipo de campo.

  • Eliminar campo por ID
    Apaga permanentemente um campo de um documento.

4. Participantes

Os participantes são as pessoas que recebem o envelope — seja para o assinar ou para serem mantidas informadas.

  • Liste os participantes por ID do envelope
    Recolhe todos os participantes associados a um envelope.

  • Criar(es) Participante(s) por ID de Envelope
    Adiciona um ou mais participantes a um envelope. Forneça um item para um único participante, ou vários itens para um pedido em massa. Cada participante especifica:

    • email — o endereço de email do participante.
    • role — signer (pode ter campos atribuídos para assinatura) ou cc (acesso apenas de leitura).
    • authentication (avançado, opcional) — atualmente Código de Acesso: um código de acesso estático que o participante deve fornecer antes de assinar. Abra esta secção apenas se o participante tiver de autenticar antes de assinar.

  • Atualizar o participante por ID
    Atualiza as definições de autenticação do participante. O email do participante não pode ser alterado.

  • Eliminar Participante por ID
    Apaga permanentemente um participante de um envelope.

5. Downloads

Recupere os ficheiros terminados assim que os documentos forem assinados e selados.

  • Descarregar o envelope original
    Descarrega os documentos originais não assinados de um envelope como arquivo ZIP .

  • Descarregar envelope selado
    Descarrega os documentos selados e assinados, juntamente com o registo de auditoria, como um arquivo ZIP .

  • Descarregar Documento Selado por ID
    Descarrega um único documento selado e assinado como ficheiro PDF .

  • Descarregar o Registo de Auditoria do Envelope
    Descarrega o registo completo de auditoria de um envelope em ficheiro PDF .

As ações de download expõem tokens nativos de Nome de Ficheiro e Conteúdo de Ficheiro (mais Tipo de Conteúdo de Ficheiro). Coloque o Conteúdo do Ficheiro diretamente na entrada do ficheiro de uma etapa posterior — por exemplo, OneDrive / SharePoint Create File — e o Nome do Ficheiro na entrada do nome do ficheiro. Não é necessário body('Action_Name') nenhum nome de ficheiro de expressão ou digitado manualmente; o conector envolve o ZIP ou PDF descarregado num envelope JSON, pelo que o Power Automate apresenta estes como tokens de conteúdo dinâmico comuns.

Fluxo de Trabalho Típico de Assinatura

Um fluxo completo de assinatura encadeia as ações acima por ordem. Um fluxo comum do Power Automate é o seguinte:

  1. Criar Envelope — defina o nome, assunto/corpo da notificação e modo de assinatura (parallel ou sequential). Guarde o ID do envelope devolvido.
  2. Criar Documento pelo ID do Envelope — carregue um ou mais ficheiros para o envelope (usando o ID do Envelope do passo 1). Guardar cada ID de documento devolvido.
    (Opcional)Reordenar Documentos por ID do Envelope — definir a ordem dos documentos.
  3. Crie(s) Participante(s) pelo ID do Envelope — adicione os signatários e os destinatários do CC, com a autenticação do seu código de acesso. Guarde cada ID de participante devolvido.
  4. Criar campo(s) por ID do documento — coloque campos de assinatura/data/etc. em cada documento e atribua-os aos participantes (usando o ID do documento do passo 2 e o ID do participante do passo 3).
  5. Envie o envelope para assinatura — despache o envelope. Todos os documentos devem estar primeiro no estado carregado.
  6. (Enquanto pendente)Enviar Lembretes para o Envelope para incentivar os participantes, ou Cancelar o Envelope por ID para impedir o pedido.
  7. (Quando concluído)Descarregar envelope / selado Descarregar documento selado por ID / Descarregar o rasto de auditoria do envelope para recuperar os ficheiros finalizados.

Dica: O ID do Envelope, ID do Documento e ID do Participante devolvidos pelas ações de criação fluem naturalmente para as ações posteriores através do seletor de conteúdo dinâmico do Power Automate — escolha o token ID da ação a montante em vez de o escrever.

Erros & Limitação

A API do Nitro Sign pode devolver os seguintes erros:

  • 400 — Mau pedido
  • 401 — Não autorizado
  • 404 — Não encontrado
  • 409 — Conflito (por exemplo, agir sobre um envelope num estado que não permite a operação)
  • 413 — Conteúdo demasiado grande
  • 415 — Tipo de media não suportado
  • 422 — Entidade não processável
  • 500 — Erro interno do servidor

Throttling

  • Chamadas API por ligação: 100 por 60 segundos.

Limites das Plataformas

Tamanho do Ficheiro

  • Máximo: 25 MB por pedido
    Aplica-se tanto a operações de ficheiro único como de múltiplos ficheiros.

Contagem de Páginas

  • Máximo: 250 páginas por documento individual
    O total combinado de páginas em vários documentos pode exceder as 250.

Tempo de Retenção

  • Os ficheiros de entrada e saída são eliminados ~15 minutos após a conclusão da operação.

Notes

  • As ações de envelope, documento, campo e gestão de participantes devolvem JSON.
  • As ações de download retornam o ficheiro (ZIP ou PDF) embrulhado num envelope JSON, expondo o Nome do Ficheiro, Tipo de Conteúdo do Ficheiro e Conteúdo do Ficheiro como tokens nativos do seletor, permitindo que os resultados sejam encadeados numa ação de ficheiro a jusante sem expressões.
  • O modo de assinatura (parallel vs sequential) é definido quando o envelope é criado e pode ser alterado com Update Envelope antes do envelope ser enviado.
  • Atualmente, a autenticação dos participantes suporta apenas Código de Acesso .

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Name Tipo Descrição Required
ID de Cliente Nitro securestring ID de Cliente da sua aplicação Nitro Verdade
Nitro Client Secret securestring O Segredo do Cliente da sua aplicação Nitro Verdade
Região Nitro cadeia (de caracteres) Selecione a região da API Nitro para a sua conta. Verdade

Ações

Apagar Documento por ID

Apaga permanentemente um documento de um envelope do Nitro Sign.
Atualizar campo por ID

Atualiza propriedades de um campo existente num documento Nitro Sign. O tipo de campo deve ser fornecido e deve corresponder ao tipo de campo existente; é usado pela API para identificar o esquema do campo e não altera o tipo de campo.
Atualizar o Documento por ID

Atualiza os metadados de um documento existente dentro de um envelope Nitro Sign. Atualmente, apenas o nome do documento pode ser atualizado.
Atualizar o participante por ID

Atualiza as definições de autenticação para um participante num envelope Nitro Sign. O email do participante não pode ser atualizado.
Cancelar envelope por ID

Cancela o pedido de assinatura de um envelope Nitro Sign. Apenas envelopes enviados para assinatura podem ser cancelados.
Criar(es) Participante(s) por ID de Envelope

Adiciona um ou mais participantes a um envelope do Nitro Sign. Para adicionar um único participante, inclua um item no array de Participantes. Para adicionar múltiplos participantes, forneça vários itens.
Criar campo(s) por ID de documento

Cria um ou mais campos num documento e atribui-os aos participantes. Para criar um único campo, forneça um item no array de Campos. Para criar múltiplos campos, forneça múltiplos itens.
Criar Documento pelo ID do Envelope

Carrega um documento num envelope Nitro Sign existente. O documento pode ser posteriormente utilizado no fluxo de trabalho de assinatura.
Criar envelope

Cria um novo envelope Nitro Sign que pode ser posteriormente preenchido com documentos, participantes, campos e enviado para assinatura.
Descarregar Documento Selado por ID

Descarrega um único documento selado e assinado de um envelope Nitro Sign em formato PDF.
Descarregar envelope selado

Descarrega os documentos selados e assinados de um envelope Nitro Sign, juntamente com o registo de auditoria, como arquivo ZIP.
Descarregar o envelope original

Descarrega os documentos originais não assinados de um envelope Nitro Sign como arquivo ZIP.
Descarregar o Registo de Auditoria do Envelope

Descarrega o ficheiro PDF com o registo completo da auditoria do envelope selecionado do Nitro Sign.
Eliminar campo por ID

Apaga permanentemente um campo de um documento dentro de um envelope do Nitro Sign.
Eliminar envelope por ID

Apaga permanentemente um envelope do Nitro Sign. Esta operação não pode ser desfeita, e todos os documentos, campos e participantes associados também são eliminados.
Eliminar Participante por ID

Apaga permanentemente um participante de um envelope do Nitro Sign.
Envelope de Atualização

Atualiza um envelope existente do Nitro Sign. Pode modificar o nome do envelope, as definições de notificação, o modo de assinatura ou qualquer combinação destes campos.
Envelopes de Lista

O endpoint List Envelopes devolve todos os envelopes associados a uma aplicação numa conta.
Enviar Lembretes para o Envelope

Dispara notificações de lembrete aos participantes pendentes de um envelope específico do Nitro Sign. Se não forem fornecidas definições de notificação, utiliza-se o modelo de notificação predefinido configurado para o envelope.
Enviar o envelope para assinatura

Envia um envelope Nitro Sign aos participantes para recolha de assinaturas. Antes de usar esta ação, o envelope deve normalmente ter documentos, participantes e campos de assinatura adicionados usando Criar Documento por ID de Envelope, Criar Participante por ID de Envelope e Criar Campo(s) por ID de Documento. Todos os documentos no envelope devem ter um estado carregado antes de o envelope poder ser enviado.
Listar Campos por ID do Documento

Recupera todos os campos associados a um documento específico dentro de um envelope Nitro Sign.
Liste Documentos por ID do Envelope

Recupera todos os documentos associados a um envelope específico do Nitro Sign.
Liste os participantes por ID do envelope

Recolhe todos os participantes associados a um envelope específico do Nitro Sign.
Obtenha Documento por Identificação

Recupera detalhes de um documento específico num envelope Nitro Sign.
Obtenha o envelope por identificação

Recupera detalhes de um envelope específico do Nitro Sign usando o seu ID de envelope único.
Reordenar Documentos por ID do Envelope

Reordena documentos associados a um envelope específico do Nitro Sign com base na lista fornecida de IDs de documentos.

Apagar Documento por ID

ID da Operação:
DeleteDocumentByID

Apaga permanentemente um documento de um envelope do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento a eliminar.

Atualizar campo por ID

ID da Operação:
UpdateFieldByID

Atualiza propriedades de um campo existente num documento Nitro Sign. O tipo de campo deve ser fornecido e deve corresponder ao tipo de campo existente; é usado pela API para identificar o esquema do campo e não altera o tipo de campo.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento que contém o campo.
ID do campo
 fieldID True uuid

Um UUID único que identifica o campo a atualizar.
Tipo de campo
 type True string

O tipo atual do campo a ser atualizado. Este valor é exigido pela API e deve corresponder ao tipo de campo existente; não altera o tipo de campo.
ID do Participante
 participantID uuid

O identificador único do participante atribuído ao campo.
Página
 page integer

O número da página onde o campo aparece. As páginas usam indexação baseada em 1.
Posição X
 x float

Optional. A posição horizontal do campo, medida a partir da borda esquerda da página em pontos.
Posição Y
 y float

Optional. A posição vertical do campo, medida a partir da borda superior da página em pontos.
Largura
 width float

Optional. A largura do campo em pontos.
Altura
 height float

Optional. A altura do campo em pontos.
Required
 required boolean

Indica se o participante deve preencher este campo.
Format
 format string

O formato do campo, quando aplicável. Por exemplo, os campos de data podem usar um formato como MM/DD/YYYY.
Modificável
 modifiable boolean

Indica se o valor do campo é modificável, quando aplicável.

Devoluções

Detalhes do campo do Nitro Sign.

Body
FieldResponse

Atualizar o Documento por ID

ID da Operação:
UpdateDocumentByID

Atualiza os metadados de um documento existente dentro de um envelope Nitro Sign. Atualmente, apenas o nome do documento pode ser atualizado.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento a atualizar.
Nome do documento
 name True string

O novo nome do documento.

Devoluções

Detalhes do documento Nitro Sign.

Body
DocumentResponse

Atualizar o participante por ID

ID da Operação:
UpdateParticipantByID

Atualiza as definições de autenticação para um participante num envelope Nitro Sign. O email do participante não pode ser atualizado.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o participante.
ID do Participante
 participantID True uuid

Um UUID único que identifica o participante a atualizar.
Tipo de autenticação
 type string

Optional. Selecione um método de autenticação para o participante. Se especificado, deve também ser fornecido um Código de Acesso.
Código de Acesso
 accessCode string

É exigido apenas quando o Tipo de Autenticação é especificado. Deixe em branco se a autenticação dos participantes não for necessária.

Devoluções

Detalhes do participante do Nitro Sign.

Body
ParticipantResponse

Cancelar envelope por ID

ID da Operação:
CancelEnvelopeByID

Cancela o pedido de assinatura de um envelope Nitro Sign. Apenas envelopes enviados para assinatura podem ser cancelados.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope a cancelar.

Devoluções

Resposta devolvida após o pedido ou criação de um envelope Nitro Sign.

Body
EnvelopeResponse

Criar(es) Participante(s) por ID de Envelope

ID da Operação:
CreateParticipantsByEnvelopeID

Adiciona um ou mais participantes a um envelope do Nitro Sign. Para adicionar um único participante, inclua um item no array de Participantes. Para adicionar múltiplos participantes, forneça vários itens.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope onde os participantes devem ser adicionados.
Email
 email True email

O endereço de e-mail do participante.
Função
 role True string

O papel do participante. Um signatário pode ter campos atribuídos para assinar. Um participante de cc tem acesso apenas de leitura.
Tipo de autenticação
 type string

Optional. Selecione um método de autenticação para o participante. Se especificado, deve também ser fornecido um Código de Acesso.
Código de Acesso
 accessCode string

É exigido apenas quando o Tipo de Autenticação é especificado. Deixe em branco se a autenticação dos participantes não for necessária.

Devoluções

A resposta regressou após a criação de um ou mais participantes.

Body
ParticipantsResponse

Criar campo(s) por ID de documento

ID da Operação:
CreateFieldsByDocumentID

Cria um ou mais campos num documento e atribui-os aos participantes. Para criar um único campo, forneça um item no array de Campos. Para criar múltiplos campos, forneça múltiplos itens.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento onde os campos devem ser criados.
ID do Participante
 participantID True uuid

O identificador único do participante atribuído ao campo.
Página
 page True integer

O número da página onde o campo deve ser colocado. As páginas usam indexação baseada em 1, por isso a primeira página é 1.
Tipo de campo
 type True string

O tipo de campo a criar.
Posição X
 x True float

A posição horizontal do campo, medida a partir da borda esquerda da página em pontos.
Posição Y
 y True float

A posição vertical do campo, medida a partir da borda superior da página em pontos.
Largura
 width True float

A largura do campo em pontos.
Altura
 height True float

A altura do campo em pontos.
Required
 required boolean

Indica se o participante deve preencher este campo.
Format
 format string

Formato opcional para tipos de campo que suportam formatação, por exemplo, campos de data. Exemplo: MM/DD/YYYY.
Modificável
 modifiable boolean

Indica se o valor do campo pode ser modificado pelo participante, quando suportado pelo tipo de campo.

Devoluções

A resposta retornava após a criação de um ou mais campos.

Body
FieldsResponse

Criar Documento pelo ID do Envelope

ID da Operação:
CreateDocumentByEnvelopeID

Carrega um documento num envelope Nitro Sign existente. O documento pode ser posteriormente utilizado no fluxo de trabalho de assinatura.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope onde o documento será carregado.
Nome do documento
 documentName True string

O nome do documento a carregar. Este valor será usado para construir os metadados do documento enviados para a Nitro.
Tipo de conteúdo
 contentType string

O tipo de conteúdo do documento carregado. Para ficheiros PDF, use application/pdf. Quando é omitido dos metadados, apenas são aceites ficheiros PDF.
Ficheiro de Documentos
 payload True file

O ficheiro do documento para carregar no envelope.

Devoluções

Name Caminho Tipo Descrição
ID do documento
 ID uuid

Um UUID único que identifica o documento carregado.
Nome do documento
 name string

O nome do documento carregado.
Criado em
 createdAt string

Carimbo temporal que indica quando o documento foi criado.
Estado do documento
 status string

O estado do processamento do documento carregado.

Criar envelope

ID da Operação:
CreateEnvelope

Cria um novo envelope Nitro Sign que pode ser posteriormente preenchido com documentos, participantes, campos e enviado para assinatura.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Nome do envelope
 name True string

O nome do envelope. Não tem de ser único.
Modo de Assinatura
 mode True string

Define a ordem de assinatura. Use o paralelo para notificar todos os participantes ao mesmo tempo, ou sequencialmente para notificar os participantes um a um pela ordem em que foram adicionados.
Sujeito da Notificação
 subject True string

A linha de assunto da notificação por email enviada aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: $(sender_name_or_email) está a pedir a sua assinatura.
Organismo de notificação
 body True string

O corpo do email foi enviado aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: Olá,\nPor favor, assine o $(envelope_name)\nObrigado,\n$(sender_name_or_email).

Devoluções

Resposta devolvida após o pedido ou criação de um envelope Nitro Sign.

Body
EnvelopeResponse

Descarregar Documento Selado por ID

ID da Operação:
DownloadSealedDocumentByID

Descarrega um único documento selado e assinado de um envelope Nitro Sign em formato PDF.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento selado.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento selado para download.

Devoluções

Ficheiro descarregado embalado como envelope JSON.

Body
FileDownloadResponse

Descarregar envelope selado

ID da Operação:
DownloadSealedEnvelope

Descarrega os documentos selados e assinados de um envelope Nitro Sign, juntamente com o registo de auditoria, como arquivo ZIP.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujos documentos selados devem ser descarregados.

Devoluções

Ficheiro descarregado embalado como envelope JSON.

Body
FileDownloadResponse

Descarregar o envelope original

ID da Operação:
DownloadOriginalEnvelope

Descarrega os documentos originais não assinados de um envelope Nitro Sign como arquivo ZIP.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujos documentos originais devem ser descarregados.

Devoluções

Ficheiro descarregado embalado como envelope JSON.

Body
FileDownloadResponse

Descarregar o Registo de Auditoria do Envelope

ID da Operação:
DownloadAuditTrailOfEnvelope

Descarrega o ficheiro PDF com o registo completo da auditoria do envelope selecionado do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujo registo de auditoria deve ser descarregado.

Devoluções

Ficheiro descarregado embalado como envelope JSON.

Body
FileDownloadResponse

Eliminar campo por ID

ID da Operação:
DeleteFieldByID

Apaga permanentemente um campo de um documento dentro de um envelope do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento que contém o campo.
ID do campo
 fieldID True uuid

Um UUID único que identifica o campo a eliminar.

Eliminar envelope por ID

ID da Operação:
DeleteEnvelopeByID

Apaga permanentemente um envelope do Nitro Sign. Esta operação não pode ser desfeita, e todos os documentos, campos e participantes associados também são eliminados.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope a eliminar.

Eliminar Participante por ID

ID da Operação:
DeleteParticipantByID

Apaga permanentemente um participante de um envelope do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o participante.
ID do Participante
 participantID True uuid

Um UUID único que identifica o participante a eliminar.

Envelope de Atualização

ID da Operação:
UpdateEnvelope

Atualiza um envelope existente do Nitro Sign. Pode modificar o nome do envelope, as definições de notificação, o modo de assinatura ou qualquer combinação destes campos.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope a atualizar.
Nome do envelope
 name string

O nome atualizado do envelope. Não tem de ser único.
Sujeito da Notificação
 subject string

A linha de assunto da notificação por email enviada aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: $(sender_name_or_email) está a pedir a sua assinatura.
Organismo de notificação
 body string

O corpo do email foi enviado aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: Olá,\nPor favor, assine o $(envelope_name)\nObrigado,\n$(sender_name_or_email).
Modo de Assinatura
 mode string

Define a ordem de assinatura. Use o paralelo para notificar todos os participantes ao mesmo tempo, ou sequencialmente para notificar os participantes um a um pela ordem em que foram adicionados.

Devoluções

Resposta devolvida após o pedido ou criação de um envelope Nitro Sign.

Body
EnvelopeResponse

Envelopes de Lista

ID da Operação:
ListEnvelopes

O endpoint List Envelopes devolve todos os envelopes associados a uma aplicação numa conta.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Página Depois
 pageAfter string

Token de cursor opcional usado para recuperar a página seguinte de envelopes. Use o valor nextPage devolvido pela resposta anterior.
Página Anterior
 pageBefore string

Token de cursor opcional usado para recuperar a página anterior dos envelopes. Não use junto com o Page After.

Devoluções

Name Caminho Tipo Descrição
Envelopes
 items array of EnvelopeSummaryResponse

A lista de envelopes.
Página Seguinte
 nextPage string

Token cursor que pode ser usado como Page After para recuperar a página seguinte de envelopes.

Enviar Lembretes para o Envelope

ID da Operação:
SendRemindersForEnvelope

Dispara notificações de lembrete aos participantes pendentes de um envelope específico do Nitro Sign. Se não forem fornecidas definições de notificação, utiliza-se o modelo de notificação predefinido configurado para o envelope.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope para o qual devem ser enviadas notificações de lembrete.
Sujeito da Notificação
 subject string

A linha de assunto da notificação por email enviada aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: $(sender_name_or_email) está a pedir a sua assinatura.
Organismo de notificação
 body string

O corpo do email foi enviado aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: Olá,\nPor favor, assine o $(envelope_name)\nObrigado,\n$(sender_name_or_email).

Enviar o envelope para assinatura

ID da Operação:
SendEnvelopeForSigning

Envia um envelope Nitro Sign aos participantes para recolha de assinaturas. Antes de usar esta ação, o envelope deve normalmente ter documentos, participantes e campos de assinatura adicionados usando Criar Documento por ID de Envelope, Criar Participante por ID de Envelope e Criar Campo(s) por ID de Documento. Todos os documentos no envelope devem ter um estado carregado antes de o envelope poder ser enviado.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope a enviar para assinatura.

Devoluções

Informação resumida sobre um envelope do Nitro Sign.

Body
EnvelopeSummaryResponse

Listar Campos por ID do Documento

ID da Operação:
ListFieldsByDocumentID

Recupera todos os campos associados a um documento específico dentro de um envelope Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento cujos campos devem ser recuperados.

Devoluções

A resposta retornava após a criação de um ou mais campos.

Body
FieldsResponse

Liste Documentos por ID do Envelope

ID da Operação:
ListDocumentsByEnvelopeID

Recupera todos os documentos associados a um envelope específico do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujos documentos devem ser recuperados.

Devoluções

Resposta devolvida ao listar documentos associados a um envelope Nitro Sign.

Body
ListDocumentsByEnvelopeIDResponse

Liste os participantes por ID do envelope

ID da Operação:
ListParticipantsByEnvelopeID

Recolhe todos os participantes associados a um envelope específico do Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujos participantes devem ser recuperados.

Devoluções

Resposta devolvida ao listar participantes associados a um envelope do Nitro Sign.

Body
ParticipantsListResponse

Obtenha Documento por Identificação

ID da Operação:
GetDocumentByID

Recupera detalhes de um documento específico num envelope Nitro Sign.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope que contém o documento.
ID do documento
 documentID True uuid

Um UUID único que identifica o documento a recuperar.

Devoluções

Detalhes do documento Nitro Sign.

Body
DocumentResponse

Obtenha o envelope por identificação

ID da Operação:
GetEnvelopeByID

Recupera detalhes de um envelope específico do Nitro Sign usando o seu ID de envelope único.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope a recuperar.

Devoluções

Resposta devolvida após o pedido ou criação de um envelope Nitro Sign.

Body
EnvelopeResponse

Reordenar Documentos por ID do Envelope

ID da Operação:
ReorderDocumentsByEnvelopeID

Reordena documentos associados a um envelope específico do Nitro Sign com base na lista fornecida de IDs de documentos.

Parâmetros

Name Chave Obrigatório Tipo Descrição
Envelope ID
 envelopeID True uuid

Um UUID único que identifica o envelope cujos documentos devem ser reordenados.
Identificadores de Documento
 order True array of uuid

Um conjunto de IDs de documentos que representam a nova ordem dos documentos dentro do envelope.

Devoluções

Resposta devolvida ao listar documentos associados a um envelope Nitro Sign.

Body
ListDocumentsByEnvelopeIDResponse

Definições

EnvelopeNotification

Definições de notificação para um envelope Nitro Sign.

Name Caminho Tipo Descrição
Sujeito da Notificação
 subject string

A linha de assunto da notificação por email enviada aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: $(sender_name_or_email) está a pedir a sua assinatura.
Organismo de notificação
 body string

O corpo do email foi enviado aos participantes que assinam. São suportadas variáveis dinâmicas, por exemplo: Olá,\nPor favor, assine o $(envelope_name)\nObrigado,\n$(sender_name_or_email).

ResumoEnvelopeResposta

Informação resumida sobre um envelope do Nitro Sign.

Name Caminho Tipo Descrição
Envelope ID
 ID uuid

Um UUID único que identifica o envelope.
Criado em
 createdAt date-time

Carimbo temporal UTC indicando quando o envelope foi criado.
Última modificação em
 lastModifiedAt date-time

Carimbo temporal UTC indicando quando o envelope foi modificado pela última vez.
Nome do envelope
 name string

O nome do envelope.
Estado do envelope
 status string

O estado interno do envelope.

EnvelopeResponse

Resposta devolvida após o pedido ou criação de um envelope Nitro Sign.

Name Caminho Tipo Descrição
Envelope ID
 ID uuid

Um UUID único que identifica o envelope.
Criado em
 createdAt date-time

Carimbo temporal UTC indicando quando o envelope foi criado.
Última modificação em
 lastModifiedAt date-time

Carimbo temporal UTC indicando quando o envelope foi modificado pela última vez.
Nome do envelope
 name string

O nome do envelope.
Estado do envelope
 status string

O estado interno do envelope.
Modo de Assinatura
 mode string

O modo de assinatura configurado para o envelope.
notificação
 notification EnvelopeNotification

Definições de notificação para um envelope Nitro Sign.

ListDocumentosPorEnvelopeIDRresponder

Resposta devolvida ao listar documentos associados a um envelope Nitro Sign.

Name Caminho Tipo Descrição
Documents
 items array of DocumentResponse

A lista de documentos associados ao envelope.

DocumentResponse

Detalhes do documento Nitro Sign.

Name Caminho Tipo Descrição
ID do documento
 ID uuid

Um UUID único que identifica o documento.
Nome do documento
 name string

O nome do documento.
Criado em
 createdAt date-time

Carimbo temporal UTC indicando quando o documento foi criado.
Tamanho em Bytes
 sizeBytes integer

O tamanho do documento em bytes.
Número de páginas
 numPages integer

O número de páginas no documento.
Estado do documento
 status string

O estado atual do documento.

FieldsResponse

A resposta retornava após a criação de um ou mais campos.

Name Caminho Tipo Descrição
Fields
 items array of FieldResponse

Os campos criados neste pedido.

FieldResponse

Detalhes do campo do Nitro Sign.

Name Caminho Tipo Descrição
ID do campo
 ID uuid

Um UUID único que identifica o campo.
ID do Participante
 participantID uuid

O identificador único do participante atribuído ao campo.
ID do documento
 documentID uuid

O identificador único do documento a que o campo pertence.
Página
 page integer

O número da página onde o campo aparece.
Caixa delimitadora
 boundingBox array of float

Um array de quatro números no formato [x, y, largura, altura], medido em pontos.
Required
 required boolean

Indica se o participante deve preencher este campo.
Tipo de campo
 type string

O tipo de campo.
Format
 format string

O formato do campo, quando aplicável.
Modificável
 modifiable boolean

Indica se o valor do campo é modificável, quando aplicável.

ParticipantesResposta

A resposta regressou após a criação de um ou mais participantes.

Name Caminho Tipo Descrição
Participants
 items array of ParticipantResponse

Os participantes criados neste pedido.

ParticipantesListaResposta

Resposta devolvida ao listar participantes associados a um envelope do Nitro Sign.

Name Caminho Tipo Descrição
Participants
 items array of ParticipantResponse

Os participantes associados ao envelope.
Total de Participantes
 total integer

O número total de participantes disponíveis na coleção.

ParticipantResposta

Detalhes do participante do Nitro Sign.

Name Caminho Tipo Descrição
ID do Participante
 ID uuid

Um UUID único que identifica o participante.
Email
 email email

O endereço de e-mail do participante.
Função
 role string

O papel do participante.
autenticação
 authentication ParticipantAuthenticationResponse

As definições de autenticação devolviam para um participante.

ParticipanteAuthenticationResponse

As definições de autenticação devolviam para um participante.

Name Caminho Tipo Descrição
Tipo de autenticação
 type string

O tipo de autenticação do participante.
Código de Acesso
 accessCode string

O código de acesso configurado para o participante.

FileDownloadResponse

Ficheiro descarregado embalado como envelope JSON.

Name Caminho Tipo Descrição
Nome do arquivo
 fileName string

O nome do ficheiro descarregado, derivado do cabeçalho Content-Disposition da resposta (por exemplo, result.zip ou result.pdf). Coloque este token diretamente na entrada do Nome do Ficheiro de uma ação posterior, como o OneDrive ou o SharePoint Create File.
Tipo de conteúdo de arquivo
 fileContentType string

O tipo MIME do ficheiro descarregado, por exemplo application/zip ou application/pdf.
Conteúdo do Ficheiro
 fileContent byte

O conteúdo do ficheiro codificado base64. Coloque este token diretamente na entrada de Conteúdo do Ficheiro de uma ação a jusante (por exemplo, OneDrive ou SharePoint Create File, ou outra ação Nitro) – não é necessária expressão.