Tinta Azul

O conector Blueink permite que você adicione a plataforma de assinatura eletrônica da Blueink em fluxos de trabalho automatizados. O conector permite verificar o status do pacote, criar novos pacotes, acessar informações do signatário e muito mais.

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 Blueink
URL	https://help.blueink.com/en/
Email	support@blueink.com

Metadados do conector
Editora	Tinta azul
Sítio Web	https://blueink.com
Política de privacidade	https://blueink.com/privacy-policy/
Categorias	Gestão Empresarial; Produtividade

Com este conector versátil, os usuários podem integrar perfeitamente a poderosa solução de assinatura eletrônica da Blueink em seu fluxo de trabalho, aproveitando os recursos de vários conectores Power Automatic. Essa integração permite que os usuários automatizem a criação e 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, melhorar a eficiência e garantir uma experiência de assinatura de documentos perfeita e eficiente para seus clientes e partes interessadas. Seja automatizando aprovações de contratos, processando documentos legais ou gerenciando papelada 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 do blueink.com.

Como obter credenciais

Depois de criar sua conta, clique no botão API no lado esquerdo da página. Em Chaves de API privadas, pressione o botão Adicionar chave de API . Dê um rótulo à chave da API e pressione enviar. Copie a chave da API e salve-a em algum lugar, porque 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. Inserir sua chave de API deve se parecer com 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 saber como a variável body poderia parecer. Imagem abaixo como um exemplo de um corpo de criação de pacote.

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 obter mais maneiras pelas quais 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 manter-se atualizado com todos os seus pacotes concluídos mais recentes usando este endpoint.

Problemas conhecidos e limitações

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

Erros e soluções comuns

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

Se você receber um erro sobre uma entrada inválida ao criar um pacote, certifique-se de que é JSON válido que está sendo enviado para Blueink.

FAQ

1. O que é Blueink?

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

2. O que é o Microsoft Connector para Blueink?

• O Microsoft Connector for Blueink é uma ferramenta que permite aos usuários integrar a solução de assinatura eletrônica da Blueink perfeitamente com o Microsoft Power Automate, permitindo automação e gerenciamento de documentos aprimorado.

3. Como funciona o Microsoft Connector for Blueink?

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

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

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

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 assinaturas eletrônicas Blueink em seus fluxos de trabalho centrados na Microsoft.

6. O Microsoft Connector for 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. Existe algum custo associado ao uso do Microsoft Connector para Blueink?

• Os preços podem variar com base nos seus contratos de utilização e licenciamento. É melhor verificar com Blueink ou Microsoft para obter detalhes de preços específicos.

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

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

9. O Microsoft Connector for Blueink é compatível com o Windows e com os serviços da Microsoft baseados na nuvem?

• Sim, o conector foi projetado para funcionar com serviços Microsoft locais e baseados em nuvem, oferecendo 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 configuração e documentação, você pode visitar o site Blueink ou explorar a documentação do Microsoft Power Automate relacionada a esse conector.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

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

Nome	Tipo	Description	Obrigatório
Chave da API Blueink	securestring	Sua chave de API Blueink. Isso pode ser criado no Blueink na guia API. O formato correto é 'Token XXXXXX' onde XXXXXX é a sua chave API	Verdade

Limites de Limitação

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

Ações

Adicionar tags a um pacote	Adicione tags adicionais a um pacote. Nenhuma tag existente no pacote é removida. O resultado dessa chamada é que Bundle.tags é a união do conjunto de tags anteriores com o conjunto de novas tags. As tags 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	Atualizar parcialmente a Pessoa com novos dados. Para adicionar um novo e-mail ou telefone à Pessoa, inclua um ContactChannel na matriz 'canais' sem um 'id'. Para atualizar um ContactChannel existente associado à Pessoa, inclua um 'id'. Esse ContactChannel existente será atualizado com o novo e-mail ou telefone. Isso atualizará todos os Pacotes ao vivo associados à Pessoa que estão enviando para esse e-mail (ou telefone). Se um ContactChannel não incluir um 'id', mas o e-mail (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 e-mail, número de telefone, nome ou opções de autenticação O pacote atualizado ainda deve ser entregue. Por exemplo, se você especificar um valor de 'telefone', mas não houver nenhum deliver_via 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 incorporada (ou seja, deliver_via foi 'incorporado') para ser entregue por e-mail ou SMS. No entanto, nenhuma notificação ou lembrete de assinatura será enviado automaticamente. Você deve ligar para /packet/{packetId}/remind/ para enviar um e-mail de notificação de assinatura (ou SMS). Se este Signatário estiver associado a uma Pessoa, a pessoa também será atualizada - o nome da Pessoa será alterado (se fornecido) e qualquer novo e-mail ou número de telefone será adicionado.
Atualizar um Webhook	Atualize o Webhook com novos dados. NOTA que todas as subscrições omitidas deste pedido serão ELIMINADAS. Se você não quiser substituir todos os dados no Webhook, você provavelmente deseja usar PATCH em vez disso.
Atualizar um WebhookExtraHeader	Atualizar o WebhookExtraHeader com novos dados
Atualizar uma pessoa	Atualize a Pessoa com novos dados. NOTA que todos os canais de contacto que forem omitidos deste pedido serão ELIMINADOS. Se você não quiser substituir todos os dados na Pessoa, provavelmente deseja usar o PATCH.
Cancelar um pacote	Cancelar o pacote especificado pelo Bundle Slug
Criar um pacote	Criar e enviar um pacote para assinatura
Criar um URL de assinatura incorporado	Criar um URL que possa ser usado para assinatura incorporada
Criar um Webhook	Criar um novo Webhook
Criar um WebhookExtraHeader	Criar um novo cabeçalho Webhook
Criar uma pessoa	Crie uma nova pessoa. Uma pessoa pode ser associada a um usuário BlueInk ou pode ser uma pessoa independente. Se você quiser criar uma pessoa associada a um usuário BlueInk, você deve fornecer o user_id campo. Se você quiser criar uma pessoa independente, você deve fornecer o name campo.
Enviar um lembrete	Envie um e-mail ou SMS de lembrete para um signatário. Um lembrete só pode ser enviado uma vez a cada hora. O lembrete será enviado através do método de entrega (e-mail ou SMS) e para o endereço de e-mail (ou número de telefone) previamente designado 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.
Lista de Pessoas	Obtenha uma lista das Pessoas na 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 eventos do pacote	Obter uma lista de Eventos associados ao Pacote
Listar modelos de documentos	Listar todos os modelos de documentos
Listar Pacotes	Devolve uma lista paginada de Pacotes na sua Conta, ordenados por data de criação (da mais recente para a menos recente). A paginação pode ser controlada através de paramaters de paginação (ver Visão geral-paginação>). Os paramaters de filtros Querystring podem ser combinados, por exemplo, /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Ao combinar filtros, apenas os Bundles correspondentes a TODOS os filtros são retornados.
Listar WebhookEvents	Listar todos os eventos Webhook na sua conta BlueInk
Listar WebhookEvents	Liste todos os WebhookDeliveries na sua conta BlueInk
Listar WebhookExtraHeaders	Listar todos os WebhookExtraHeaders na sua conta BlueInk
Listar Webhooks	Listar todos os Webhooks em sua conta BlueInk
Obter Webhook Segredo Compartilhado	Obtenha o segredo compartilhado do Webhook
Recuperar arquivos de pacote	Obter arquivos para download para 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 Webhook Segredo Compartilhado	Regenerar o segredo compartilhado do Webhook
Remover tags de um pacote	Remova tags de um pacote. Se uma tag na solicitação não existir no pacote, ela será ignorada.

Adicionar tags a um pacote

ID da Operação:

addBundleTags

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

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	bundleSlug	True	string	A lesma que identifica exclusivamente o pacote
tags	tags		array of string	Uma matriz de tags

Atualizar parcialmente um Webhook

ID da Operação:

updateWebhookartial

Atualize parcialmente o Webhook com novos dados.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Identificador do Webhook	webhookId	True	uuid	O 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
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid
id	id		uuid
Json	json		boolean
URL	url		url	deve ser o URL completo, incluindo http/https

Regressos

Nome	Percurso	Tipo	Descrição
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
order	extra_headers.order	integer
valor	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 o URL completo, incluindo http/https

Atualizar parcialmente um WebhookExtraHeader

ID da Operação:

updateWebhookExtraHeaderPartial

Atualize parcialmente o WebhookExtraHeader com novos dados.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	A ID que identifica exclusivamente o WebhookExtraHeader
id	id		uuid
nome	name		string	deve aderir ao RFC 7230
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid

Regressos

Nome	Percurso	Tipo	Descrição
id	id	uuid
nome	name	string	deve aderir ao RFC 7230
order	order	integer
valor	value	string	deve aderir ao RFC 7230
webhook	webhook	uuid

Atualizar parcialmente uma pessoa

ID da Operação:

updatePersonPartial

Atualizar parcialmente a Pessoa com novos dados.

Para adicionar um novo e-mail ou telefone à Pessoa, inclua um ContactChannel na matriz 'canais' sem um 'id'.

Para atualizar um ContactChannel existente associado à Pessoa, inclua um 'id'. Esse ContactChannel existente será atualizado com o novo e-mail ou telefone. Isso atualizará todos os Pacotes ao vivo associados à Pessoa que estão enviando para esse e-mail (ou telefone).

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

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
ID da pessoa	personId	True	uuid	O ID que identifica exclusivamente a Pessoa
e-mail	email		email
id	id		uuid
tipo	kind		string	em para e-mail. MP para telefone.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata		object	Metadados para associar a esta 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

Regressos

Nome	Percurso	Tipo	Descrição
channels	channels	array of object
e-mail	channels.email	email
id	channels.id	uuid
tipo	channels.kind	string	em para e-mail. MP para telefone.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata	object	Metadados para associar a esta 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 e-mail, número de telefone, nome ou opções de autenticação

O pacote atualizado ainda deve ser entregue. Por exemplo, se você especificar um valor de 'telefone', mas não houver nenhum deliver_via 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 incorporada (ou seja, deliver_via foi 'incorporado') para ser entregue por e-mail ou SMS. No entanto, nenhuma notificação ou lembrete de assinatura será enviado automaticamente. Você deve ligar para /packet/{packetId}/remind/ para enviar um e-mail de notificação de assinatura (ou SMS).

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

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	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. NOTA que todas as subscrições omitidas deste pedido serão ELIMINADAS. Se você não quiser substituir todos os dados no Webhook, você provavelmente deseja usar PATCH em vez disso.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Identificador do Webhook	webhookId	True	uuid	O 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
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid
id	id		uuid
Json	json		boolean
URL	url		url	deve ser o URL completo, incluindo http/https

Regressos

Nome	Percurso	Tipo	Descrição
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
order	extra_headers.order	integer
valor	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 o URL completo, incluindo http/https

Atualizar um WebhookExtraHeader

ID da Operação:

updateWebhookExtraHeader

Atualizar o WebhookExtraHeader com novos dados

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	A ID que identifica exclusivamente o WebhookExtraHeader
id	id		uuid
nome	name		string	deve aderir ao RFC 7230
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid

Regressos

Nome	Percurso	Tipo	Descrição
id	id	uuid
nome	name	string	deve aderir ao RFC 7230
order	order	integer
valor	value	string	deve aderir ao RFC 7230
webhook	webhook	uuid

Atualizar uma pessoa

ID da Operação:

updatePerson

Atualize a Pessoa com novos dados. NOTA que todos os canais de contacto que forem omitidos deste pedido serão ELIMINADOS. Se você não quiser substituir todos os dados na Pessoa, provavelmente deseja usar o PATCH.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
ID da pessoa	personId	True	uuid	O ID que identifica exclusivamente a Pessoa
e-mail	email		email
id	id		uuid
tipo	kind		string	em para e-mail. MP para telefone.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata		object	Metadados para associar a esta 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

Regressos

Nome	Percurso	Tipo	Descrição
channels	channels	array of object
e-mail	channels.email	email
id	channels.id	uuid
tipo	channels.kind	string	em para e-mail. MP para telefone.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata	object	Metadados para associar a esta 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 Bundle Slug

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
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	Necessário	Tipo	Descrição
body	body			O corpo JSON que define o pacote a ser criado

Criar um URL de assinatura incorporado

ID da Operação:

createPacketEmbedURL

Criar um URL que possa ser usado para assinatura incorporada

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	packetId	True	string	A lesma que identifica exclusivamente o pacote

Regressos

Nome	Percurso	Tipo	Descrição
expira	expires	date-time	Carimbo de data/hora indicando quando url expira
URL	url	string	O URL que pode ser usado para assinatura incorporada

Criar um Webhook

ID da Operação:

createWebhook

Criar um novo Webhook

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
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
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid
id	id		uuid
Json	json		boolean
URL	url		url	deve ser o URL completo, incluindo http/https

Regressos

Nome	Percurso	Tipo	Descrição
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
order	extra_headers.order	integer
valor	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 o URL completo, incluindo http/https

Criar um WebhookExtraHeader

ID da Operação:

createWebhookExtraHeader

Criar um novo cabeçalho Webhook

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
id	id		uuid
nome	name		string	deve aderir ao RFC 7230
order	order		integer
valor	value		string	deve aderir ao RFC 7230
webhook	webhook		uuid

Regressos

Nome	Percurso	Tipo	Descrição
id	id	uuid
nome	name	string	deve aderir ao RFC 7230
order	order	integer
valor	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 BlueInk ou pode ser uma pessoa independente. Se você quiser criar uma pessoa associada a um usuário BlueInk, você deve fornecer o user_id campo. Se você quiser criar uma pessoa independente, você deve fornecer o name campo.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
e-mail	email		email
id	id		uuid
tipo	kind		string	em para e-mail. MP para telefone.
phone	phone		phone
id	id		uuid
is_user	is_user		boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata		object	Metadados para associar a esta 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

Regressos

Nome	Percurso	Tipo	Descrição
channels	channels	array of object
e-mail	channels.email	email
id	channels.id	uuid
tipo	channels.kind	string	em para e-mail. MP para telefone.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata	object	Metadados para associar a esta 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

Enviar um lembrete

ID da Operação:

sendPacketReminder

Envie um e-mail ou SMS de lembrete para um signatário. Um lembrete só pode ser enviado uma vez a cada hora. O lembrete será enviado através do método de entrega (e-mail ou SMS) e para o endereço de e-mail (ou número de telefone) previamente designado para este pacote.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	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	Necessário	Tipo	Descrição
Identificador do Webhook	webhookId	True	uuid	O ID que identifica exclusivamente o Webhook

Excluir um WebhookExtraHeader

ID da Operação:

deleteWebhookExtraHeader

Excluir um WebhookExtraHeader

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
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	Necessário	Tipo	Descrição
ID da pessoa	personId	True	uuid	O ID que identifica exclusivamente a Pessoa

Lista de Pessoas

ID da Operação:

listPersons

Obtenha uma lista das Pessoas na 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	Necessário	Tipo	Descrição
Consulta de pesquisa	search		string	Uma consulta de pesquisa.

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
channels	channels	array of object
e-mail	channels.email	email
id	channels.id	uuid
tipo	channels.kind	string	em para e-mail. MP para telefone.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata	object	Metadados para associar a esta 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 eventos do pacote

ID da Operação:

listBundleEvents

Obter uma lista de Eventos associados ao Pacote

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	bundleSlug	True	string	A lesma que identifica exclusivamente o pacote

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
descrição	description	string	Um breve resumo do evento
tipo	kind	string	O tipo de evento como um código de 2 caracteres
packet_id	packet_id	uuid	O UUID de um pacote. Presente apenas se o evento estiver associado a um pacote específico.
carimbo de data/hora	timestamp	date-time	O momento em que o evento ocorreu

Listar modelos de documentos

ID da Operação:

listTemplates

Listar todos os modelos de documentos

Regressos

Nome	Percurso	Tipo	Descrição
campos	fields	array of	Uma matriz de campos colocados 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 e 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 para humanos.
roles	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 amigo do ser humano para este papel

Listar Pacotes

ID da Operação:

listBundles

Devolve uma lista paginada de Pacotes na sua Conta, ordenados por data de criação (da mais recente para a menos recente). A paginação pode ser controlada através de paramaters de paginação (ver Visão geral-paginação>). Os paramaters de filtros Querystring podem ser combinados, por exemplo, /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. Ao combinar filtros, apenas os Bundles correspondentes a TODOS os filtros são retornados.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Consulta de pesquisa	search		string	Uma consulta de pesquisa. Apenas os pacotes correspondentes à pesquisa serão devolvidos. Os seguintes dados no pacote são pesquisados: pacote slug rótulo do pacote pacote custom_key Nome do signatário E-mail do signatário Telefones signatários Por exemplo: /bundles/?search=foobar@example.com
Status do pacote	status		string	Limite os pacotes àqueles com o status especificado. dr: Rascunho - o pacote ainda não foi enviado se: Enviado - o pacote foi enviado, mas ainda não iniciado por nenhum signatário st: Iniciado - pelo menos um signatário começou a rever o(s) documento(s) co: Completo - 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 àqueles com um dos status especificados. Os status devem ser separados por vírgula. Por exemplo: /bundles/?status=co,se,st
Tag do pacote	tag		string	Retornar pacotes que tenham a tag fornecida. Por exemplo: /bundles/?tag=some-tag
Lista de tags de pacote	tag__in		string	Retornar pacotes que tenham pelo menos uma das tags fornecidas. As tags devem ser separadas por vírgula. Por exemplo: /bundles/?tag=some-tag,another-tag
Ordem de classificação do pacote	ordering		string	Controle a ordem de classificação de Bundles. Prefixo com "-" para inverter a ordem de classificação. Por padrão, os pacotes são classificados por "-created", ou seja, a data de criação do pacote do mais para o menos recente.

Regressos

Nome	Percurso	Tipo	Descrição
		array of

Listar WebhookEvents

ID da Operação:

listWebhookEvents

Listar todos os eventos Webhook na sua conta BlueInk

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Identificador do Webhook	webhook		uuid	Somente WebhookEvents correspondente ao ID do webhook selecionado será retornado. Por exemplo: /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Tipo de Evento	event_type		string	Somente WebhookEvents com webhooks correspondentes ao event_type ou event_types selecionado 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 correspondente ao status selecionado será retornado. Por exemplo, /webhooks/events/?status=1 por exemplo, /webhooks/events/?status__in=0,1,2
Resultado de Sucesso	success		boolean	Somente WebhookEvents correspondente ao status de sucesso selecionado será retornado. Por exemplo: /webhooks/events/?success=true
Intervalo de datas	date		date-time	Somente WebhookEvents que ocorrem entre um intervalo de datas serão retornados. Nota: As datas são expressas no formato AAAA-MM-DD. Por exemplo: /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
criado	created	date-time
entregas	deliveries	array of object
mensagem	deliveries.message	string	uma mensagem descrevendo quaisquer problemas
PK	deliveries.pk	uuid
estado	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 falhou, por exemplo, para um tempo limite)
event_type	event_type	string
payload	payload	string	a carga útil a enviar no momento da entrega; Json
PK	pk	uuid
estado	status	integer	O código de status da última resposta do ponto de extremidade 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

