Documentação API - Pastas Digitais
Sumário
Endpoints
Obter Pasta
Descrição:
Este método busca os dados da Pasta e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "pasta": {"nome_pasta": null, "descricao_pasta": null, "id_pasta_status": null, "descricao_pasta_status": null, "descricao_fluxo_status": null, "dt_criacao": null, "dt_alteracao": "", "dt_disparo": "", "id_externo": null, "lista_documentos": [{"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}]}}
Criar Pasta
Descrição:
Este método permite criar uma nova Pasta com Documentos.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| nome_pasta | String | Identificação da Pasta no sistema e nome que aparecerá para os assinantes. | |
| descricao_pasta | String | Descrição opcional da Pasta que aparecerá para os assinantes e no E-mail de notificação. | |
| documentos | Array<PastaDocumentoEnvio> | Array com os Documentos da Pasta. | |
| disparo_automatico | Int | Flag caso a Pasta esteja com no mínimo um documento configurado corretamente já seja disparada após cadastro. |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "pasta": {"nome_pasta": null, "descricao_pasta": null, "id_pasta_status": null, "descricao_pasta_status": null, "descricao_fluxo_status": null, "dt_criacao": null, "dt_alteracao": "", "dt_disparo": "", "id_externo": null, "lista_documentos": [{"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}]}}
Atualizar Pasta
Descrição:
Este método permite atualizar uma Pasta.
URL:
PUT
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações | |
| nome_pasta | String | Identificação da Pasta no sistema e nome que aparecerá para os assinantes. | |
| descricao_pasta | String | Descrição opcional da Pasta que aparecerá para os assinantes e no E-mail de notificação. |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "pasta": {"nome_pasta": null, "descricao_pasta": null, "id_pasta_status": null, "descricao_pasta_status": null, "descricao_fluxo_status": null, "dt_criacao": null, "dt_alteracao": "", "dt_disparo": "", "id_externo": null, "lista_documentos": [{"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}]}}
Disparar Pasta
Descrição:
Este método dispara para assinatura os documentos que estão aguardando liberação da Pasta Digital.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações |
Retorno:
Obter Status da Pasta
Descrição:
Este método retorna o Status da pasta Digital.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "id_status": "null", "descricao_status": "null"}
Cancelar Pasta
Descrição:
Este método tentar Cancelar o disparo de uma Pasta Digital.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta"}
Obter Documento da Pasta
Descrição:
Este método busca os dados do Documento da Pasta e retorna no formato JSON.
URL:
GET
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta 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:
{"status": 999, "mensagem": "descricao da resposta", "id_externo_pasta": null, "id_externo_documento": null, "documento": {"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}}
Criar Documento na Pasta
Descrição:
Este método permite criar um novo Documento na Pasta.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| ordem | Int |
Ordem do documento na Pasta. Um documento com ordem só é liberado para assinatura após assinatura de todos os anteriores. Por padrão a ordem é sempre 1, ou seja, não precisa aguardar nenhum anterior. |
|
| identificacao_arquivo | String | Nome do arquivo, sem espaços ou caracteres especiais | |
| url_arquivo | String | URL com documento PDF | |
| arquivo | Base64 | Arquivo encodado em base64 | |
| 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 | |
| lista_partes | Array<ParteEnvio> |
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. |
Retorno:
JSON:
{"status": 999, "mensagem": "descricao da resposta", "pasta": {"nome_pasta": null, "descricao_pasta": null, "id_pasta_status": null, "descricao_pasta_status": null, "descricao_fluxo_status": null, "dt_criacao": null, "dt_alteracao": "", "dt_disparo": "", "id_externo": null, "lista_documentos": [{"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}]}, "documento": {"ordem": 1, "identificacao_arquivo": "", "url_arquivo": "", "arquivo": "", "quadro_assinaturas": 1, "id_centro_custo": "", "lista_partes": "Array<ParteEnvio>", "lista_campos": "Array<ModeloCampoEnvio>"}}
Atualizar Documento da Pasta
Descrição:
Este método permite atualizar um Documento da Pasta.
URL:
PUT
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta na plataforma, utilizado para consultas e alterações | |
| id_externo_documento | String | ID único do documento na plataforma, utilizado para consultas e alterações | |
| identificacao_arquivo | String | Nome do arquivo, sem espaços ou caracteres especiais | |
| ordem | Int |
Ordem do documento na Pasta. Um documento com ordem só é liberado para assinatura após assinatura de todos os anteriores. Por padrão a ordem é sempre 1, ou seja, não precisa aguardar nenhum anterior. |
|
| 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": 999, "mensagem": "descricao da resposta", "pasta": {"nome_pasta": null, "descricao_pasta": null, "id_pasta_status": null, "descricao_pasta_status": null, "descricao_fluxo_status": null, "dt_criacao": null, "dt_alteracao": "", "dt_disparo": "", "id_externo": null, "lista_documentos": [{"ordem_documento": 1, "id_contato_ins": null, "id_contato_alt": null, "id_documento_status": null, "descricao_documento_status": null, "identificacao_arquivo": null, "dt_criacao": null, "id_externo": null, "identificador_documento": null, "quadro_assinaturas": 0, "hash_arquivo": null, "json_configuracao_ia": null, "id_documento_orientacao_marca_dagua": null, "lista_partes": [{"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}], "id_documento_pasta_status": null, "descricao_documento_pasta_status": null}]}}
Download Documento da Pasta
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_pasta | String | ID único da Pasta 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:
{"status": 999, "mensagem": "descricao da resposta", "arquivo": "binario do arquivo", "file_length": "tamanho do arquivo", "file_name": "nome do arquivo", "file_type": "tipo do arquivo", "identificacao_arquivo": "identifica\u00e7\u00e3o do arquivo"}
Notificar Documento da Pasta
Descrição:
Este método notifica todos os assinantes pendente assinatura do Documento.<br/>As notificações são enviadas conforme configuração determinada para assinante na criação do registro do Documento.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta 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:
{"status": 999, "mensagem": "descricao da resposta"}
Cancelar Documento da Pasta
Descrição:
Este método permite Cancelar o disparo de um Documento da Pasta que ainda não foi assinado por completo.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta 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:
{"status": 999, "mensagem": "descricao da resposta"}
Excluir Documento da Pasta
Descrição:
Este método permite Excluir o registro de um Documento da Pasta que ainda não foi liberado para assinatura.
URL:
POST
Parâmetros de entrada:
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_externo_pasta | String | ID único da Pasta 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:
{"status": 999, "mensagem": "descricao da resposta"}