Sinal de Nitro (versão prévia)
A API do Nitro Sign permite fluxos de trabalho de eSignature seguros de ponta a ponta, permitindo que os aplicativos criem, gerenciem e acompanhem processos de assinatura digital. Ele fornece recursos para criar envelopes, carregar documentos, adicionar participantes, definir a ordem de assinatura e enviar documentos para assinatura por meio de uma abordagem totalmente automatizada e controlada por API.
Esse conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Azure regiões da China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – 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 (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao Nitro |
| URL | https://www.gonitro.com/support |
| prosupport@sfdc.gonitro.com |
| Metadados do conector | |
|---|---|
| Publicador | Nitro PDF |
| Site | https://www.gonitro.com/ |
| Política de privacidade | https://www.gonitro.com/legal/privacy-policy |
| Categories | Produtividade; Operações de TI |
Conector do Sinal de Nitro
Visão geral
O conector do Nitro Sign permite fluxos de trabalho de eSignature seguros de ponta a ponta diretamente de Power Automate e Power Apps. Ele permite que os aplicativos criem e gerenciem envelopes de assinatura, carreguem e reordenem documentos, adicionem participantes e definam a ordem de assinatura, coloquem campos de assinatura e dados, enviem documentos para assinatura, acompanhem o progresso e baixem os arquivos originais, lacrados e de trilha de auditoria , tudo por meio de uma abordagem totalmente automatizada e controlada por API. Os fluxos também podem ser iniciados automaticamente por gatilhos que disparam quando algo acontece no Nitro Sign.
Publisher: Nitro Software
Pré-requisitos
Para usar o Nitro Sign por meio deste conector, você precisará de:
- Uma conta do Nitro com o Sinal do Nitro habilitado
https://developers.gonitro.com/ - Um plano Microsoft PowerApps ou Power Automate com recursos do Conector Personalizado.
Authentication
O Nitro Sign usa o OAuth 2.0 de máquina a máquina com a concessão de Credenciais do Cliente para gerar tokens de acesso para solicitações de API.
Como funciona
- Crie um aplicativo de API no portal de autoatendimento do Nitro e obtenha a ID do Cliente e o Segredo do Cliente associados.
- O conector é autenticado trocando essas credenciais por um token de acesso do portador .
- Em seguida, o token é usado para autorizar chamadas subsequentes à API do Nitro Sign.
Crie credenciais e leia o guia detalhado:
https://developers.gonitro.com/docs/authentication/credentials
Criando uma conexão em Power Automate/Power Apps
Ao adicionar o conector a um fluxo ou aplicativo:
- Clique em Adicionar uma nova conexão.
- Insira sua ID do Cliente e o Segredo do Cliente (emitido no portal do desenvolvedor do Nitro).
- Selecione sua região de Nitro (Europa, Estados Unidos ou APAC) — a região associada à sua conta do Nitro.
- Salve a conexão – no primeiro uso, o conector troca sua ID do Cliente e o Segredo do Cliente por um token de acesso de curta duração usando a concessão de Credenciais de Cliente do OAuth 2.0, armazena-a em cache e a renova automaticamente. Suas credenciais são usadas apenas para obter o token; As chamadas à API subsequentes são autenticadas com um token de portador em seu nome.
Observação: nenhuma entrada interativa do usuário é necessária; esse fluxo foi projetado para cenários de servidor para servidor/aplicativo para aplicativo.
Operações com suporte
O conector agrupa 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 arquivos concluídos e um conjunto de gatilhos que iniciam um fluxo quando ocorre um evento no Nitro Sign.
1. Envelopes
Um envelope é o contêiner para os documentos, participantes e campos em uma única solicitação de assinatura.
Listar Envelopes
Retorna todos os envelopes associados ao aplicativo na conta. Os resultados são paginados: a resposta inclui um token de cursor da Próxima Página , que você pode fornecer ao parâmetro opcional Page After para recuperar a próxima página (ou Página Anterior à página anterior à página anterior). Ambos os parâmetros de 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 (assunto + 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, na ordem em que foram adicionados.
-
Obter Envelope por ID
Recupera detalhes de um envelope específico por sua UUID.Atualizar Envelope
Atualiza o nome do envelope, as configurações de notificação e/ou o modo de assinatura. Todos os campos são opcionais.Excluir Envelope por ID
Exclui permanentemente um envelope e todos os documentos, campos e participantes associados. Isso não pode ser desfeito.Enviar envelope para assinatura
Envia o envelope aos participantes da coleção de assinaturas. Antes de enviar, o envelope normalmente deve ter seus documentos, participantes e campos de assinatura adicionados (por meio de Criar Documento por ID do Envelope, Criar Participantes por ID do Envelope e Criar Campo por ID do Documento). Todos os documentos no envelope devem ter um status carregado antes que o envelope possa ser enviado.Enviar lembretes para envelope
Dispara notificações de lembrete para participantes pendentes. Se nenhuma configuração de notificação for fornecida, o modelo de notificação padrão configurado para o envelope será usado.Cancelar Envelope por ID
Cancela a solicitação de assinatura. Somente envelopes que já foram enviados para assinatura podem ser cancelados.
2. Documentos
Os documentos são os arquivos anexados a um envelope e assinados pelos participantes.
Listar documentos por ID do envelope
Recupera todos os documentos associados a um envelope.Criar Documento por ID do Envelope
Carrega um documento em um envelope existente. Forneça o arquivo mais campos simples e tipados — nenhum JSON escrito à mão:- Arquivo de documento – o arquivo a ser carregado.
- Nome do Documento – o nome no qual armazenar o documento.
-
Tipo de conteúdo(avançado, opcional) — o tipo MIME do arquivo; o padrão é
application/pdf. Quando omitido, somente arquivos PDF são aceitos.
Obter Documento por ID
Recupera detalhes de um documento específico em um envelope.Atualizar documento por ID
Atualiza metadados do documento. Atualmente, somente o nome do documento pode ser alterado.Excluir Documento por ID
Exclui permanentemente um documento de um envelope.Reordenar documentos por ID do envelope
Reordena os documentos em um envelope com base em uma lista fornecida de IDs de documento.
3. Campos
Os campos são os elementos interativos (assinatura, iniciais, data etc.) colocados em um 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 por ID do documento
Cria um ou mais campos em um documento e os atribui aos participantes. Forneça um item para um único campo ou vários itens para uma solicitação em massa. Cada campo especifica:-
participantID— o participante atribuído ao campo. -
type— um designature,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 da borda esquerda/superior da página). Elas substituem a matriz única
boundingBoxanterior, portanto, cada valor é um campo digitado na interface do usuário em vez de uma lista criada à mão. - Opcional:
required(padrãotrue) e — em Avançado —format(por exemplo,MM/DD/YYYYpara campos de data) emodifiable.
-
Atualizar campo por ID
Atualiza as propriedades de um campo existente. O campotypedeve ser fornecido e deve corresponder ao tipo de campo existente – ele é usado para identificar o esquema de campo e não altera o tipo de campo.Excluir Campo por ID
Exclui permanentemente um campo de um documento.
4. Participantes
Os participantes são as pessoas que recebem o envelope , seja para assiná-lo ou para serem mantidos informados.
Listar participantes por ID do envelope
Recupera todos os participantes associados a um envelope.Criar Participantes por ID do Envelope
Adiciona um ou mais participantes a um envelope. Forneça um item para um único participante ou vários itens para uma solicitação em massa. Cada participante especifica:-
email— o endereço de email do participante. -
role—signer(pode ter campos atribuídos para assinatura) oucc(acesso somente 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 seção somente se o participante deve se autenticar antes de assinar.
-
Atualizar Participante por ID
Atualiza as configurações de autenticação de um participante. O email do participante não pode ser alterado.Excluir Participante por ID
Exclui permanentemente um participante de um envelope.
5. Downloads
Recupere os arquivos concluídos depois que os documentos tiverem sido assinados e lacrados.
Baixar Envelope Original
Baixa os documentos não assinados originais de um envelope como um arquivo ZIP .Baixar Envelope Lacrado
Baixa os documentos assinados lacrados, juntamente com a trilha de auditoria, como um arquivo ZIP .Baixar documento lacrado por ID
Baixa um único documento assinado lacrado como um arquivo PDF .Baixar Trilha de Auditoria do Envelope
Baixa a trilha de auditoria completa para um envelope como um arquivo PDF .
As ações de download expõem tokens de Nome de Arquivo e Conteúdo de Arquivo nativos do seletor (além de Tipo de Conteúdo de Arquivo). Solte o Conteúdo do Arquivo diretamente na entrada do arquivo de uma etapa downstream — por exemplo, OneDrive/SharePoint Criar Arquivo — e Nome do Arquivo em sua entrada de nome de arquivo. Nenhuma
body('Action_Name')expressão ou nome de arquivo tipado manualmente é necessário; o conector encapsula o ZIP ou PDF baixado em um envelope JSON para Power Automate os apresenta como tokens de conteúdo dinâmico comuns.
6. Gatilhos
Os gatilhos iniciam um fluxo automaticamente quando algo acontece no Nitro Sign, para que você não precise sondar as alterações. Escolha um gatilho como a primeira etapa de um fluxo; Em seguida, o Sinal de Nitro notifica Power Automate sempre que esse evento ocorrer.
Não há nada a ser configurado – nenhum nome de evento para digitar, nenhuma URL de retorno de chamada para colar. Ativar o fluxo registra a assinatura com o Nitro Sign para você.
Gatilhos do ciclo de vida do envelope
Quando um envelope é criado É acionado quando um novo envelope é criado , por exemplo, para registrar todas as novas solicitações de assinatura em um SharePoint list ou notificar um canal de que uma solicitação foi redigida.
Quando um envelope é enviado para assinatura É acionado quando o envelope entra no fluxo de trabalho de assinatura e os participantes são notificados.
Quando a assinatura do envelope é concluída É acionado quando cada participante é assinado e a vedação começa.
Quando um envelope é lacrado Aciona quando o envelope é lacrado e nenhuma alteração adicional pode ser feita. Esse é o gatilho usual para recuperar arquivos concluídos – emparelhe-o com Baixar Envelope Lacrado ou Baixar Trilha de Auditoria do Envelope.
Quando um envelope é cancelado Aciona quando a solicitação de assinatura é cancelada.
Gatilhos de participante
Quando uma solicitação de assinatura é assinada Acionado sempre que um participante individual assina. Em um envelope de vários signatários, isso é acionado uma vez por signatário, portanto, é útil para o acompanhamento de progresso.
Quando uma solicitação de assinatura é recusada É acionado quando um participante se recusa a assinar , normalmente usado para alertar o remetente ou iniciar um processo de exceção.
O que um gatilho lhe dá
Cada gatilho gera os detalhes do evento mais o envelope ao qual ele se relaciona, disponível como tokens de conteúdo dinâmico comuns:
Tipo de evento, ID do evento, utc ( o que aconteceu e quando). A ID do evento é exclusiva por evento e pode ser usada para detectar duplicatas.
ID da conta, ID do aplicativo, ID da configuração do Webhook – a conta, o aplicativo e a assinatura do Nitro por trás da notificação.
ID do envelope, Nome do Envelope – o envelope ao qual o evento está relacionado. Alimente a ID do Envelope diretamente em uma ação de acompanhamento, como Obter Envelope por ID ou Baixar Envelope Lacrado.
Os cinco gatilhos de fluxo de trabalho de assinatura - enviados para assinatura, assinados, recusados e cancelados - além da saída:
Documentos — os documentos no envelope (ID do documento, nome do documento, páginas, tamanho do arquivo, origem).
Solicitações de Assinatura – uma entrada por participante, cada uma com ID do Participante, Email do Signatário, Nome do Signatário, Sobrenome do Signatário, Status e Ordem de Assinatura.
Colaboradores e Mensagem Personalizada – os registros do colaborador e a mensagem anexada ao fluxo de trabalho de assinatura.
Como as Solicitações de Assinatura são uma lista que abrange todos os participantes, use a Ordem de Assinatura ou o Status para escolher o participante com o qual você se importa, em vez de assumir a primeira entrada. O Sinal de Nitro não garante a ordem na qual os eventos chegam, portanto, trate UtC (Ocorrida em) como a autoridade na sequência.
Quando um envelope é criado, a assinatura é concluída e é lacrada retorna apenas a ID e o nome do envelope – esses eventos não carregam detalhes do documento ou do participante. Use Get Envelope by ID ou List Documents by Envelope ID se precisar de mais.
Importante: um gatilho ativo por conexão
No momento, o Nitro Sign permite uma assinatura de webhook por ID do Cliente. Como cada fluxo usando os mesmos compartilhamentos de conexão que a ID do Cliente, isso tem uma consequência que você precisa planejar:
Ativar um fluxo com um gatilho do Nitro Sign interrompe qualquer outro fluxo de gatilho do Nitro Sign que use a mesma conexão. O fluxo habilitado mais recentemente é aquele que recebe eventos.
O fluxo afetado permanece ligado no Power Automate e não mostra nenhum erro. Ele simplesmente para de disparar. Se você precisar de dois ou mais fluxos baseados em gatilho em execução ao mesmo tempo, forneça a cada um deles sua própria conexão, criada com uma ID de cliente Nitro diferente. Os fluxos que usam apenas ações (não gatilhos) não são afetados e podem compartilhar uma conexão livremente.
Essa é uma limitação temporária da plataforma Nitro Sign. Quando ele for levantado, vários fluxos de gatilho poderão compartilhar uma única conexão.
Desativar um fluxo
Quando você desativa um fluxo, sua assinatura pode permanecer registrada no lado do Nitro Sign. Ele será limpo automaticamente na próxima vez que qualquer fluxo de gatilho do Nitro Sign estiver habilitado nessa conexão. Enquanto isso, o Nitro Sign pode continuar enviando eventos para o fluxo desligado; elas são descartadas e o fluxo não é executado.
Se você precisar confirmar o estado atual, liste as configurações de webhook para seu aplicativo no portal do desenvolvedor do Nitro.
Fluxo de trabalho de assinatura típico
Um fluxo de assinatura completo encadeia as ações acima na ordem. Um fluxo de Power Automate comum tem esta aparência:
-
Criar Envelope — defina o nome, o assunto/corpo da notificação e o modo de assinatura (
parallelousequential). Salve a ID do Envelope retornada. -
Criar Documento por ID do Envelope – carregue um ou mais arquivos no envelope (usando a ID do Envelope da etapa 1). Salve cada ID de documento retornada.
(Opcional)Reordenar documentos por ID do envelope — defina a ordem do documento. - Criar Participantes por ID do Envelope – adicione os signatários e os destinatários CC, com sua autenticação de código de acesso. Salve cada ID de Participante retornada.
- Crie campos por ID do documento — coloque os campos de assinatura/data/etc. em cada documento e atribua-os aos participantes (usando a ID do Documento da etapa 2 e a ID do Participante da etapa 3).
- Enviar Envelope para Assinatura – expedir o envelope. Todos os documentos devem estar no status carregado primeiro.
- (Enquanto estiver pendente)Enviar Lembretes para Envelope para cutucar os participantes ou Cancelar Envelope por ID para interromper a solicitação.
- (Quando concluído)Baixeo / envelope lacrado por ID / e baixe a trilha de auditoria do envelope para recuperar os arquivos concluídos.
Dica: a ID do envelope, a ID do documento e a ID do participante retornadas pelo fluxo de ações de criação naturalmente para as ações posteriores por meio do seletor de conteúdo dinâmico do Power Automate – escolha o token de ID da ação upstream em vez de digitá-lo.
Fluxo de acompanhamento controlado por eventos
Em vez de esperar dentro do fluxo de envio, você pode reagir à conclusão em um fluxo separado:
- Quando um envelope é lacrado , o gatilho inicia o fluxo e fornece a ID do Envelope.
- Baixar Envelope Lacrado – passe a ID do Envelope do gatilho diretamente.
- Criar Arquivo (OneDrive, SharePoint etc.) — solte os tokens de Nome de Arquivo e Conteúdo de Arquivo nas entradas do arquivo.
O mesmo padrão funciona com quando uma solicitação de assinatura é recusada para gerar um alerta ou quando uma solicitação de assinatura é assinada para postar atualizações de progresso à medida que cada participante conclui sua parte.
Erros &limitação
A API de Sinal do Nitro pode retornar os seguintes erros:
- 400 – Solicitação incorreta
- 401 – Não autorizado
- 404 – Não encontrado
- 409 — Conflito (por exemplo, agindo em um envelope em um estado que não permite a operação)
- 413 – Conteúdo muito grande
- 415 – Tipo de mídia sem suporte
- 422 – Entidade não processável
- 500 – Erro interno do servidor
Limitação
- Chamadas à API por conexão: 100 por 60 segundos.
Limites da plataforma
File Size.
- Máximo: 25 MB por solicitação
Aplica-se a operações de arquivo único e de vários arquivos.
Contagem de Páginas
- Máximo: 250 páginas por documento individual
O total de páginas combinadas em vários documentos pode exceder 250.
Tempo de Retenção
- Os arquivos de entrada e saída são excluídos cerca de 15 minutos após a conclusão da operação.
Assinaturas do Webhook
- Máximo: 1 assinatura ativa por ID do Cliente. Use uma conexão separada, criada com uma ID de cliente diferente, para cada fluxo baseado em gatilho que deve ser executado simultaneamente.
Notes
- As ações de gerenciamento de envelope, documento, campo e participante retornam JSON.
- As ações de download retornam o arquivo (ZIP ou PDF) encapsulado em um envelope JSON expondo Nome do Arquivo, Tipo de Conteúdo de Arquivo e Conteúdo de Arquivo como tokens nativos do seletor, para que os resultados possam ser encadeados em uma ação de arquivo downstream sem expressões.
- O modo de assinatura (
parallelvssequential) é definido quando o envelope é criado e pode ser alterado com o Envelope de Atualização antes que o envelope seja enviado. - Atualmente, a autenticação de participante dá suporte apenas ao Código de Acesso .
- Os gatilhos não exigem nenhuma configuração, permitindo que o fluxo registre automaticamente a assinatura do Nitro Sign. Somente um fluxo baseado em gatilho por conexão pode estar ativo por vez.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Required |
|---|---|---|---|
| ID do cliente do Nitro | secureString | Sua ID do cliente do aplicativo Nitro | Verdade |
| Segredo do cliente do Nitro | secureString | Seu segredo do cliente do aplicativo Nitro | Verdade |
| Região de Nitro | cadeia | Selecione a região da API do Nitro para sua conta. | Verdade |
Ações
| Atualizar campo por ID |
Atualiza as propriedades de um campo existente em um documento do Nitro Sign. O tipo de campo deve ser fornecido e deve corresponder ao tipo de campo existente; é usado pela API para identificar o esquema de campo e não altera o tipo de campo. |
| Atualizar documento por ID |
Atualiza os metadados de um documento existente em um envelope do Nitro Sign. Atualmente, somente o nome do documento pode ser atualizado. |
| Atualizar Envelope |
Atualiza um envelope do Nitro Sign existente. Você pode modificar o nome do envelope, as configurações de notificação, o modo de assinatura ou qualquer combinação desses campos. |
| Atualizar Participante por ID |
Atualiza as configurações de autenticação de um participante em um envelope do Nitro Sign. O email do participante não pode ser atualizado. |
| Baixar documento lacrado por ID |
Baixa um único documento assinado lacrado de um envelope do Nitro Sign como um arquivo PDF. |
| Baixar Envelope Lacrado |
Baixa os documentos assinados lacrados de um envelope do Nitro Sign, juntamente com a trilha de auditoria, como um arquivo ZIP. |
| Baixar Envelope Original |
Baixa os documentos não assinados originais de um envelope do Nitro Sign como um arquivo ZIP. |
| Baixar Trilha de Auditoria do Envelope |
Baixa o arquivo PDF que contém a trilha de auditoria completa para o envelope do Nitro Sign selecionado. |
| Cancelar Envelope por ID |
Cancela a solicitação de assinatura de um envelope do Nitro Sign. Somente envelopes que foram enviados para assinatura podem ser cancelados. |
| Criar campo por ID do documento |
Cria um ou mais campos em um documento e os atribui aos participantes. Para criar um único campo, forneça um item na matriz Campos. Para criar vários campos, forneça vários itens. |
| Criar Documento por ID do Envelope |
Carrega um documento em um envelope do Nitro Sign existente. O documento pode ser usado posteriormente no fluxo de trabalho de assinatura. |
| Criar Envelope |
Cria um novo envelope do Nitro Sign que pode ser preenchido posteriormente com documentos, participantes, campos e enviados para assinatura. |
| Criar Participantes por ID do Envelope |
Adiciona um ou mais participantes a um envelope do Nitro Sign. Para adicionar um único participante, forneça um item na matriz Participantes. Para adicionar vários participantes, forneça vários itens. |
| Enviar envelope para assinatura |
Envia um envelope do Nitro Sign aos participantes da coleção de assinaturas. Antes de usar essa ação, o envelope normalmente deve ter documentos, participantes e campos de assinatura adicionados usando Criar Documento por ID do Envelope, Criar Participantes por ID do Envelope e Criar Campo por ID do Documento. Todos os documentos no envelope devem ter um status carregado antes que o envelope possa ser enviado. |
| Enviar lembretes para envelope |
Dispara notificações de lembrete para participantes pendentes de um envelope especificado do Nitro Sign. Se nenhuma configuração de notificação for fornecida, o modelo de notificação padrão configurado para o envelope será usado. |
| Excluir Campo por ID |
Exclui permanentemente um campo de um documento dentro de um envelope do Nitro Sign. |
| Excluir Documento por ID |
Exclui permanentemente um documento de um envelope do Nitro Sign. |
| Excluir Envelope por ID |
Exclui permanentemente um envelope do Nitro Sign. Essa operação não pode ser desfeita e todos os documentos, campos e participantes associados também são excluídos. |
| Excluir Participante por ID |
Exclui permanentemente um participante de um envelope do Nitro Sign. |
| Listar campos por ID do documento |
Recupera todos os campos associados a um documento específico em um envelope do Nitro Sign. |
| Listar documentos por ID do envelope |
Recupera todos os documentos associados a um envelope específico do Nitro Sign. |
| Listar Envelopes |
O ponto de extremidade Envelopes de Lista retorna todos os envelopes associados a um aplicativo em uma conta. |
| Listar participantes por ID do envelope |
Recupera todos os participantes associados a um envelope específico do Nitro Sign. |
| Obter Documento por ID |
Recupera detalhes de um documento específico em um envelope do Nitro Sign. |
| Obter Envelope por ID |
Recupera detalhes de um envelope específico do Nitro Sign usando sua ID de envelope exclusiva. |
| 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 documento. |
Atualizar campo por ID
Atualiza as propriedades de um campo existente em um documento do Nitro Sign. O tipo de campo deve ser fornecido e deve corresponder ao tipo de campo existente; é usado pela API para identificar o esquema de campo e não altera o tipo de campo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento que contém o campo. |
|
ID do campo
|
fieldID | True | uuid |
Uma UUID exclusiva que identifica o campo a ser atualizado. |
|
Tipo de campo
|
type | True | string |
O tipo atual do campo que está sendo atualizado. Esse valor é exigido pela API e deve corresponder ao tipo de campo existente; ele não altera o tipo de campo. |
|
ID do participante
|
participantID | uuid |
O identificador exclusivo do participante atribuído ao campo. |
|
|
Page
|
page | integer |
O número da página em que o campo é exibido. As páginas usam indexação baseada em 1. |
|
|
Posição X
|
x | float |
Optional. A posição horizontal do campo, medida da borda esquerda da página em pontos. |
|
|
Posição Y
|
y | float |
Optional. A posição vertical do campo, medida 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 concluir este campo. |
|
|
Format
|
format | string |
O formato de 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. |
Retornos
Detalhes do campo Sinal de Nitro.
- Corpo
- FieldResponse
Atualizar documento por ID
Atualiza os metadados de um documento existente em um envelope do Nitro Sign. Atualmente, somente o nome do documento pode ser atualizado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento a ser atualizado. |
|
Nome do documento
|
name | True | string |
O novo nome do documento. |
Retornos
Detalhes do documento do Nitro Sign.
- Corpo
- DocumentResponse
Atualizar Envelope
Atualiza um envelope do Nitro Sign existente. Você pode modificar o nome do envelope, as configurações de notificação, o modo de assinatura ou qualquer combinação desses campos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope a ser atualizado. |
|
Nome do envelope
|
name | string |
O nome do envelope atualizado. Não precisa ser exclusivo. |
|
|
Assunto de notificação
|
subject | string |
A linha de assunto da notificação por email enviada aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: $(sender_name_or_email) está solicitando sua assinatura. |
|
|
Corpo da notificação
|
body | string |
O corpo do email enviado aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: Oi,\nAssine a\n$(envelope_name) Obrigado,\n$(sender_name_or_email). |
|
|
Modo de Assinatura
|
mode | string |
Define a ordem de assinatura. Use paralelo para notificar todos os participantes ao mesmo tempo ou sequencialmente para notificar os participantes um a um na ordem em que foram adicionados. |
Retornos
Resposta retornada depois que um envelope do Nitro Sign é solicitado ou criado.
- Corpo
- EnvelopeResponse
Atualizar Participante por ID
Atualiza as configurações de autenticação de um participante em um envelope do Nitro Sign. O email do participante não pode ser atualizado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o participante. |
|
ID do participante
|
participantID | True | uuid |
Uma UUID exclusiva que identifica o participante a ser atualizado. |
|
Tipo de autenticação
|
type | string |
Optional. Selecione um método de autenticação para o participante. Se especificado, um Código de Acesso também deve ser fornecido. |
|
|
Código de acesso
|
accessCode | string |
Necessário somente quando o Tipo de Autenticação é especificado. Deixe em branco se a autenticação do participante não for necessária. |
Retornos
Detalhes do participante do Nitro Sign.
- Corpo
- ParticipantResponse
Baixar documento lacrado por ID
Baixa um único documento assinado lacrado de um envelope do Nitro Sign como um arquivo PDF.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento lacrado. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento lacrado a ser baixado. |
Retornos
Arquivo baixado encapsulado como um envelope JSON.
- Corpo
- FileDownloadResponse
Baixar Envelope Lacrado
Baixa os documentos assinados lacrados de um envelope do Nitro Sign, juntamente com a trilha de auditoria, como um arquivo ZIP.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cujos documentos lacrados devem ser baixados. |
Retornos
Arquivo baixado encapsulado como um envelope JSON.
- Corpo
- FileDownloadResponse
Baixar Envelope Original
Baixa os documentos não assinados originais de um envelope do Nitro Sign como um arquivo ZIP.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cujos documentos originais devem ser baixados. |
Retornos
Arquivo baixado encapsulado como um envelope JSON.
- Corpo
- FileDownloadResponse
Baixar Trilha de Auditoria do Envelope
Baixa o arquivo PDF que contém a trilha de auditoria completa para o envelope do Nitro Sign selecionado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cuja trilha de auditoria deve ser baixada. |
Retornos
Arquivo baixado encapsulado como um envelope JSON.
- Corpo
- FileDownloadResponse
Cancelar Envelope por ID
Cancela a solicitação de assinatura de um envelope do Nitro Sign. Somente envelopes que foram enviados para assinatura podem ser cancelados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope a ser cancelado. |
Retornos
Resposta retornada depois que um envelope do Nitro Sign é solicitado ou criado.
- Corpo
- EnvelopeResponse
Criar campo por ID do documento
Cria um ou mais campos em um documento e os atribui aos participantes. Para criar um único campo, forneça um item na matriz Campos. Para criar vários campos, forneça vários itens.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento em que os campos devem ser criados. |
|
ID do participante
|
participantID | True | uuid |
O identificador exclusivo do participante atribuído ao campo. |
|
Page
|
page | True | integer |
O número da página em que o campo deve ser colocado. As páginas usam indexação baseada em 1, portanto, a primeira página é 1. |
|
Tipo de campo
|
type | True | string |
O tipo de campo a ser criado. |
|
Posição X
|
x | True | float |
A posição horizontal do campo, medida da borda esquerda da página em pontos. |
|
Posição Y
|
y | True | float |
A posição vertical do campo, medida 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 concluir este campo. |
|
|
Format
|
format | string |
Formato opcional para tipos de campo que dão suporte à 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, em que há suporte para o tipo de campo. |
Retornos
Resposta retornada após a criação de um ou mais campos.
- Corpo
- FieldsResponse
Criar Documento por ID do Envelope
Carrega um documento em um envelope do Nitro Sign existente. O documento pode ser usado posteriormente no fluxo de trabalho de assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope em que o documento será carregado. |
|
Nome do documento
|
documentName | True | string |
O nome do documento a ser carregado. Esse valor será usado para criar os metadados do documento enviados ao Nitro. |
|
Tipo de conteúdo
|
contentType | string |
O tipo de conteúdo do documento carregado. Para arquivos PDF, use aplicativo/pdf. Quando é omitido dos metadados, somente arquivos PDF são aceitos. |
|
|
Arquivo de documento
|
payload | True | file |
O arquivo de documento a ser carregado no envelope. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
ID | uuid |
Uma UUID exclusiva que identifica o documento carregado. |
|
Nome do documento
|
name | string |
O nome do documento carregado. |
|
Criado em
|
createdAt | string |
Carimbo de data/hora que indica quando o documento foi criado. |
|
Status do documento
|
status | string |
O status de processamento do documento carregado. |
Criar Envelope
Cria um novo envelope do Nitro Sign que pode ser preenchido posteriormente com documentos, participantes, campos e enviados para assinatura.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Nome do envelope
|
name | True | string |
O nome do envelope. Não precisa ser exclusivo. |
|
Modo de Assinatura
|
mode | True | string |
Define a ordem de assinatura. Use paralelo para notificar todos os participantes ao mesmo tempo ou sequencialmente para notificar os participantes um a um na ordem em que foram adicionados. |
|
Assunto de notificação
|
subject | True | string |
A linha de assunto da notificação por email enviada aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: $(sender_name_or_email) está solicitando sua assinatura. |
|
Corpo da notificação
|
body | True | string |
O corpo do email enviado aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: Oi,\nAssine a\n$(envelope_name) Obrigado,\n$(sender_name_or_email). |
Retornos
Resposta retornada depois que um envelope do Nitro Sign é solicitado ou criado.
- Corpo
- EnvelopeResponse
Criar Participantes por ID do Envelope
Adiciona um ou mais participantes a um envelope do Nitro Sign. Para adicionar um único participante, forneça um item na matriz Participantes. Para adicionar vários participantes, forneça vários itens.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope em que os participantes devem ser adicionados. |
|
Email
|
True |
O endereço de email do participante. |
||
|
Função
|
role | True | string |
A função de participante. Um signatário pode ter campos atribuídos para assinatura. Um participante cc tem acesso somente leitura. |
|
Tipo de autenticação
|
type | string |
Optional. Selecione um método de autenticação para o participante. Se especificado, um Código de Acesso também deve ser fornecido. |
|
|
Código de acesso
|
accessCode | string |
Necessário somente quando o Tipo de Autenticação é especificado. Deixe em branco se a autenticação do participante não for necessária. |
Retornos
Resposta retornada após a criação de um ou mais participantes.
- Corpo
- ParticipantsResponse
Enviar envelope para assinatura
Envia um envelope do Nitro Sign aos participantes da coleção de assinaturas. Antes de usar essa ação, o envelope normalmente deve ter documentos, participantes e campos de assinatura adicionados usando Criar Documento por ID do Envelope, Criar Participantes por ID do Envelope e Criar Campo por ID do Documento. Todos os documentos no envelope devem ter um status carregado antes que o envelope possa ser enviado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope a ser enviado para assinatura. |
Retornos
Informações resumidas sobre um envelope do Nitro Sign.
- Corpo
- EnvelopeSummaryResponse
Enviar lembretes para envelope
Dispara notificações de lembrete para participantes pendentes de um envelope especificado do Nitro Sign. Se nenhuma configuração de notificação for fornecida, o modelo de notificação padrão configurado para o envelope será usado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope para o qual as notificações de lembrete devem ser enviadas. |
|
Assunto de notificação
|
subject | string |
A linha de assunto da notificação por email enviada aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: $(sender_name_or_email) está solicitando sua assinatura. |
|
|
Corpo da notificação
|
body | string |
O corpo do email enviado aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: Oi,\nAssine a\n$(envelope_name) Obrigado,\n$(sender_name_or_email). |
Excluir Campo por ID
Exclui permanentemente um campo de um documento dentro de um envelope do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento que contém o campo. |
|
ID do campo
|
fieldID | True | uuid |
Uma UUID exclusiva que identifica o campo a ser excluído. |
Excluir Documento por ID
Exclui permanentemente um documento de um envelope do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento a ser excluído. |
Excluir Envelope por ID
Exclui permanentemente um envelope do Nitro Sign. Essa operação não pode ser desfeita e todos os documentos, campos e participantes associados também são excluídos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope a ser excluído. |
Excluir Participante por ID
Exclui permanentemente um participante de um envelope do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o participante. |
|
ID do participante
|
participantID | True | uuid |
Uma UUID exclusiva que identifica o participante a ser excluído. |
Listar campos por ID do documento
Recupera todos os campos associados a um documento específico em um envelope do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento cujos campos devem ser recuperados. |
Retornos
Resposta retornada após a criação de um ou mais campos.
- Corpo
- FieldsResponse
Listar documentos por ID do envelope
Recupera todos os documentos associados a um envelope específico do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cujos documentos devem ser recuperados. |
Retornos
Resposta retornada ao listar documentos associados a um envelope do Nitro Sign.
Listar Envelopes
O ponto de extremidade Envelopes de Lista retorna todos os envelopes associados a um aplicativo em uma conta.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página Após
|
pageAfter | string |
Token de cursor opcional usado para recuperar a próxima página de envelopes. Use o valor nextPage retornado pela resposta anterior. |
|
|
Página Anterior
|
pageBefore | string |
Token de cursor opcional usado para recuperar a página anterior de envelopes. Não use junto com o Page After. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelopes
|
items | array of EnvelopeSummaryResponse |
A lista de envelopes. |
|
Próxima Página
|
nextPage | string |
Token de cursor que pode ser usado como Page After para recuperar a próxima página de envelopes. |
Listar participantes por ID do envelope
Recupera todos os participantes associados a um envelope específico do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cujos participantes devem ser recuperados. |
Retornos
Resposta retornada ao listar participantes associados a um envelope do Nitro Sign.
- Corpo
- ParticipantsListResponse
Obter Documento por ID
Recupera detalhes de um documento específico em um envelope do Nitro Sign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope que contém o documento. |
|
ID do documento
|
documentID | True | uuid |
Uma UUID exclusiva que identifica o documento a ser recuperado. |
Retornos
Detalhes do documento do Nitro Sign.
- Corpo
- DocumentResponse
Obter Envelope por ID
Recupera detalhes de um envelope específico do Nitro Sign usando sua ID de envelope exclusiva.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope a ser recuperado. |
Retornos
Resposta retornada depois que um envelope do Nitro Sign é solicitado ou criado.
- Corpo
- EnvelopeResponse
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 documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeID | True | uuid |
Uma UUID exclusiva que identifica o envelope cujos documentos devem ser reordenados. |
|
Identificadores de documento
|
order | True | array of uuid |
Uma matriz de IDs de documento que representa a nova ordem dos documentos dentro do envelope. |
Retornos
Resposta retornada ao listar documentos associados a um envelope do Nitro Sign.
Definições
EnvelopeNotification
Configurações de email de notificação para um envelope do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Assunto de notificação
|
subject | string |
A linha de assunto da notificação por email enviada aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: $(sender_name_or_email) está solicitando sua assinatura. |
|
Corpo da notificação
|
body | string |
O corpo do email enviado aos participantes da assinatura. Há suporte para variáveis dinâmicas, por exemplo: Oi,\nAssine a\n$(envelope_name) Obrigado,\n$(sender_name_or_email). |
EnvelopeSummaryResponse
Informações resumidas sobre um envelope do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope ID
|
ID | uuid |
Uma UUID exclusiva que identifica o envelope. |
|
Criado em
|
createdAt | date-time |
Carimbo de data/hora UTC indicando quando o envelope foi criado. |
|
Última modificação em
|
lastModifiedAt | date-time |
Carimbo de data/hora UTC indicando quando o envelope foi modificado pela última vez. |
|
Nome do envelope
|
name | string |
O nome do envelope. |
|
Envelope Status
|
status | string |
O status interno do envelope. |
EnvelopeResponse
Resposta retornada depois que um envelope do Nitro Sign é solicitado ou criado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope ID
|
ID | uuid |
Uma UUID exclusiva que identifica o envelope. |
|
Criado em
|
createdAt | date-time |
Carimbo de data/hora UTC indicando quando o envelope foi criado. |
|
Última modificação em
|
lastModifiedAt | date-time |
Carimbo de data/hora UTC indicando quando o envelope foi modificado pela última vez. |
|
Nome do envelope
|
name | string |
O nome do envelope. |
|
Envelope Status
|
status | string |
O status interno do envelope. |
|
Modo de Assinatura
|
mode | string |
O modo de assinatura configurado para o envelope. |
|
notificação
|
notification | EnvelopeNotification |
Configurações de email de notificação para um envelope do Nitro Sign. |
ListDocumentsByEnvelopeIDResponse
Resposta retornada ao listar documentos associados a um envelope do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
items | array of DocumentResponse |
A lista de documentos associados ao envelope. |
DocumentResponse
Detalhes do documento do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
ID | uuid |
Uma UUID exclusiva que identifica o documento. |
|
Nome do documento
|
name | string |
O nome do documento. |
|
Criado em
|
createdAt | date-time |
Carimbo de data/hora 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. |
|
Status do documento
|
status | string |
O status atual do documento. |
FieldsResponse
Resposta retornada após a criação de um ou mais campos.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Fields
|
items | array of FieldResponse |
Os campos criados nesta solicitação. |
FieldResponse
Detalhes do campo Sinal de Nitro.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do campo
|
ID | uuid |
Uma UUID exclusiva que identifica o campo. |
|
ID do participante
|
participantID | uuid |
O identificador exclusivo do participante atribuído ao campo. |
|
ID do documento
|
documentID | uuid |
O identificador exclusivo do documento ao qual o campo pertence. |
|
Page
|
page | integer |
O número da página em que o campo é exibido. |
|
Caixa delimitadora
|
boundingBox | array of float |
Uma matriz de quatro números no formato [x, y, largura, altura], medida em pontos. |
|
Required
|
required | boolean |
Indica se o participante deve concluir este campo. |
|
Tipo de campo
|
type | string |
O tipo de campo. |
|
Format
|
format | string |
O formato de campo, quando aplicável. |
|
Modificável
|
modifiable | boolean |
Indica se o valor do campo é modificável, quando aplicável. |
ParticipantsResponse
Resposta retornada após a criação de um ou mais participantes.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Participantes
|
items | array of ParticipantResponse |
Os participantes criados nesta solicitação. |
ParticipantsListResponse
Resposta retornada ao listar participantes associados a um envelope do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Participantes
|
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. |
ParticipantResponse
Detalhes do participante do Nitro Sign.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do participante
|
ID | uuid |
Uma UUID exclusiva que identifica o participante. |
|
Email
|
O endereço de email do participante. |
||
|
Função
|
role | string |
A função do participante. |
|
autenticação
|
authentication | ParticipantAuthenticationResponse |
Configurações de autenticação retornadas para um participante. |
ParticipantAuthenticationResponse
Configurações de autenticação retornadas para um participante.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
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
Arquivo baixado encapsulado como um envelope JSON.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do arquivo
|
fileName | string |
O nome do arquivo baixado, derivado do cabeçalho Content-Disposition de resposta (por exemplo, result.zip ou result.pdf). Solte esse token diretamente na entrada Nome do Arquivo de uma ação downstream, como OneDrive ou SharePoint Criar Arquivo. |
|
Tipo de conteúdo do arquivo
|
fileContentType | string |
O tipo MIME do arquivo baixado, por exemplo, aplicativo/zip ou aplicativo/pdf. |
|
Conteúdo do arquivo
|
fileContent | byte |
O conteúdo do arquivo codificado em base64. Solte esse token diretamente na entrada conteúdo do arquivo de uma ação downstream (por exemplo, OneDrive ou SharePoint Criar Arquivo ou outra ação nitro) – nenhuma expressão necessária. |