Liste todos os WebhookDeliveries na sua conta BlueInk

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Identificador do Webhook	webhook		uuid	Somente WebhookDeliveries correspondente ao ID do webhook selecionado será retornado. Por exemplo: /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
ID do evento Webhook	webhook_event		uuid	Somente WebhookDeliveries correspondente ao ID de webhook_event selecionado será retornado. Por exemplo: /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Tipo de Evento	event_type		string	Somente WebhookDeliveries com webhooks correspondentes ao event_type ou event_types selecionado serão devolvidos. 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	Apenas WebhookDeliveries que ocorram entre um intervalo de datas serão devolvidos. Nota: As datas são expressas no formato AAAA-MM-DD. Por exemplo: /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
criado	created	date-time
entregas	deliveries	array of object
mensagem	deliveries.message	string	uma mensagem descrevendo quaisquer problemas
PK	deliveries.pk	uuid
estado	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 falhou, por exemplo, para um tempo limite)
event_type	event_type	string
payload	payload	string	a carga útil a enviar no momento da entrega; Json
PK	pk	uuid
estado	status	integer	O código de status da última resposta do ponto de extremidade 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 na sua conta BlueInk

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Identificador do Webhook	webhook		uuid	Somente WebhookExtraHeaders correspondentes ao ID do webhook selecionado serão retornados. Por exemplo: /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Tipo de Evento	event_type		string	Somente WebhookExtraHeaders com webhooks correspondentes ao event_type ou event_types selecionado serão retornados. Por exemplo, /webhooks/headers/?event_type=bundle_sent por exemplo, /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
id	id	uuid
nome	name	string	deve aderir ao RFC 7230
order	order	integer
valor	value	string	deve aderir ao RFC 7230
webhook	webhook	uuid

Listar Webhooks

ID da Operação:

listWebhooks

Listar todos os Webhooks em sua conta BlueInk

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Ativado(a)	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 selecionado serão retornados. Por exemplo, /webhooks/?event_type=bundle_sent por exemplo, /webhooks/?event_type__in=bundle_error,bundle_cancelled

Regressos

Nome	Percurso	Tipo	Descrição
		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
order	extra_headers.order	integer
valor	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 o URL completo, incluindo http/https

Obter Webhook Segredo Compartilhado

ID da Operação:

getWebhookSecret

Obtenha o segredo compartilhado do Webhook

Regressos

Nome	Percurso	Tipo	Descrição
create_date	create_date	date-time
segredo	secret	b58

Recuperar arquivos de pacote

ID da Operação:

getBundleFiles

Obter arquivos para download para um pacote concluído

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	bundleSlug	True	string	A lesma que identifica exclusivamente o pacote

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
expira	expires	string	O tempo em que o link expira, como um tempo formatado ISO 8601
file_url	file_url	string	o URL a partir do qual o ficheiro pode ser transferido

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	Necessário	Tipo	Descrição
Pacote Slug	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	Necessário	Tipo	Descrição
Pacote Slug	bundleSlug	True	string	A lesma que identifica exclusivamente o pacote

Regressos

Nome	Percurso	Tipo	Descrição
		array of object
attachments	attachments	array of object	Uma matriz de anexos de arquivo para um campo de anexo ou null
extrato	attachments.ext	string	A extensão do arquivo
is_image	attachments.is_image	boolean	true se este ficheiro anexo for uma imagem
nome	attachments.name	string	Nome do ficheiro do anexo
num	attachments.num	integer	A ordem em que 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 ficheiro, em bytes
URL	attachments.url	url	Um URL que pode ser usado temporariamente para baixar o arquivo anexo
doc_key	doc_key	string	A chave que identifica exclusivamente este documento no Bundle (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 conforme configurado no DocumentTemplate)
filled_by	filled_by	string	A chave de pacote do signatário que inseriu o valor para este campo. Se o valor do campo foi um 'initial_value' não editado por um signatário, o valor é 'inicial'. Se o valor do campo foi o valor padrão configurado em um DocumentTemplate, o preenchimento é 'default'.
tipo	kind	string	O tipo de campo
etiqueta	label	string	O rótulo do campo (possivelmente em branco)
packet_id	packet_id		A ID do pacote do signatário que inseriu o valor para este campo, ou nula se o valor do campo não foi preenchido por um signatário (ou seja, era um valor initial_value ou defaul).
valor	value		O valor do campo.

