Documentação API

Mudanças desde a versão 1.7.3

• Correção de typo na URL de documentos, de "documentos" para "documento"
• Correção em como formatar o envio de requests GET para a API.
• Inclusão de método para download do binário do arquivo via API.
• Método de download do arquivo binário aceita parâmetro extra chamado assinado.
• Inclusão de novo Endpoint "Modelo" para consulta e upload de documentos a partir de um modelo.
• Novo método no Endpoint "Parte" para atualizar os dados da parte.
• Parâmetro extra "ordem_assinatura" na estrutura de dados "< ParteEnvio >".
• Parâmetro "url_arquivo" no método 2) Upload de documento.
• Novo método para notificar parte "novo_acesso" no endpoint "parte".
• Novo método para buscar assinaturas pendentes no endpoint "assinaturas".
• Alteração no < ParteRetorno > para retornar atributo dt_ult_notificado.
• Nova tabela com status dos documentos.
• Novo método "download_arquivo" que retorna o binário da última versão do documento assinado.
• Alteração na estrutura < ParteEnvio > e < ParteRetorno > para aceitar identificação da parte por outros tipos de documento ao invés de somente do CPF.
• Novo Endpoint "Anexos" para consulta de anexos no documento e download do arquivo.
• Funções de "aprovar" e "invalidar" no Endpoint de "Anexos".
• Alterado estrutura < ParteEnvio > para aceitar novos parâmetros "validar_campos" e "validar_anexos" em upload de modelos.
• Alterado Endpoint "2-) Upload de documento" para aceitar id_centro_custo ao fazer upload de documento.
• Alterado Endpoint "15-) Upload de modelo" para aceitar id_centro_custo ao fazer upload de documento.
• Novo Endpoint "20-) Busca centro de custos" para buscar os centros de custo da empresa.
• Alterado nome do header de envio do TOKEN para HTTP-SECURITY-HASH. Antigo: HTTP_SECURITY_HASH.
• Alterado < ParteEnvio > para aceitar novo parâmetro (preenche_dados) onde a parte deve preencher dados antes de realizar Assinatura.


• Alterado < ParteEnvio > para aceitar novo parâmetro (notificar) onde pode enviar com valor 0 para não notificar a parte.
• Novo Endpoint "21-) Busca URL do assinante" para buscar URL do assinante.
• Nova estrutura < ParteUrl > que retorna a URL para acesso ao sistema do assinante.
• Alterado estrutura < ParteRetorno > para que incorpore o < ParteUrl >.


• Adicionado método "2.1" para inserir nova parte em um documento existente.


• Nova estrutura < ParteRedirecionamento > para enviar configuração de redirecionamento da parte no processo de assinatura.