Compartilhar via

BlueInk

O conector blueink permite adicionar a plataforma eSignature do Blueink a fluxos de trabalho automatizados. O conector permite que você verifique o status do pacote, crie novos pacotes, informações do signatário de acesso e muito mais.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do 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:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do 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 do 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 Blueink
URL https://help.blueink.com/en/
Email support@blueink.com
Metadados do conector
Publicador Blueink
Site https://blueink.com
Política de privacidade https://blueink.com/privacy-policy/
Categorias Gestão de empresas; Produtividade

Com esse conector versátil, os usuários podem integrar perfeitamente a poderosa solução de eSignature do Blueink em seu fluxo de trabalho aproveitando os recursos de vários conectores do Power Automate. Essa integração capacita os usuários a automatizar a criação e a distribuição de pacotes de documentos sem esforço. Ao orquestrar a interação harmoniosa desse conector com outros conectores, você pode simplificar seus processos de gerenciamento de documentos, aumentar a eficiência e garantir uma experiência de assinatura de documento perfeita e eficiente para seus clientes e stakeholders. Seja automatizando aprovações contratuais, processando documentos legais ou gerenciando documentos em qualquer outro contexto, esse conector fornece uma ferramenta poderosa para otimizar seu fluxo de trabalho e aumentar a produtividade.

Pré-requisitos

Para usar esse conector, você precisará de uma conta habilitada para API de blueink.com.

Como obter credenciais

Depois de criar sua conta, clique no botão de API no lado esquerdo da página. Em Teclas de API Privadas, pressione o botão Adicionar Tecla de API . Dê à tecla de API um rótulo e pressione enviar. Copie a chave de API e salve-a em algum lugar, pois ela não será mostrada novamente.

Introdução ao conector

Ao criar uma conexão Blueink pela primeira vez, você será solicitado a inserir uma chave de API. Sua chave de API sempre precisará começar com Token seguido por um espaço e, em seguida, a chave de API que você criou. A entrada da chave de API deve ser semelhante a esta CHAVE> DE API de Token<.

Uma ação popular é criar um pacote. A criação de um pacote requer um conjunto complexo de entradas. Dê uma olhada em nossa documentação de API para https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle a aparência da variável de corpo. Imagem abaixo como um exemplo de um corpo de criação de pacote.

Untitled

Há várias maneiras de criar um pacote e você pode modificar esse JSON para se adequar ao pacote que deseja criar. Dê uma olhada na API para saber mais sobre como esse JSON pode ser modificado. Este usa um modelo criado anteriormente que o usuário configurou em sua conta.

Listar todos os pacotes concluídos é outro ponto de extremidade popular. Adicione a ação Listar Pacotes e, em seguida, altere o botão de status para co para pacotes concluídos. Você pode se manter atualizado com todos os pacotes concluídos mais recentes usando esse ponto de extremidade.

Untitled

Problemas e limitações conhecidos

Um JSON de corpo é necessário para o ponto de extremidade de criação do pacote

Erros e soluções comuns

Se você receber um erro sobre uma solicitação não ter êxito com um erro de token inválido, certifique-se de não colar apenas a chave de API e incluir a cadeia de caracteres de Token anterior seguida como um espaço e, em seguida, sua chave de API.

Se você receber um erro sobre uma entrada inválida ao criar um Pacote, verifique se ele é JSON válido que está sendo enviado para o Blueink.

perguntas frequentes

1. O que é Blueink?

  • O Blueink é uma solução avançada de eSignature que simplifica o processo de assinatura de documento, facilitando o envio, a assinatura e o gerenciamento de documentos eletrônicos com segurança.

2. O que é o Microsoft Connector para Blueink?

  • O Microsoft Connector para Blueink é uma ferramenta que permite aos usuários integrar a solução de eSignature do Blueink perfeitamente ao Microsoft Power Automate, habilitando a automação e o gerenciamento aprimorado de documentos.

3. Como funciona o Microsoft Connector para Blueink?

  • O conector permite que você crie fluxos de trabalho automatizados combinando o Blueink com outros conectores do Power Automate. Você pode automatizar a criação e a distribuição de pacotes de documentos, aprimorando os processos de gerenciamento de documentos.

4. Quais são alguns casos de uso para o Microsoft Connector para Blueink?

  • Os casos de uso comuns incluem a automatização de aprovações de contratos, o gerenciamento de documentos legais, a simplificação dos processos de papelada e a garantia de uma experiência de assinatura de documentos suave e eficiente para clientes e stakeholders.

