Para excluir um documento anexado, deverá utilizar o endpoint DEL https://api.aliare.digital/assinei/documentos/v1.0-rc/Anexo/{anexoId}, informando o anexoId por parâmetro e por request headers enviar o X-Tenant da conta do usuário logado.
Para verificar se a Documento API está funcionando corretamente, utilizar o endpoint GET https://api.aliare.digital/assinei/documentos/v1.0-rc/healthcheck, caso o retorno seja o código 200, está ok.
2.2.4 Cofre API
Os cofres são as “pastas” que os documentos serão armazenados, então não é necessário criar um cofre para cada documento, mas sim organizar os documentos. Deverá enviar por request header o X-Tenant da conta do usuário logado em todos os endpoints. Para listar todos os cofres e pastas do usuário logado deverá acessar o endpoint GET https://api.aliare.digital/assinei/cofres/v1.0-rc/Cofre[?nome], poderá enviar um nome específico de cofre ou caso queira listar todos os cofres, não é necessário passar essa informação;
Para inserir um novo cofre deverá utilizar o endpoint POST https://api.aliare.digital/assinei/cofres/v1.0-rc/Cofre. As informações que precisam enviar para
o sigilo do cofre são “Publico“ ou “Sigiloso“. Como informações não obrigatórias, poderá informar também a lista de usuários e observadores (somente usuários com o perfil de participante). Caso esse cofre seja um sub-cofre poderá enviar o id do cobre pai ou deixar o campo como null.
Para visualizar os detalhes de um cofre, utilizar o endpoint GET https://api.aliare.digital/assinei/cofres/v1.0-rc/Cofre[?nome] informando o id do cofre e o nome do cofre se desejar, porém o nome não é obrigatório.
Para consultar os usuários que tem acesso ao cofre e seus arquivos, poderá utilizar esse endpoint GET https://api.aliare.digital/assinei/cofres/v1.0-rc/Cofre/{cofreId}/usuarios e informar o id do cofre.
Para verificar se a Cofre API está funcionando corretamente, utilizar o endpoint GET https://api.aliare.digital/assinei/cofres/v1.0-rc/healthcheck, caso o retorno seja o código 200, está ok.
2.2.5 Participantes API
Para cadastrar um participante deverá utilizar o endpoint POST https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante, passar por Request headers X-Tenant (tenant da conta do usuário que está criando o participante). Os campos que precisam enviar para o cadastro do participante estão no ParticipanteModel (tabela abaixo), sendo que os campos nome, e-mail ou telefone ou documento (CPF, CNPJ, documento para pessoas estrangeiras) são obrigatórios. Essas informações servirão para o envio do documento para assinatura por SMS, WhatsApp ou E-mail.
Nome do campo | Ob. | Tipo | Descrição |
id | false | string (uuid) | - Identificador único do Participante.
- Criado automaticamente no cadastro de Participante.
|
tipoPessoa | false | string | - Tipo de pessoa que identifica o Participante.
- Valores possíveis: PessoaFisica, PessoaJuridica.
|
estrangeiro | false | boolean | - Campo para indicar se esse participante é estrangeiro, poi s não fazemos validação de CPF;
- Somente pessoa física poderá ser estrangeiro;
|
nome | true | string | - Campo obrigatório para cadastro.
|
email | false | string | - Campo opcional para cadastro.
|
razaoSocial | false | string | - Razão Social do participante, caso ele seja do tipo Pessoa Jurídica.
- Campo opcional para cadastro.
|
userId | false | string | - Identificador único que representa o Participante no cadastro de usuários. Campo não obrigatório para cadastro.
- Caso não preenchido, uma busca no banco de dados de usuários será
realizada para obter esse identificador. |
telefone | false | string | - Telefone do participante.
- Campo opcional no cadastro.
|
documento | false | string | - Documento (CPF, CNPJ ou documento estrangeiro) do
participante. |
Para editar um participante utilizar o endpoint PUT https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante/{participanteId} e passar por parâmetro o participanteId que gostaria de alterar. Também precisa passar por Request headers, o X-Tenant da conta do usuário logado. No corpo da requisição deverá enviar os campos que serão alterados.
Para remover um participante utilizar o endpoint DEL https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante/{participanteId}, enviando por parâmetro o participanteId e por Request headers o X-Tenant (Tenant da conta do usuário logado). Só poderá excluir participante que não possuem documentos assinados. Quando o participante já possuir documentos assinados, poderá editar o participante e inativá-lo.
Para obter todos os participantes cadastrados na conta, deverá utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante e enviar por Request headers, o X-Tenant da conta do usuário logado.
Para pesquisar um participante por e-mail, utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante/Email/{email}, enviando por parâmetro o e-mail do participante. E por Request headers enviar o X-Tenant da conta do usuário logado.
Para obter os detalhes de um participante utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/Participante/{participanteId}, passando por parâmetro o Id do participante (participanteId) e por Request headers informar o X-Tenant da conta do usuário logado. Para pesquisar o id do participante, poderá utilizar a pesquisa por e-mail ou listar todos os participantes da conta.
Para pesquisar um participante por nome, e-mail ou documento de identificação (CPF, CNPJ e documento estrangeiro), utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/participante/search/{texto}, passando por parâmetro o texto com uma dessas informações e por Request headers informar o X-Tenant da conta do usuário logado.
Para verificar se a Participante API está funcionando corretamente, utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/healthcheck, caso o retorno seja o código 200, está ok.
Para o endpoint de cadastrar um certificado, é necessário passar o id do usuário. Mas são somente para usuários que também estão cadastrados na Assinei e na Aliare, ou seja, hoje somente contas que possuem integração com a Plataforma Aliare conseguem utilizar esse endpoint. Futuramente vamos liberar endpoints para a consulta dos usuários que estão cadastrados na Assinei e Aliare.
Para cadastrar certificado digital do tipo A1 para um usuário específico, utilizar o endpoint POST https://api.aliare.digital/assinei/participantes/v1.0- rc/Usuario/{usuarioId}/Certificado, passando por parâmetro o id do usuário (usuarioId) e por Request headers passar o X-Tenant da conta do usuário logado. Para enviar o arquivo do certificado, utilizar CertificadoModel e CertificadoAddModel no corpo da request.
Para deletar um certificado chamar o endpoint DEL https://api.aliare.digital/assinei/participantes/v1.0-rc/Certificado/{certificadoId}, passando por parâmetro o certificadoId e por Request headers enviar o X-tenant da conta do usuário logado.
Para pesquisar um certificado específico, utilizar o método GET https://api.aliare.digital/assinei/participantes/v1.0-rc/Certificado/{certificadoId}, passando por parâmetro o certificadoId e por Request headers enviar o X-tenant da conta do usuário logado.
E para obter todos os certificados de um usuário específico, utilizar o endpoint GET https://api.aliare.digital/assinei/participantes/v1.0-rc/Usuario/{usuarioId}/Certificado, informando o id do usuário (usuarioId) por parâmetro e por Request headers informar o X- Tenant da conta do usuário logado.
2.2.6 Webhook API
O webhoook deverá ser criado para cada evento (a lista de eventos está logo abaixo) e para cada conta/cliente. Para cadastrar um novo webhook, deverá utilizar o endpoint POST https://api.aliare.digital/core/webhooks/v1.0-rc/Webhook/{tenantId} e enviar o tenantId da conta que está cadastrado na Aliare. Assim que o evento for executado na Assinei, será enviado o retorno do evento pelo webhook para a conta (tenant) que o documento foi criado.
Para ter acesso ao tenant da conta, os produtos internos da Aliare deverá utilizar a plataforma da Aliare (https://app.prd.aliare.digital/login) ou para clientes da plataforma Assinei (https://app.assinei.digital/), acessar o menu “Detalhes da Conta” com o usuário administrador da conta secundária, conforme apresentam as imagens abaixo:
Os eventos que a plataforma Assinei envia através do webhook são:
- document_created: Envia um evento sempre que um documento é criado com o status “Aguardando assinatura”;
- document_signed: Envia um evento sempre que um documento é assinado por um participante, sendo que se o documento contiver mais de um participante, irá enviar o evento para cada participante e alterar o status de “Aguardando assinatura” para “Aprovado” para aquele participante, mas o documento ainda continuará com o status “Aguardando assinatura”;
- document_finished_signing: Este evento é enviado quando todos os participantes assinaram o documento e o mesmo ficará com o status “Assinado ;
- document_canceled: Quando um documento é cancelado, assim que finaliza o processo é enviado esse evento para notificar que o mesmo foi cancelado;
- document_terminated: Esse evento notifica quando a vigência do documento finalizou;
Para a criação do webhook deverá enviar também as informações do Request headers que são Authorization (para ter acesso ao Access Token é somente realizar a autenticação através da Aliare Identify API) e o X-Tenant (enviar o tentant da conta do usuário que está criando o webhook);
Para cadastrar o webhook é necessário informar os campos:
