Documentação API
Sumário
Endpoints
Upload de documento
Descrição:
Este método permite realizar o upload de um documento (arquivo) para assinatura, juntamente com as partes envolvidas.
** Obrigatório enviar o parâmetro URL_ARQUIVO ou ARQUIVO conforme descritos abaixo na tabela de parâmetros de entrada.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_identifier | UUID | Identificador do documento, gerado por get_identifier_to_upload | |
| lista_partes | Array<ParteEnvio> |
Lista das partes envolvidas na assinatura separados por vírgula, vide estrutura |
|
| url_arquivo | String | URL com documento PDF | |
| arquivo | Base64 | Arquivo encodado em base64 | |
| identificacao_arquivo | String | Nome do arquivo, sem espaços ou caracteres especiais | |
| sufixo_arquivo | String | Extensão do arquivo | |
| quadro_assinaturas | int | Indica se terá um quadro de assinatura no comprovante da Assine Bem | |
| id_centro_custo | int | ID único de centro de custo que deve ser vinculado ao documento |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Upload de modelo
Descrição:
Este método permite solicitar assinatura de modelo, juntamente com as partes envolvidas.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | int | ID único do modelo na plataforma, utilizado para consultas. | |
| lista_partes | Array<ModeloParteEnvio> |
Lista das partes envolvidas na assinatura separados por vírgula, vide estrutura |
|
| lista_campos | Array<ModeloCampoEnvio> | Lista com campos do modelo que devem ser preenchidos separados por vírgula, vide formato abaixo. Se modelo não tiver campos configurados para preenchimento, não é preciso enviar esse parâmetro. | |
| identificacao_arquivo | String | Nome do arquivo, sem espaços ou caracteres especiais. | |
| quadro_assinaturas | String | Indica se terá um quadro de assinatura no comprovante da Assine Bem. | |
| id_centro_custo | int | ID único de centro de custo que deve ser vinculado ao documento. |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Consulta de documento
Descrição:
Este método busca os dados do documento e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Inserir parte em documento
Descrição:
Este método permite adicionar uma nova parte em um documento existente.
** Obrigatório enviar o parâmetro URL_ARQUIVO ou ARQUIVO conforme descritos abaixo na tabela de parâmetros de entrada.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas e alterações | |
| parte | Array<ParteEnvio> | Dados da parte que deseja inserir. |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Atualizar parte no documento
Descrição:
Este método permite atualizar o registro da Parte no Documento.
URL:
PUT
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_documento | String | ID único do Documento na plataforma, utilizado para consultas e alterações | |
| id_externo_parte | String | ID único da Parte na plataforma, utilizado para consultas e alterações | |
| identificacao_parte | String |
Identificar a função da parte no documento. Ex.: Locador, Locatário, Estagiário, Empresa concedente, etc. |
|
| id_validacao_bloco | Int | Vide tabela validacoes_blocos. | |
| ordem_assinatura | Int | Indica ordem de assinaturas, assina do menor para o maior, o padrão é sempre 0, ou seja, assina primeiro. | |
| pode_delegar | Int |
Indica se Parte pode delegar sua assinatura para outra Parte fora do processo quando for assinar. O Padrão é 0, ou seja, não pode. |
|
| pode_substituir | Int |
Indica se Parte pode ser substituida pelo solicitante por outra Parte fora do processo. O Padrão é 0, ou seja, não pode. |
|
| acoes | Array<String> |
Indica ações da Parte no Documento. Vide tabela parte_acoes. O padrão do sistema é configurar para Visualizar e Assinar. |
|
| notificacoes | Array<String> |
Indica como a Assine Bem notificará a Parte no Documento. Vide tabela parte_notificacoes. |
|
| redirecionamentos | Array<ParteRedirecionamento> |
Estrutura ParteRedirecionamento para configurar redirecionamentos da parte durante processo de assinatura digital. Essa estrutura depende de um produto extra que necessita liberação da equipe da Assine Bem para utilização. |
|
| idioma | String | String do idioma do acesso da Parte. Parâmetro opcional, o padrão é sempre Português do Brasil. Vide tabela idiomas. |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "alteracoes": "Array<String>, com lista de par\u00e2metros que foram atualizados na requisi\u00e7\u00e3o.", "parte": {"id_externo_slot": null, "identificacao_parte": null, "id_validacao_bloco": null, "ordem_assinatura": 0, "pode_delegar": 0, "pode_substituir": 0, "acoes": [], "notificacoes": [], "id_externo": null, "dt_criacao": null, "id_status_pessoa_parte": null, "descricao_parte_status": null, "dt_ult_notificado": null, "pessoa": {"nome": null, "nome_social": null, "rg": null, "cpf": null, "id_tipo_documento": null, "id_referencia": null, "id_tipo_usuario_referencia": null, "id_lingua": null, "emails": {"email": null, "id_pessoa_status_email": null, "data_criacao": null, "data_atualizacao_status": null, "descricao_status_email": null}, "telefones": {"ddi": 55, "ddd": null, "telefone": null, "id_pessoa_tipo_telefone": null, "id_pessoa_status_telefone": null, "dt_criacao": null, "dt_atualizacao_status": null, "descricao_status_telefone": null, "descricao_tipo_telefone": null}, "lista_emails": [{"email": null, "id_pessoa_status_email": null, "data_criacao": null, "data_atualizacao_status": null, "descricao_status_email": null}], "lista_telefones": [{"ddi": 55, "ddd": null, "telefone": null, "id_pessoa_tipo_telefone": null, "id_pessoa_status_telefone": null, "dt_criacao": null, "dt_atualizacao_status": null, "descricao_status_telefone": null, "descricao_tipo_telefone": null}]}, "validacoes": [], "parte_url": {"url": null, "token": null, "dt_expiracao_token": "", "assinatura": 0, "validacao": 0}, "validado": 0, "em_analise": 0, "anexos": [{"id_api": null, "identificacao": null, "label": null, "obrigatorio": 0, "posicao": null, "limite_arquivos": null, "id_referencia": null}], "posicionamentos": []}}
Download de documento
Descrição:
Este método retorna o binario do documento e informações do arquivo.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações | |
| assinado | String (valor:1) | Se parâmetro enviado, a API retornará a última versão do arquivo disponível com as assinaturas das partes e o comprovante da Assine Bem. Senão será retornado o arquivo original enviado para assinatura. |
Retorno:
JSON:
{"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}
Download do documento binário
Descrição:
Este método retorna o binário do documento.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}
Invalidar documento
Descrição:
Este método invalida o documento na plataforma e não permite futuras assinaturas.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status_api":999,"mensagem":"descrição da resposta"}
Consulta de parte
Descrição:
Este método busca os dados da parte e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descri\u00e7\u00e3o da resposta", "parte": {"id_referencia": "", "id_externo": "ID", "id_status_pessoa_parte": "", "descricao_parte_status": "", "identificacao_parte": "", "dt_ult_notificado": "DD/MM/YYYY HH:MI:SS", "dt_criacao": "DD/MM/YYYY HH:MI:SS", "pessoa": {"nome": "null", "rg": "null", "cpf": "null", "id_tipo_documento": "null", "descricao_documento": "null", "documento": "null", "pessoa_preenche_dados": "null", "lista_emails": "Array <PessoaEmail></PessoaEmail>", "lista_telefones": "Array <PessoaTelefone></PessoaTelefone>"}, "parte_url": "<ParteUrlRetorno></ParteUrlRetorno> //(Opcional)"}}
Inserir parte
Descrição:
Este método permite adicionar uma nova parte sem vinculo com um documento.
** Obrigatório enviar o parâmetro NOME conforme descritos abaixo na tabela de parâmetros de entrada.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| nome | String | Representando NOME da parte. Parâmetro obrigatório. | |
| nome_social | String | Representando NOME SOCIAL da parte. | |
| id_tipo_documento | int | Inteiro para identificar que deseja identificar a parte por outro processo que não seja o CPF, para isso, o valor desse parâmetro deve ser 2. | |
| rg | String | Representando RG da parte. Se não for passado, não será atualizado. | |
| cpf | String | Representando CPF (sem pontuação) da parte. Se não for passado, não será atualizado. | |
| String | Representando o e-mail da parte. Se não for passado, não será atualizado. | ||
| id_tipo_telefone | int | Int representando o tipo de telefone. | |
| ddi | int | Int representando os dígitos do DDI. Se não for passado, não será atualizado. | |
| ddd | int | Int representando os dígitos do DDD. Se não for passado, não será atualizado. | |
| telefone | int | Int representando o número de celular da parte. (8 ou 9 dígitos) Se não for passado, não será atualizado. | |
| descricao_documento | String | String com a descrição para a parte sobre qual documento está sendo utilizado para identificação. Exemplo: Passaporte, código interno e etc... Só é obrigatório caso o id_tipo_documento seja 2. | |
| documento | String | String com o valor do documento para cada parte. Exemplo: número do passaporte da pessoa ou código interno pré-combinado com a parte. | |
| id_referencia | String | Identificação da parte no sistema de origem dos dados. | |
| pessoa_preenche_dados | int | Define que a parte deve preencher os dados pela Assine Bem antes de realizar Assinatura, portanto não é necessário enviar os dados obrigatórios como CPF, RG. Para utilizar esta opção, o valor deste parâmetro deve ser 1 e o produto estar configurado e disponível para a sua conta. |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Consulta status da parte
Descrição:
Este método busca o status da parte e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descri\u00e7\u00e3o da resposta", "id_externo": "ID", "id_status": "ID", "descricao": "descri\u00e7\u00e3o do status em texto"}
Atualiza dados da parte
Descrição:
Este método atualiza os dados básicos da parte dependendo das restrições.
** Somente será permitido atualizar se status da parte for 'Não validado' ou 'Dados inválidos'.
** Somente será atualizado se os valores passados forem diferentes dos atuais.
** O ddi/ddd/telefone só será atualizado se passar os dois valores em conjunto.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas e alterações | |
| rg | String | Representando RG da parte. Se não for passado, não será atualizado. | |
| cpf | String | Representando CPF (sem pontuação) da parte. Se não for passado, não será atualizado. | |
| ddi | int | Int representando os dígitos do DDI. Se não for passado, não será atualizado. | |
| ddd | int | Int representando os dígitos do DDD. Se não for passado, não será atualizado. | |
| telefone | int | Int representando o número de celular da parte. (8 ou 9 dígitos) Se não for passado, não será atualizado. | |
| id_tipo_telefone | int | Int representando o tipo de telefone. |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}}
Notificar parte com novo acesso
Descrição:
Esse método notifica a parte via E-mail e SMS com novo acesso para assinar documentos pendentes.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único da parte na plataforma, utilizado para consultas e alterações | |
| lista_documentos | Array<String> |
Lista de IDs do documento na plataforma, utilizado para consultas e alterações. A API considerará somente estes documentos ao decidir se deve notificar ou não, além de que a comunicação será baseada nestes documentos. |
Retorno:
JSON:
{"sucesso": 1}
Descrição Retorno:
| ID | Descrição |
|---|---|
| 1 | Se parte foi notificada com sucesso. |
| 0 | Se parte não foi notificada. |
Consulta status da assinatura da parte em um documento
Descrição:
Este método busca o status da parte e retorna em forma de JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas e alterações | |
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"id_externo_parte": "ID", "id_externo_documento": "ID", "identificador_assinatura": ""}
Descrição Retorno:
| ID | Descrição |
|---|---|
| identificador_assinatura | UUID único da assinatura, se vier preenchido significa que a parte assinou. |
Consulta de assinaturas pendentes
Descrição:
Este método busca todas as partes com assinatura pendente de documentos ainda não assinados.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| offset | int | Offset da busca de assinaturas pendentes, pois é retornado 50 registros por vez. |
Retorno:
JSON:
{"offset_ini": "\u00cdndice inicial do offset", "offset_fim": "\u00cdndice final do offset", "total": "Total de assinaturas pendentes.", "total_retornado": "Total de registros retornados", "assinaturas_pendentes": [{"id_externo_parte": "ID \u00fanico", "id_externo_documento": "ID \u00fanico", "documento": {"id_documento_status": "null", "descricao_documento_status": "null", "identificacao_arquivo": "null", "dt_criacao": "null", "id_externo": "null", "identificador_documento": "null", "hash_arquivo": "null", "quadro_assinaturas": "null", "quantidade_paginas": "null", "dt_limite_assinatura": "null", "lista_partes": "Array<ParteRetorno></ParteRetorno>"}, "parte": {"id_referencia": "", "id_externo": "ID", "id_status_pessoa_parte": "", "descricao_parte_status": "", "identificacao_parte": "", "dt_ult_notificado": "DD/MM/YYYY HH:MI:SS", "dt_criacao": "DD/MM/YYYY HH:MI:SS", "pessoa": {"nome": "null", "rg": "null", "cpf": "null", "id_tipo_documento": "null", "descricao_documento": "null", "documento": "null", "pessoa_preenche_dados": "null", "lista_emails": "Array <PessoaEmail></PessoaEmail>", "lista_telefones": "Array <PessoaTelefone></PessoaTelefone>"}, "parte_url": "<ParteUrlRetorno></ParteUrlRetorno> //(Opcional)"}}]}
Consulta modelos configurados para o cliente
Descrição:
Este método busca todos os modelos configurados para cliente e retorna lista em JSON.
URL:
GET
Parâmetros de entrada:
Nenhum parâmetro é preciso, o sistema faz a autenticação pelo seu Token enviado pelo HEADER e retorna lista de modelos configurados para sua conta.
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "modelos": [{"dt_alteracao": "DD/MM/AAAA HH:MI:SS", "nome": "STRING", "id_externo": "ID_INTEIRO", "dt_criacao": "DD/MM/AAAA HH:MI:SS"}]}
Consulta dados de um modelo
Descrição:
Este método busca os dados do modelo e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | int | ID único do modelo na plataforma, utilizado para consultas. |
Retorno:
JSON:
{"id_externo": null, "nome": null, "dt_criacao": null, "dt_alteracao": null, "partes": [{"id_modelo_parte": null, "identificacao_api": null, "identificacao_parte": null, "campos": [{"identificacao_api": null, "multipla_opcao": null, "id_campo": null, "nome_campo": null, "label_campo": null, "preenchimento_obrigatorio": null, "id_tipo_campo": null, "descricao_tipo_campo": null, "opcoes": [{"identificacao_api": null, "id_opcao": null, "opcao": null}]}]}], "campos_avulsos": [{"identificacao_api": null, "id_campo": null, "nome_campo": null, "label_campo": null, "preenchimento_obrigatorio": null, "id_tipo_campo": null, "descricao_tipo_campo": null, "opcoes": [{"identificacao_api": null, "id_opcao": null, "opcao": null}]}]}
Consulta anexos de um documento
Descrição:
Este método busca os anexos configurados para os assinantes do documento.
É possível buscar os anexos configurados para o documento ou somente de uma parte no documento ao passar o parâmetro não obrigatório "id_externo_parte".
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. |
Retorno:
JSON:
{"status_api": 999, "mensagem": "descricao da resposta", "documento": {"id_externo": "None", "identificador_documento": "None", "identificacao_arquivo": "None"}, "anexos": "<AnexoRetorno>"}
Download do anexo binário
Descrição:
Este método retorna o binário do arquivo anexo.
Binário do arquivo com RESPONSE type: "application/png | jpg | jpeg | pdf".
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_download | Int | ID único do para fazer download do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >) |
Retorno:
JSON:
{"arquivo": "hash do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo", "mensagem": "descri\u00e7\u00e3o da resposta"}
Aprovar anexo
Descrição:
Este método aprova o anexo enviado pelo assinante que muda o status de pendente para aprovado.
Com isso, o anexo fica disponível para download e é anexado a versão final do arquivo assinado.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. | |
| id_download | Int | ID único do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >) |
Retorno:
JSON:
{"status_api": 200, "mensagem": "descricao da resposta"}
Invalidar anexo
Descrição:
Este método invalida o anexo enviado pelo assinante que muda o status de pendente para inválido.
Com isso, se o parâmetro "reenviar" for passado, a plataforma enviará uma notificação para assinante refazer o envio do anexo invalidado.
Se anexo reenviado para o assinante, o parâmetro de retorno "reenviado" é igual a 1 senão é 0.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. | |
| id_download | Int | ID único do anexo, retornado ao consultar os anexos no documento vide (< AnexoRetorno >) | |
| reenviar | Int | Inteiro para definir se o assinante deverá ou não reenviar o anexo invalidado. Valores: 1 (para reenviar) ou 2 (para não reenviar). |
Retorno:
JSON:
{"status_api": 200, "mensagem": "descricao da resposta", "reenviado": "INTEIRO"}
Consulta centro de custos
Descrição:
Busca centros de custo configurados da empresa.
URL:
GET
Parâmetros de entrada:
Nenhum parâmetro é preciso, o sistema faz a autenticação pelo seu Token enviado pelo HEADER.
Retorno:
JSON:
{"status_api": 200, "mensagem": "descricao da resposta", "centros_custo": [{"id_centro_custo": "INTEIRO", "descricao": "STRING"}]}
Consulta URL do assinante
Descrição:
Busca URL do assinante para assinatura ou validação dependendo do Assinante X Documento.
** Podem ser retornadas duas URLs, uma para assinatura ou para validação.
** Para assinatura, é retornada somente se o assinante tiver com assinatura pendente do documento passado como parâmetro ou algum outro. Ou se o status do assinante for "válido".
** Para validação, é retornada se não tiver documento pendente ou estiver com status diferente de "válido".
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. |
Retorno:
JSON:
{"status_api": 200, "mensagem": "descricao da resposta", "url": "STRING (URL ABSOLUTA)", "assinatura": "INTEIRO", "validacao": "INTEIRO", "token": "STRING (UUID)", "dt_expiracao_token": "STRING (dd/mm/yyyy hh:mi:ss)", "id_externo_documento": "ID \u00fanico", "id_externo_parte": "ID \u00fanico"}
Consulta dados preenchidos pelos assinantes de modelo
Descrição:
Busca dados preenchidos pelos assinantes de um modelo.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. | |
| flag_tipo_retorno | Int |
Retorno 1 - id_externo_parte como key e lista dos dados preenchidos Retorno 2 - id_externo_parte como key listando todas dados preenchidos com o nome_campo como key. |
Retorno:
Retorno flag 1
{"status_api": 200, "mensagem": "descricao da resposta", "dados": {"ID_EXTERNO_PARTE_1": {"ID_CAMPO": {"id_tipo_campo": "INT", "tipo": "INT Vide tabela modelo_tipos_campos", "valor_campo": "String", "multipla_opcao": "INT", "preenchimento_obrigatorio": "INT"}}}}
Retorno flag 2
{"status_api": 200, "mensagem": "descricao da resposta", "dados": {"ID_EXTERNO_PARTE_1": {"NOME_CAMPO_1": {"id_campo": "INT", "id_tipo_campo": "INT", "tipo": "INT Vide tabela modelo_tipos_campos", "valor_campo": "String", "multipla_opcao": "INT", "preenchimento_obrigatorio": "INT"}}}}
Buscar campos de assinante que assinam automaticamente
Descrição:
Faz assinatura automática da parte no documento conforme configuração prévia já homologada e aprovada pela equipe da Assine Bem.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. | |
| flag_tipo_retorno | Int |
Retorno 1 - id_campo como identificador do campo no JSON. Retorno 2 - nome_campo como identificador do campo no JSON. Retorno 3 - identificacao_api como identificador do campo no JSON. |
Retorno:
Retorno 1
{"campos": {"$ID_CAMPO": {"id_campo": "INT", "identificacao_api": "String", "id_tipo_campo": "INT", "nome_campo": "String", "tipo": "String", "mascara": "String", "preenchimento_obrigatorio": 1, "multipla_opcao": 1, "opcoes": {"identificacao_api": "String", "id_opcao": "INT", "opcao": "String"}}}}
Retorno 2
{"campos": {"$NOME_CAMPO": {"id_campo": "INT", "identificacao_api": "String", "id_tipo_campo": "INT", "nome_campo": "String", "tipo": "String", "mascara": "String", "preenchimento_obrigatorio": 1, "multipla_opcao": 1, "opcoes": {"identificacao_api": "String", "id_opcao": "INT", "opcao": "String"}}}}
Retorno 3
{"campos": {"$IDENTIFICACAO_API": {"id_campo": "INT", "identificacao_api": "String", "id_tipo_campo": "INT", "nome_campo": "String", "tipo": "String", "mascara": "String", "preenchimento_obrigatorio": 1, "multipla_opcao": 1, "opcoes": {"identificacao_api": "String", "id_opcao": "INT", "opcao": "String"}}}}
Assina documento automaticamente.
Descrição:
Faz assinatura automática da parte no documento conforme configuração prévia já homologada e aprovada pela equipe da Assine Bem.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas. | |
| id_externo_parte | String | ID único da parte na plataforma, utilizado para consultas. | |
| lista_campos | Array<ModeloCampoEnvio> | Lista com campos do modelo que devem ser preenchidos separados por vírgula, vide formato abaixo. Se modelo não tiver campos configurados para preenchimento, não é preciso enviar esse parâmetro. |
Retorno:
Retorno
{"status_api": 200, "mensagem": "descricao da resposta", "identificador_assinatura": "uuid"}