5. Posso usar o Microsoft Connector para Blueink com outros produtos da Microsoft?

  • Sim, o conector foi projetado para funcionar perfeitamente com vários produtos e serviços da Microsoft, permitindo que você integre as eSignatures blueink em seus fluxos de trabalho centrados na Microsoft.

6. O Microsoft Connector para Blueink é fácil de configurar e usar?

  • Sim, é fácil de usar e projetado para ser simples. Você pode configurar e personalizar seus fluxos de trabalho para atender às suas necessidades específicas de gerenciamento de documentos.

7. Há algum custo associado ao uso do Microsoft Connector para Blueink?

  • Os preços podem variar de acordo com seus contratos de uso e licenciamento. É melhor verificar com o Blueink ou a Microsoft detalhes de preços específicos.

8. Posso obter suporte para problemas técnicos com o Microsoft Connector para Blueink?

  • Sim, o Blueink e a Microsoft normalmente oferecem recursos de suporte e documentação para ajudar em quaisquer problemas técnicos ou perguntas que você possa ter sobre o uso do conector.

9. O Microsoft Connector para Blueink é compatível com os serviços Microsoft baseados em nuvem e windows?

  • Sim, o conector foi projetado para funcionar com serviços locais e baseados em nuvem da Microsoft, fornecendo flexibilidade em suas opções de integração.

10. Onde posso encontrar mais informações sobre o Microsoft Connector para Blueink?

  • Para obter informações adicionais, incluindo guias de instalação e documentação, você pode visitar o site do Blueink ou explorar a documentação do Microsoft Power Automate relacionada a esse conector.

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 Obrigatório
Chave de API blueink secureString Sua chave de API blueink. Isso pode ser criado no Blueink na guia API. O formato correto é "Token XXXXXX" em que XXXXXX é sua chave de API Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar marcas a um pacote

Adicione marcas adicionais a um Pacote. Nenhuma marca existente no Pacote é removida. O resultado dessa chamada é que Bundle.tags é a união do conjunto de marcas anteriores com o conjunto de novas marcas. As marcas duplicadas são ignoradas.
Atualizar parcialmente um Webhook

Atualize parcialmente o Webhook com novos dados.
Atualizar parcialmente um WebhookExtraHeader

Atualize parcialmente o WebhookExtraHeader com novos dados.
Atualizar parcialmente uma pessoa

Atualize parcialmente a Pessoa com novos dados.

Para adicionar um novo email ou telefone à Pessoa, inclua um ContactChannel na matriz 'channels' sem uma 'id'.

Para atualizar um ContactChannel existente associado à Pessoa, inclua uma 'id'. Esse ContactChannel existente será atualizado com o novo email ou telefone. Isso atualizará todos os Pacotes dinâmicos associados à Pessoa que está enviando para esse email (ou telefone).

Se um ContactChannel não incluir uma 'id', mas o email (ou telefone) corresponder a um ContactChannel existente, esse ContactChannel não será alterado.
Atualizar um pacote

Atualizar um pacote (também conhecido como signatário) com um novo email, número de telefone, nome ou opções de autenticação

O pacote atualizado ainda deve ser entregue. Por exemplo, se você especificar um deliver_via valor de "telefone", mas não houver nenhum número de telefone definido no PacketRequest original, essa solicitação também deverá incluir um phone ou um erro será retornado.

Você pode alterar um Pacote que foi originalmente configurado para assinatura inserida (ou seja, deliver_via foi 'inserida') a ser entregue por email ou SMS. No entanto, nenhuma notificação de assinatura ou lembretes será enviado automaticamente. Você deve chamar /packet/{packetId}/remind/ para enviar um email de notificação de assinatura (ou SMS).

Se esse Signatário estiver associado a uma Pessoa, a pessoa também será atualizada – o nome da pessoa será alterado (se fornecido) e qualquer novo email ou número de telefone será adicionado.
Atualizar um Webhook

Atualize o Webhook com novos dados. Observe que todas as assinaturas omitidas dessa solicitação serão EXCLUÍDAS. Se você não quiser substituir todos os dados no Webhook, provavelmente deseja usar PATCH.
Atualizar um WebhookExtraHeader

Atualizar o WebhookExtraHeader com novos dados
Atualizar uma pessoa

Atualize a Pessoa com novos dados. OBSERVE que todos os canais de contato que forem omitidos dessa solicitação serão EXCLUÍDOS. Se você não quiser substituir todos os dados na Pessoa, provavelmente deseja usar PATCH.
Cancelar um pacote

Cancelar o pacote especificado pelo Pacote Slug
Criar um pacote