Recuperar um modelo de documento

ID da Operação:

retrieveTemplate

Recuperar um modelo de documento

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
ID do modelo	templateId	True	uuid	A ID que identifica exclusivamente o Modelo

Regressos

Nome	Percurso	Tipo	Descrição
campos	fields	array of	Uma matriz de campos colocados 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 e 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 para humanos.
roles	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 amigo do ser humano para este papel

Recuperar um pacote

ID da Operação:

retrieveBundle

Recuperar um pacote por lesma

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
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	Necessário	Tipo	Descrição
Identificador do Webhook	webhookId	True	uuid	O ID que identifica exclusivamente o Webhook

Regressos

Nome	Percurso	Tipo	Descrição
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
order	extra_headers.order	integer
valor	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 o URL completo, incluindo http/https

Recuperar um WebhookExtraHeader

ID da Operação:

getWebhookExtraHeader

Recuperar os detalhes de um WebhookExtraHeader

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
WebhookExtraHeader ID	webhookExtraHeaderId	True	uuid	A ID que identifica exclusivamente o WebhookExtraHeader

Regressos

Nome	Percurso	Tipo	Descrição
id	id	uuid
nome	name	string	deve aderir ao RFC 7230
order	order	integer
valor	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	Necessário	Tipo	Descrição
ID da pessoa	personId	True	uuid	O ID que identifica exclusivamente a Pessoa

Regressos

Nome	Percurso	Tipo	Descrição
channels	channels	array of object
e-mail	channels.email	email
id	channels.id	uuid
tipo	channels.kind	string	em para e-mail. MP para telefone.
phone	channels.phone	phone
id	id	uuid
is_user	is_user	boolean	True se esta Pessoa estiver associada a um Usuário BlueInk
metadados	metadata	object	Metadados para associar a esta 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 Webhook Segredo Compartilhado

ID da Operação:

regenerateWebhookSecret

Regenerar o segredo compartilhado do Webhook

Regressos

Nome	Percurso	Tipo	Descrição
create_date	create_date	date-time
segredo	secret	b58

Remover tags de um pacote

ID da Operação:

removeBundleTags

Remova tags de um pacote. Se uma tag na solicitação não existir no pacote, ela será ignorada.

Parâmetros

Nome	Chave	Necessário	Tipo	Descrição
Pacote Slug	bundleSlug	True	string	A lesma que identifica exclusivamente o pacote
tags	tags		array of string	Uma matriz de tags