Scrive eSign
A Scrive, líder do mercado nórdico em assinaturas eletrônicas, oferece um conjunto abrangente de soluções para fluxos de trabalho de documentos que exigem assinatura eletrônica e verificação de identidade.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , 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 do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do 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) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Scrive |
| URL | https://www.scrive.com/contact-support |
| support@scrive.com |
| Metadados do conector | |
|---|---|
| Editora | Escreve |
| Sítio Web | https://www.scrive.com |
| Política de privacidade | https://www.scrive.com/privacy-notice/ |
| Categorias | Produtividade |
Adiciona eSigning a fluxos de trabalho de documentos.
Pré-requisitos
Uma conta Scrive com acesso à API Scrive.
Como obter credenciais
Crie uma conexão e siga as etapas para autenticar usando o OAuth.
Problemas conhecidos e limitações
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Email/palavra-passe | Autenticação básica usando um e-mail e senha Scrive. | Todas as regiões | Não compartilhável |
| OAuth/SSO | Autenticação OAuth através de e-mail/senha ou logon único (SSO). | Todas as regiões | Não compartilhável |
| Padrão [DEPRECATED] | Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores. | Todas as regiões | Não compartilhável |
Email/palavra-passe
ID de autenticação: basic-auth
Aplicável: Todas as regiões
Autenticação básica usando um e-mail e senha Scrive.
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.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| E-mail para a conta Scrive | securestring | O e-mail da conta Scrive. | Verdade |
| Palavra-passe para a conta Scrive | securestring | A palavra-passe da conta Scrive. | Verdade |
| API Host URL | securestring | Especifique o host da API Scrive. A predefinição é https://scrive.com. |
OAuth/SSO
ID de autenticação: OAuth
Aplicável: Todas as regiões
Autenticação OAuth através de e-mail/senha ou logon único (SSO).
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.
Padrão [DEPRECATED]
Aplicável: Todas as regiões
Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.
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.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| E-mail para a conta Scrive | cadeia (de caracteres) | O e-mail da conta Scrive. | Verdade |
| Palavra-passe para a conta Scrive | securestring | A palavra-passe da conta Scrive. | Verdade |
| API Host URL | securestring | Especifique o host da API Scrive. A predefinição é https://scrive.com. |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar anexo |
Adicione um PDF a um documento como anexo. Pode escolher um anexo existente a partir da sua conta Scrive ou criar um novo anexo fornecendo um ficheiro PDF. |
| Adicionar novo grupo |
Adicione uma nova parte a um documento como signatário, visualizador ou aprovador. |
| Anexar arquivo PDF ao arquivo PDF principal |
Anexe um arquivo PDF ao arquivo PDF principal de um documento especificado. |
| Atualizar campos de grupo a partir do modelo |
Atualize os campos de grupo com base no modelo selecionado. |
| Atualizar documento JSON |
Atualize a representação JSON de um documento especificado com os dados fornecidos. |
| Atualizar e-mail do grupo |
Atualize o endereço de e-mail de uma parte especificada em um documento. |
| Atualizar propriedades do grupo a partir do modelo |
Atualize as propriedades com base no modelo selecionado. |
| Cancelar um documento pendente |
Cancelar um documento pendente. |
| Criar documento a partir de PDF |
Crie um novo documento a partir de um arquivo PDF. |
| Criar documento a partir do modelo |
Crie um novo documento a partir de um modelo selecionado. |
| Definir arquivo PDF para documento |
Defina o arquivo PDF principal para um documento especificado. |
| Enviar lembretes |
Envie lembretes para um documento especificado. |
| Iniciar processo de assinatura |
Inicie o processo de assinatura de um documento especificado. |
| Recuperar conteúdo PDF do documento |
Recupere o conteúdo PDF de um documento especificado. |
| Recuperar documento JSON |
Recupere a representação JSON de um documento especificado. |
| Recuperar o status do documento |
Recupere o status de um documento especificado. |
| Recuperar status do grupo |
Recuperar o status de uma parte especificada em um documento. |
Adicionar anexo
Adicione um PDF a um documento como anexo. Pode escolher um anexo existente a partir da sua conta Scrive ou criar um novo anexo fornecendo um ficheiro PDF.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecione Anexo
|
fileId | string |
Selecione um anexo existente. |
|
|
ID do documento
|
documentId | True | string |
ID do documento ao qual adicionar o anexo. |
|
Nome do anexo
|
attachmentName | True | string |
Nome do anexo. |
|
Necessário para assinatura
|
required | True | string |
Especifique se o anexo é obrigatório para assinatura. |
|
Adicionar ao ficheiro selado
|
addToSealedFile | True | string |
Especificar se o anexo deve ser incluído no documento selado após a assinatura. |
|
Novo anexo PDF
|
pdfContent | byte |
Conteúdo do ficheiro PDF para o novo anexo. Use este ou "Selecionar anexo". |
Adicionar novo grupo
Adicione uma nova parte a um documento como signatário, visualizador ou aprovador.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento ao qual adicionar a nova parte. |
|
E-mail do grupo
|
partyEmail | True | string |
Endereço de e-mail do novo partido. |
|
Papel do Partido
|
partyRole | True | string |
Papel do novo partido no processo de assinatura. |
|
Nome Próprio
|
firstname | string |
Primeiro nome do novo partido. |
|
|
Apelido
|
lastname | string |
Apelido do novo partido. |
|
|
Empresa
|
company | string |
Empresa do novo partido. |
|
|
Telemóvel
|
mobile | string |
Número de telemóvel do novo partido. |
|
|
Número de identificação do partido
|
personalNumber | string |
Número pessoal da nova parte para utilização com vários IDs eletrónicos. |
|
|
Pedido de Convite
|
signOrder | number |
Ordem em que a nova parte assinará o documento. |
|
|
Método de convite
|
deliveryMethod | string |
Método para convidar a parte a assinar. |
|
|
Autenticação para visualização
|
authenticationToView | string |
Método de autenticação necessário para visualizar o documento. |
|
|
Autenticação para exibir arquivado
|
authenticationToViewArchived | string |
Método de autenticação necessário para visualizar o documento arquivado. |
|
|
Autenticação para assinar
|
authenticationToSign | string |
Método de autenticação necessário para assinar o documento. |
|
|
Confirmação
|
confirmation | string |
Método de envio da confirmação. |
Anexar arquivo PDF ao arquivo PDF principal
Anexe um arquivo PDF ao arquivo PDF principal de um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento ao qual anexar o ficheiro PDF. |
|
Conteúdo do arquivo PDF
|
pdfContent | True | byte |
Conteúdo do arquivo PDF para anexar ao arquivo PDF principal do documento. |
Atualizar campos de grupo a partir do modelo
Atualize os campos de grupo com base no modelo selecionado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecionar modelo
|
templateID-dynamic | True | string |
Selecione um modelo para buscar campos. |
|
dynamicTemplateSchema
|
dynamicTemplateSchema | dynamic |
Esquema dinâmico de campos do modelo selecionado. |
Atualizar documento JSON
Atualize a representação JSON de um documento especificado com os dados fornecidos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento a atualizar. |
|
Documento JSON
|
documentJson | True | string |
Dados JSON para atualizar o documento. |
Atualizar e-mail do grupo
Atualize o endereço de e-mail de uma parte especificada em um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento onde o e-mail da parte será atualizado. |
|
ID da Parte
|
partyId | True | string |
ID da parte cujo endereço de e-mail precisa ser atualizado. |
|
E-mail do grupo
|
partyEmail | True | string |
Novo endereço de e-mail do partido. |
Devoluções
Detalhes atualizados do e-mail do grupo.
- E-mail de festa atualizado
- object
Atualizar propriedades do grupo a partir do modelo
Atualize as propriedades com base no modelo selecionado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Selecionar modelo
|
templateID-dynamic | True | string |
Selecione o modelo para buscar propriedades. |
|
dynamicTemplateMetaSchema
|
dynamicTemplateMetaSchema | dynamic |
Esquema dinâmico de propriedades do modelo selecionado. |
Cancelar um documento pendente
Cancelar um documento pendente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento pendente a cancelar. |
Criar documento a partir de PDF
Crie um novo documento a partir de um arquivo PDF.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Conteúdo PDF
|
pdfContent | True | byte |
Conteúdo do ficheiro PDF utilizado para criar o novo documento. |
|
Papel do autor
|
authorRole | True | string |
Papel do autor no processo de assinatura. |
Devoluções
ID do documento recém-criado.
- Novo ID do documento
- string
Criar documento a partir do modelo
Crie um novo documento a partir de um modelo selecionado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId-dynamic | True | string |
ID do modelo a ser usado para criar o novo documento. |
Devoluções
ID do documento recém-criado.
- Novo ID do documento
- string
Definir arquivo PDF para documento
Defina o arquivo PDF principal para um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento a atualizar. |
|
Novo conteúdo PDF
|
pdfContent | True | byte |
Novo conteúdo do ficheiro PDF. |
Devoluções
O documento atualizado JSON.
- Documento JSON atualizado
- object
Enviar lembretes
Envie lembretes para um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento para o qual serão enviados lembretes. |
Devoluções
Detalhes dos lembretes enviados.
- Lembretes enviados
- object
Iniciar processo de assinatura
Inicie o processo de assinatura de um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento para iniciar a assinatura. |
Devoluções
ID do documento que está a ser assinado.
- ID do documento sendo assinado
- string
Recuperar conteúdo PDF do documento
Recupere o conteúdo PDF de um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento do qual recuperar conteúdo PDF. |
Devoluções
- Conteúdo PDF do documento
- byte
Recuperar documento JSON
Recupere a representação JSON de um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento para o qual recuperar JSON. |
Devoluções
Documento JSON
- Documento JSON
- object
Recuperar o status do documento
Recupere o status de um documento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento para recuperar o status. |
Devoluções
Estado do documento
- Estado do documento
- string
Recuperar status do grupo
Recuperar o status de uma parte especificada em um documento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento para o qual recuperar o status da parte. |
|
ID da Parte
|
partyId | True | string |
ID da parte para a qual recuperar o status. |
Devoluções
O estatuto de signatário do partido.
- Estatuto do Partido
- string
Acionadores
| Quando o documento é assinado por todos os signatários (começar a assinar) |
Inicie o processo de assinatura de um documento e aguarde até que ele seja assinado. |
| Quando um documento de um modelo é assinado por todos os signatários |
Assista a um modelo e aguarde que qualquer um dos documentos filhos seja assinado. |
| Quando um documento é assinado |
Acionar quando um documento assinado aparece no arquivo eletrônico. |
| Quando um documento é assinado por todos os signatários (preterido) [PRETERIDO] |
Aguarde até que um documento seja assinado (preterido). |
Quando o documento é assinado por todos os signatários (começar a assinar)
Inicie o processo de assinatura de um documento e aguarde até que ele seja assinado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento a ser iniciado e acionado quando assinado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento assinado
|
signedDocumentId | string |
ID do documento assinado. |
Quando um documento de um modelo é assinado por todos os signatários
Assista a um modelo e aguarde que qualquer um dos documentos filhos seja assinado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do modelo
|
templateId-dynamic | True | string |
ID do modelo a ser observado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento assinado
|
signedDocumentId | string |
ID do documento assinado. |
Quando um documento é assinado
Acionar quando um documento assinado aparece no arquivo eletrônico.
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentação
|
documents | array of object |
Documentação |
|
documentId
|
documents.documentId | string |
ID do documento assinado. |
Quando um documento é assinado por todos os signatários (preterido) [PRETERIDO]
Aguarde até que um documento seja assinado (preterido).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
documentId | True | string |
ID do documento a ser acionado quando assinado. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento assinado
|
signedDocumentId | string |
ID do documento assinado. |
Definições
cadeia (de caracteres)
Este é o tipo de dados básico 'string'.
objecto
Este é o tipo 'objeto'.
byte
Este é o tipo de dados básico 'byte'.