Criar e enviar um pacote para assinatura
Criar um Webhook

Criar um novo Webhook
Criar um WebhookExtraHeader

Criar um novo cabeçalho do Webhook
Criar uma pessoa

Crie uma nova pessoa. Uma pessoa pode ser associada a um Usuário do BlueInk ou pode ser uma pessoa autônoma. Se você quiser criar uma pessoa associada a um usuário do BlueInk, você deverá fornecer o user_id campo. Se você quiser criar uma pessoa autônoma, deverá fornecer o name campo.
Criar uma URL de Assinatura Inserida

Criar uma URL que pode ser usada para assinatura inserida
Enviar um lembrete

Envie um email de lembrete ou SMS para um Signatário. Um lembrete só pode ser enviado uma vez a cada hora. O lembrete será enviado por meio do método de entrega (email ou SMS) e para o endereço de email (ou número de telefone) designado anteriormente para este Pacote.
Excluir um Webhook

Excluir um Webhook por ID
Excluir um WebhookExtraHeader

Excluir um WebhookExtraHeader
Excluir uma pessoa

Excluir uma pessoa. Isso também excluirá qualquer usuário blueink associado.
Listar eventos do pacote

Obter uma lista de eventos associados ao Pacote
Listar modelos de documento

Listar todos os modelos de documento
Listar pacotes

Retorna uma lista paginada de Pacotes em sua Conta, ordenada pela data de criação (da mais recente para a menos recente). A paginação pode ser controlada por meio de paramatadores de paginação (consulte Overview-Pagination>). Os paramatadores de filtros de querystring podem ser combinados, por exemplo. . /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention Ao combinar filtros, somente os pacotes correspondentes a TODOS os filtros são retornados.
Listar pessoas

Obtenha uma lista das Pessoas em sua conta. Opcionalmente, você pode filtrar a lista fornecendo uma consulta de pesquisa. Por exemplo, para pesquisar todas as pessoas com o nome "João", você usaria a consulta search=John.
Listar WebhookEvents

Listar todos os Eventos do Webhook em sua conta do BlueInk
Listar WebhookEvents

Listar todas as WebhookDeliveries em sua conta do BlueInk
Listar WebhookExtraHeaders

Listar todos os WebhookExtraHeaders em sua conta do BlueInk
Listar webhooks

Listar todos os Webhooks em sua conta do BlueInk
Obter segredo compartilhado do Webhook

Obter o Segredo Compartilhado do Webhook
Recuperar arquivos de pacote

Obter arquivos para download de um pacote concluído
Recuperar certificado de evidência de pacote

Obter um link e uma soma de verificação do Certificado de Evidência para este Pacote
Recuperar dados do pacote

Obter dados inseridos em campos para um pacote concluído
Recuperar um modelo de documento

Recuperar um modelo de documento
Recuperar um pacote

Recuperar um pacote por lesma
Recuperar um Webhook

Obter um Webhook por ID
Recuperar um WebhookExtraHeader

Recuperar os detalhes de um WebhookExtraHeader
Recuperar uma pessoa

Obter uma pessoa por ID
Regenerar segredo compartilhado do webhook

Regenerar o segredo compartilhado do webhook
Remover marcas de um pacote

Remova marcas de um Pacote. Se uma marca na solicitação não existir no Pacote, ela será ignorada.

Adicionar marcas a um pacote

ID da operação:
addBundleTags

Adicione marcas adicionais a um Pacote. Nenhuma marca existente no Pacote é removida. O resultado dessa chamada é que Bundle.tags é a união do conjunto de marcas anteriores com o conjunto de novas marcas. As marcas duplicadas são ignoradas.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote
tags
 tags array of string

Uma matriz de marcas

Atualizar parcialmente um Webhook

ID da operação:
updateWebhookartial

Atualize parcialmente o Webhook com novos dados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhookId True uuid

A ID que identifica exclusivamente o Webhook
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Retornos

Nome Caminho Tipo Description
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nome
 extra_headers.name string

deve aderir ao RFC 7230
ordem
 extra_headers.order integer
value
 extra_headers.value string

deve aderir ao RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Atualizar parcialmente um WebhookExtraHeader

ID da operação:
updateWebhookExtraHeaderPartial

Atualize parcialmente o WebhookExtraHeader com novos dados.

Parâmetros

Nome Chave Obrigatório Tipo Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

A ID que identifica exclusivamente o WebhookExtraHeader
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Retornos

Nome Caminho Tipo Description
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Atualizar parcialmente uma pessoa

ID da operação:
updatePersonPartial

Atualize parcialmente a Pessoa com novos dados.

Para adicionar um novo email ou telefone à Pessoa, inclua um ContactChannel na matriz 'channels' sem uma 'id'.

Para atualizar um ContactChannel existente associado à Pessoa, inclua uma 'id'. Esse ContactChannel existente será atualizado com o novo email ou telefone. Isso atualizará todos os Pacotes dinâmicos associados à Pessoa que está enviando para esse email (ou telefone).

Se um ContactChannel não incluir uma 'id', mas o email (ou telefone) corresponder a um ContactChannel existente, esse ContactChannel não será alterado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pessoa
 personId True uuid

A ID que identifica exclusivamente a Pessoa
email
 email email
id
 id uuid
variante
 kind string

em para email. mp para telefone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Retornos

Nome Caminho Tipo Description
canais
 channels array of object
email
 channels.email email
id
 channels.id uuid
variante
 channels.kind string

em para email. mp para telefone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Atualizar um pacote

ID da operação:
updatePacket

Atualizar um pacote (também conhecido como signatário) com um novo email, número de telefone, nome ou opções de autenticação

O pacote atualizado ainda deve ser entregue. Por exemplo, se você especificar um deliver_via valor de "telefone", mas não houver nenhum número de telefone definido no PacketRequest original, essa solicitação também deverá incluir um phone ou um erro será retornado.

Você pode alterar um Pacote que foi originalmente configurado para assinatura inserida (ou seja, deliver_via foi 'inserida') a ser entregue por email ou SMS. No entanto, nenhuma notificação de assinatura ou lembretes será enviado automaticamente. Você deve chamar /packet/{packetId}/remind/ para enviar um email de notificação de assinatura (ou SMS).

Se esse Signatário estiver associado a uma Pessoa, a pessoa também será atualizada – o nome da pessoa será alterado (se fornecido) e qualquer novo email ou número de telefone será adicionado.

Parâmetros

Nome Chave Obrigatório Tipo Description
Lesma de pacote
 packetId True string

A lesma que identifica exclusivamente o Pacote
body
 body

Atualizar um Webhook

ID da operação:
updateWebhook

Atualize o Webhook com novos dados. Observe que todas as assinaturas omitidas dessa solicitação serão EXCLUÍDAS. Se você não quiser substituir todos os dados no Webhook, provavelmente deseja usar PATCH.

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhookId True uuid

A ID que identifica exclusivamente o Webhook
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Retornos

Nome Caminho Tipo Description
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nome
 extra_headers.name string

deve aderir ao RFC 7230
ordem
 extra_headers.order integer
value
 extra_headers.value string

deve aderir ao RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Atualizar um WebhookExtraHeader

ID da operação:
updateWebhookExtraHeader

Atualizar o WebhookExtraHeader com novos dados

Parâmetros

Nome Chave Obrigatório Tipo Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

A ID que identifica exclusivamente o WebhookExtraHeader
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Retornos

Nome Caminho Tipo Description
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Atualizar uma pessoa

ID da operação:
updatePerson

Atualize a Pessoa com novos dados. OBSERVE que todos os canais de contato que forem omitidos dessa solicitação serão EXCLUÍDOS. Se você não quiser substituir todos os dados na Pessoa, provavelmente deseja usar PATCH.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pessoa
 personId True uuid

A ID que identifica exclusivamente a Pessoa
email
 email email
id
 id uuid
variante
 kind string

em para email. mp para telefone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Retornos

Nome Caminho Tipo Description
canais
 channels array of object
email
 channels.email email
id
 channels.id uuid
variante
 channels.kind string

em para email. mp para telefone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Cancelar um pacote

ID da operação:
cancelBundle

Cancelar o pacote especificado pelo Pacote Slug

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote

Criar um pacote

ID da operação:
createBundle

Criar e enviar um pacote para assinatura

Parâmetros

Nome Chave Obrigatório Tipo Description
body
 body

O corpo JSON que define o Pacote a ser criado

Criar um Webhook

ID da operação:
createWebhook

Criar um novo Webhook

Parâmetros

Nome Chave Obrigatório Tipo Description
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Retornos

Nome Caminho Tipo Description
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nome
 extra_headers.name string

deve aderir ao RFC 7230
ordem
 extra_headers.order integer
value
 extra_headers.value string

deve aderir ao RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Criar um WebhookExtraHeader

ID da operação:
createWebhookExtraHeader

Criar um novo cabeçalho do Webhook

Parâmetros

Nome Chave Obrigatório Tipo Description
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Retornos

Nome Caminho Tipo Description
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Criar uma pessoa

ID da operação:
createPerson

Crie uma nova pessoa. Uma pessoa pode ser associada a um Usuário do BlueInk ou pode ser uma pessoa autônoma. Se você quiser criar uma pessoa associada a um usuário do BlueInk, você deverá fornecer o user_id campo. Se você quiser criar uma pessoa autônoma, deverá fornecer o name campo.

Parâmetros

Nome Chave Obrigatório Tipo Description
email
 email email
id
 id uuid
variante
 kind string

em para email. mp para telefone.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Retornos

Nome Caminho Tipo Description
canais
 channels array of object
email
 channels.email email
id
 channels.id uuid
variante
 channels.kind string

em para email. mp para telefone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Criar uma URL de Assinatura Inserida

ID da operação:
createPacketEmbedURL

Criar uma URL que pode ser usada para assinatura inserida

Parâmetros

Nome Chave Obrigatório Tipo Description
Lesma de pacote
 packetId True string

A lesma que identifica exclusivamente o Pacote

Retornos

Nome Caminho Tipo Description
Expira
 expires date-time

Carimbo de data/hora indicando quando a URL expira
url
 url string

A URL que pode ser usada na assinatura inserida

Enviar um lembrete

ID da operação:
sendPacketReminder

Envie um email de lembrete ou SMS para um Signatário. Um lembrete só pode ser enviado uma vez a cada hora. O lembrete será enviado por meio do método de entrega (email ou SMS) e para o endereço de email (ou número de telefone) designado anteriormente para este Pacote.

Parâmetros

Nome Chave Obrigatório Tipo Description
Lesma de pacote
 packetId True string

A lesma que identifica exclusivamente o Pacote

Excluir um Webhook

ID da operação:
deleteWebhook

Excluir um Webhook por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhookId True uuid

A ID que identifica exclusivamente o Webhook

Excluir um WebhookExtraHeader

ID da operação:
deleteWebhookExtraHeader

Excluir um WebhookExtraHeader

Parâmetros

Nome Chave Obrigatório Tipo Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

A ID que identifica exclusivamente o WebhookExtraHeader

Excluir uma pessoa

ID da operação:
deletePerson

Excluir uma pessoa. Isso também excluirá qualquer usuário blueink associado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pessoa
 personId True uuid

A ID que identifica exclusivamente a Pessoa

Listar eventos do pacote

ID da operação:
listBundleEvents

Obter uma lista de eventos associados ao Pacote

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote

Retornos

Nome Caminho Tipo Description
array of object
descrição
 description string

Uma breve eliminação do evento
variante
 kind string

O tipo do evento como um código de 2 caracteres
packet_id
 packet_id uuid

A UUID de um pacote. Só estará presente se o evento estiver associado a um pacote específico.
carimbo de data/hora
 timestamp date-time

A hora em que o evento ocorreu

Listar modelos de documento

ID da operação:
listTemplates

Listar todos os modelos de documento

Retornos

Nome Caminho Tipo Description
fields
 fields array of

Uma matriz de campos colocada no documento. Observe que os campos DocumentTemplate são ligeiramente diferentes dos campos DocumentRequest, tendo um default_value e editor_roles em vez de initial_value .editors
file_url
 file_url string

A URL do arquivo original que serve como base para este modelo
is_shared
 is_shared boolean

True se o Modelo de Documento for compartilhado. Falso caso contrário
nome
 name string

O nome do documento. O padrão é o nome do arquivo ou o documento quando ele foi carregado, mas pode ser definido como um nome amigável ao ser humano.
funções
 roles array of object
chave
 roles.key string

Uma cadeia de caracteres exclusiva para este documento que identifica essa função
etiqueta
 roles.label string

Um rótulo amigável para essa função

Listar pacotes

ID da operação:
listBundles

Retorna uma lista paginada de Pacotes em sua Conta, ordenada pela data de criação (da mais recente para a menos recente). A paginação pode ser controlada por meio de paramatadores de paginação (consulte Overview-Pagination>). Os paramatadores de filtros de querystring podem ser combinados, por exemplo. . /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention Ao combinar filtros, somente os pacotes correspondentes a TODOS os filtros são retornados.

Parâmetros

Nome Chave Obrigatório Tipo Description
Consulta de pesquisa
 search string

Uma consulta de pesquisa. Somente os pacotes correspondentes à pesquisa serão retornados. Os seguintes dados no Pacote são pesquisados:

  • lesma do pacote
  • rótulo do pacote
  • pacote custom_key
  • nome do signatário
  • email do signatário
  • telefones signatários

Por exemplo, /bundles/?search=foobar@example.com
Status do pacote
 status string

Limite os pacotes para aqueles com o status especificado.

  • dr: Rascunho – o pacote ainda não foi enviado
  • se: Enviado - o Pacote foi enviado, mas ainda não foi iniciado por nenhum Signatário
  • st: Iniciado - pelo menos um Signatário começou a revisar os documentos
  • co: Complete - todos os signatários concluíram a revisão/assinatura
  • ca: Cancelado - o Pacote foi cancelado
  • ex: Expirado – o pacote expirou antes de ser concluído
  • fa: Falha - ocorreu um erro e o Pacote não pôde ser criado ou concluído

Por exemplo, /bundles/?status=co
Lista de status do pacote
 status__in string

Limite os pacotes para aqueles com um dos status especificados. Os status devem ser separados por vírgula. Por exemplo, /bundles/?status=co,se,st
Marca de pacote
 tag string

Retornar pacotes que têm a marca fornecida. Por exemplo, /bundles/?tag=some-tag
Lista de marcas de pacote
 tag__in string

Retorne pacotes que tenham pelo menos uma das marcas fornecidas. As marcas devem ser separadas por vírgula. Por exemplo, /bundles/?tag=some-tag,another-tag
Ordem de classificação de pacote
 ordering string

Controlar a ordem de classificação de Pacotes. Prefixo com "-" para reverter a ordem de classificação. Por padrão, os Pacotes são classificados por "-created", ou seja, a data de criação do Pacote da mais para a menos recente.

Retornos

Nome Caminho Tipo Description
array of

Listar pessoas

ID da operação:
listPersons

Obtenha uma lista das Pessoas em sua conta. Opcionalmente, você pode filtrar a lista fornecendo uma consulta de pesquisa. Por exemplo, para pesquisar todas as pessoas com o nome "João", você usaria a consulta search=John.

Parâmetros

Nome Chave Obrigatório Tipo Description
Consulta de pesquisa
 search string

Uma consulta de pesquisa.

Retornos

Nome Caminho Tipo Description
array of object
canais
 channels array of object
email
 channels.email email
id
 channels.id uuid
variante
 channels.kind string

em para email. mp para telefone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Listar WebhookEvents

ID da operação:
listWebhookEvents

Listar todos os Eventos do Webhook em sua conta do BlueInk

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhook uuid

Somente WebhookEvents correspondentes à ID do webhook selecionada serão retornados.

Por exemplo, /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Tipo de evento
 event_type string

Somente WebhookEvents com webhooks correspondentes aos event_type ou event_types selecionados serão retornados.

Por exemplo, /webhooks/events/?event_type=bundle_sent por exemplo, /webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Situação
 status integer

Somente WebhookEvents correspondentes ao status selecionado serão retornados.

Por exemplo, /webhooks/events/?status=1 por exemplo, /webhooks/events/?status__in=0,1,2
Resultado do êxito
 success boolean

Somente WebhookEvents correspondentes ao status de êxito selecionado serão retornados.

Por exemplo, /webhooks/events/?success=true
Intervalo de datas
 date date-time

Somente WebhookEvents que ocorrem entre um intervalo de datas serão retornados. Observação: as datas são expressas como formato YYYY-MM-DD.

Por exemplo, /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Retornos

Nome Caminho Tipo Description
array of object
criadas
 created date-time
Entregas
 deliveries array of object
mensagem
 deliveries.message string

uma mensagem que descreve quaisquer problemas
pk
 deliveries.pk uuid
status
 deliveries.status integer

mensagem de status da resposta ou 0 se nenhum status
carimbo de data/hora
 deliveries.timestamp date-time

quando ocorreu a tentativa de entrega (o início da tentativa, não quando ela falhou, por exemplo, para um tempo limite)
event_type
 event_type string
conteúdo
 payload string

o conteúdo a ser enviado na entrega; json
pk
 pk uuid
status
 status integer

o código de status da última resposta do ponto de extremidade do webhook. 0 indica que nenhuma resposta foi recebida
sucesso
 success boolean
webhook
 webhook uuid

UUID identificando a qual webhook o Evento pertence

Listar WebhookEvents

ID da operação:
listWebhookDeliveries

Listar todas as WebhookDeliveries em sua conta do BlueInk

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhook uuid

Somente WebhookDeliveries que correspondem à ID do webhook selecionada serão retornadas.

Por exemplo, /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
ID do evento webhook
 webhook_event uuid

Somente WebhookDeliveries correspondentes à ID de webhook_event selecionada serão retornadas.

Por exemplo, /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Tipo de evento
 event_type string

Somente WebhookDeliveries com webhooks correspondentes aos event_type ou event_types selecionados serão retornados.

Por exemplo, /webhooks/deliveries/?event_type=bundle_sent por exemplo, /webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Situação
 status integer

Somente WebhookDeliveries correspondentes ao status selecionado serão retornados.

Por exemplo, /webhooks/deliveries/?status=1 por exemplo, /webhooks/deliveries/?status__in=0,1,2
Intervalo de datas
 date date-time

Somente WebhookDeliveries que ocorrem entre um intervalo de datas serão retornados. Observação: as datas são expressas como formato YYYY-MM-DD.

Por exemplo, /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Retornos

Nome Caminho Tipo Description
array of object
criadas
 created date-time
Entregas
 deliveries array of object
mensagem
 deliveries.message string

uma mensagem que descreve quaisquer problemas
pk
 deliveries.pk uuid
status
 deliveries.status integer

mensagem de status da resposta ou 0 se nenhum status
carimbo de data/hora
 deliveries.timestamp date-time

quando ocorreu a tentativa de entrega (o início da tentativa, não quando ela falhou, por exemplo, para um tempo limite)
event_type
 event_type string
conteúdo
 payload string

o conteúdo a ser enviado na entrega; json
pk
 pk uuid
status
 status integer

o código de status da última resposta do ponto de extremidade do webhook. 0 indica que nenhuma resposta foi recebida
sucesso
 success boolean
webhook
 webhook uuid

UUID identificando a qual webhook o Evento pertence

Listar WebhookExtraHeaders

ID da operação:
listWebhookExtraHeaders

Listar todos os WebhookExtraHeaders em sua conta do BlueInk

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhook uuid

Somente WebhookExtraHeaders que correspondem à ID do webhook selecionada serão retornados.

Por exemplo, /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Tipo de evento
 event_type string

Somente WebhookExtraHeaders com webhooks correspondentes aos event_type ou event_types selecionados serão retornados.

Por exemplo, /webhooks/headers/?event_type=bundle_sent por exemplo, /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Retornos

Nome Caminho Tipo Description
array of object
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Listar webhooks

ID da operação:
listWebhooks

Listar todos os Webhooks em sua conta do BlueInk

Parâmetros

Nome Chave Obrigatório Tipo Description
Enabled
 enabled boolean

Somente webhooks correspondentes ao estado "habilitado" selecionado serão retornados.

Por exemplo, /webhooks/?enabled=true
Tipo de evento
 event_type string

Somente webhooks correspondentes ao event_type ou event_types selecionados serão retornados.

Por exemplo, /webhooks/?event_type=bundle_sent por exemplo, /webhooks/?event_type__in=bundle_error,bundle_cancelled

Retornos

Nome Caminho Tipo Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nome
 extra_headers.name string

deve aderir ao RFC 7230
ordem
 extra_headers.order integer
value
 extra_headers.value string

deve aderir ao RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Obter segredo compartilhado do Webhook

ID da operação:
getWebhookSecret

Obter o Segredo Compartilhado do Webhook

Retornos

Nome Caminho Tipo Description
create_date
 create_date date-time
segredo
 secret b58

Recuperar arquivos de pacote

ID da operação:
getBundleFiles

Obter arquivos para download de um pacote concluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote

Retornos

Nome Caminho Tipo Description
array of object
Expira
 expires string

A hora em que o link expira, como um tempo formatado iso 8601
file_url
 file_url string

a URL de onde o arquivo pode ser baixado

Recuperar certificado de evidência de pacote

ID da operação:
getPacketCOE

Obter um link e uma soma de verificação do Certificado de Evidência para este Pacote

Parâmetros

Nome Chave Obrigatório Tipo Description
Lesma de pacote
 packetId True string

A lesma que identifica exclusivamente o Pacote

Recuperar dados do pacote

ID da operação:
getBundleData

Obter dados inseridos em campos para um pacote concluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote

Retornos

Nome Caminho Tipo Description
array of object
attachments
 attachments array of object

Uma matriz de anexos de arquivo para um campo de anexo ou nulo
Ext
 attachments.ext string

A extensão de arquivo
is_image
 attachments.is_image boolean

true se este arquivo de anexo for uma imagem
nome
 attachments.name string

Nome do arquivo do anexo
núm
 attachments.num integer

A ordem na qual o arquivo foi adicionado, se houver vários uploads para um único campo de anexo (por exemplo, uma foto para cada página de um documento tirada com uma webcam)
size
 attachments.size integer

Tamanho do arquivo, em bytes
url
 attachments.url url

Uma URL que pode ser usada temporariamente para baixar o arquivo de anexo
doc_key
 doc_key string

A chave que identifica exclusivamente este documento no Pacote (do BundleRequest original)
field_key
 field_key string

A chave que identifica exclusivamente o campo no Documento (conforme especificado no DocumentRequestField original no DocumentRequest em BundleRequest ou configurado no DocumentTemplate)
filled_by
 filled_by string

A chave packet do signatário que inseriu o valor para este campo. Se o valor do campo for um 'initial_value' não editado por um signatário, o valor será 'inicial'. Se o valor do campo for o valor padrão configurado em um DocumentTemplate, o preenchimento será 'padrão'.
variante
 kind string

O tipo de campo
etiqueta
 label string

O rótulo do campo (possivelmente em branco)
packet_id
 packet_id

A ID de pacote do signatário que inseriu o valor desse campo ou nulo se o valor do campo não foi preenchido por um signatário (ou seja, era um valor initial_value ou desfator).
value
 value

O valor do campo .

Recuperar um modelo de documento

ID da operação:
retrieveTemplate

Recuperar um modelo de documento

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
 templateId True uuid

A ID que identifica exclusivamente o modelo

Retornos

Nome Caminho Tipo Description
fields
 fields array of

Uma matriz de campos colocada no documento. Observe que os campos DocumentTemplate são ligeiramente diferentes dos campos DocumentRequest, tendo um default_value e editor_roles em vez de initial_value .editors
file_url
 file_url string

A URL do arquivo original que serve como base para este modelo
is_shared
 is_shared boolean

True se o Modelo de Documento for compartilhado. Falso caso contrário
nome
 name string

O nome do documento. O padrão é o nome do arquivo ou o documento quando ele foi carregado, mas pode ser definido como um nome amigável ao ser humano.
funções
 roles array of object
chave
 roles.key string

Uma cadeia de caracteres exclusiva para este documento que identifica essa função
etiqueta
 roles.label string

Um rótulo amigável para essa função

Recuperar um pacote

ID da operação:
retrieveBundle

Recuperar um pacote por lesma

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote

Recuperar um Webhook

ID da operação:
getWebhook

Obter um Webhook por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
Webhook ID
 webhookId True uuid

A ID que identifica exclusivamente o Webhook

Retornos

Nome Caminho Tipo Description
enabled
 enabled boolean
event_types
 event_types array of string

tipos de eventos que dispararão o webhook
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
nome
 extra_headers.name string

deve aderir ao RFC 7230
ordem
 extra_headers.order integer
value
 extra_headers.value string

deve aderir ao RFC 7230
webhook
 extra_headers.webhook uuid
id
 id uuid
json
 json boolean
url
 url url

deve ser a URL completa, incluindo http/https

Recuperar um WebhookExtraHeader

ID da operação:
getWebhookExtraHeader

Recuperar os detalhes de um WebhookExtraHeader

Parâmetros

Nome Chave Obrigatório Tipo Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

A ID que identifica exclusivamente o WebhookExtraHeader

Retornos

Nome Caminho Tipo Description
id
 id uuid
nome
 name string

deve aderir ao RFC 7230
ordem
 order integer
value
 value string

deve aderir ao RFC 7230
webhook
 webhook uuid

Recuperar uma pessoa

ID da operação:
getPerson

Obter uma pessoa por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da pessoa
 personId True uuid

A ID que identifica exclusivamente a Pessoa

Retornos

Nome Caminho Tipo Description
canais
 channels array of object
email
 channels.email email
id
 channels.id uuid
variante
 channels.kind string

em para email. mp para telefone.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

True se essa pessoa estiver associada a um usuário do BlueInk
metadados
 metadata object

Metadados a serem associados a essa pessoa. Os metadados podem ser usados no SmartFill para preencher documentos automaticamente. Consulte a documentação do SmartFill para obter detalhes.
nome
 name string

O nome da pessoa

Regenerar segredo compartilhado do webhook

ID da operação:
regenerateWebhookSecret

Regenerar o segredo compartilhado do webhook

Retornos

Nome Caminho Tipo Description
create_date
 create_date date-time
segredo
 secret b58

Remover marcas de um pacote

ID da operação:
removeBundleTags

Remova marcas de um Pacote. Se uma marca na solicitação não existir no Pacote, ela será ignorada.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pacote Slug
 bundleSlug True string

A lesma que identifica exclusivamente o Pacote
tags
 tags array of string

Uma matriz de marcas