01. DADOS GERAIS

Produto:

Linha de Produto:

Segmento:

Módulo:

Função:

html.mcd.govApiParams

País:Brasil
Requisito/Story/Issue (informe o requisito relacionado) :

DBACKRTDTS-6588


02. SITUAÇÃO/REQUISITO

Disponibilizada API de integração do projeto Conformidade Fácil. O objetivo deste serviço é expor interfaces gratuitas para que os sistemas possam estar atualizados com as tabelas e definições das principais codificações e indicadores que associam legislação do IBS e CBS com as regras de validação aplicadas nos ambientes de autorização dos DFe.

03. SOLUÇÃO

Desenvolvido o programa (html.mcd.govApiParams) - Parâmetros para Consumo das APIs do Governo, que permite parametrizar os certificados digitais que serão utilizados para o consumo das APIs do governo.


Foram criadas novas tabelas para suprir as necessidades de armazenar os parâmetros e controlar as requisições realizadas.

DatabaseTable NameLabelDescription
mgindparametros-api-govParâmetros API GovParâmetros para uso das APIs do governo.
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatory
empresaCharacterx(3)Código EmpresaCódigo EmpresaCódigo da empresa que os registros da tabela terão como chaveYES
tipo-certificadoInteger>>9Tipo CertificadoTipo CertificadoTipo do certificado que será utilizado. Pode ser .pfx ou .pem.NO
caminho-arquivo-certificadoCharacterx(500)Arquivo CertificadoArquivo CertificadoCaminho de onde está salvo o arquivo do certificadoNO
caminho-curl-exeCharacterx(500)Caminho cUrlCaminho cUrlCaminho do arquivo executável curl.exe com versão OpenSSLNO
chave-certificadoCharacterx(500)Chave CertificadoChave CertificadoChave do certificado digitalNO
senha-certificadoCharacterx(500)Senha CertificadoSenha CertificadoSenha do arquivo do certificado para consumo das APIs.NO
cod-servidor-rpwCharacterx(100)Servidor RPWServidor RPWIdentificação do Servidor RPW.NO
Índice primárioCampo
idx-empresaempresa
DatabaseTable NameLabelDescription
mgindrequisicao-api-govRequisição API GovControle de requisições das APIs do governo.
Field NameData TypeFormatLabelColumn LabelDescripton/Help TextMandatory
tipo-servicoCharacterx(100)Tipo do ServiçoTipo do ServiçoIdentificador do tipo da API que foi executada (Ex: credPres)YES
data-execDate99/99/9999Data de ExecuçãoData de ExecuçãoData da consulta da APINO
hora-execCharacter99:99:99Hora de ExecuçãoHora de ExecuçãoHorário da consulta da API.NO
codigo-statusInteger>>9Codigo StatusCodigo StatusO retorno HTTP (200, 429, 500).NO
sucessoLogicalYES/NOSucessoSucessoFlag rápida para filtrar se a requisição foi feita com sucessoNO
mensagem-erroCharacterx(500)Mensagem de ErroMensagem de ErroDescrição amigável caso a requisição tenha falhado.NO
Índice primárioCampo
idx-tp-servico

tipo-servico

Foi desenvolvido o programa Parâmetros para Consumo das APIs do Governo que permite parametrizar os parâmetros que serão utilizados para o consumo das APIs governamentais.

(html.mcd.govApiParams) - Parâmetros para Consumo das APIs do Governo:

A empresa é um campo não editável, que traz automaticamente o valor da empresa logada no sistema.

Os campos apresentam em suas descrições internas os formatos de extensão que devem ser preenchidos ao final de cada informação (Ex: chavecertificado.pem). Caso não sejam fornecidas essas extensões, o programa irá preenchê-las automaticamente. 

Detalhamento dos campos

Tipo Certificado: Este campo indica qual o tipo de certificado digital será utilizado. Se é PEM, um formato que utiliza de um arquivo chave para o certificado ou se é PFX, um outro formato de certificado digital que funciona com uma senha.

Caminho cURL: Este campo é o caminho completo até o arquivo executável do cURL, componente que realiza as requisições para as APIs do portal da Conformidade Fácil. Esse campo deve ser obrigatoriamente preenchido quando o sistema operacional do servidor RPW for Windows. O motivo é que o cURL padrão do Windows não possui suporte ao uso de SSL nas requisições, o que é necessário para trabalhar com certificados digitais. O arquivo executável do cURL deve poder ser acessado a partir do servidor RPW de escolha para execução do programa.

Para verificar se o seu cURL possui suporte ao SSL, basta digitar o seguinte comando na linha de comando: curl --version. O resultado deve ser semelhante a imagem abaixo:

Para realizar a instalação de uma versão do cURL que possua suporte a SSL acesse: https://curl.se/windows/.

O campo deve conter o caminho completo até a instalação do cURL. Exemplo: C:\ProgramData\chocolatey\bin\curl.exe.

Para descobrir o caminho de instalação do seu cURL no Windows, basta digitar o seguinte comando na linha de comando: where curl. O resultado deve ser semelhante a imagem abaixo:

Caminho Arquivo Certificado: Este campo deve conter o caminho completo até o arquivo do certificado digital que será utilizado, independente do seu tipo. Esse arquivo deve estar em um diretório que possa ser acessado a partir do servidor RPW. Exemplo: C:\Users\testes\certificado_digital.pfx ou C:\Users\testes\certificado_digital.pem.

Chave Certificado: Este campo deve conter o caminho completo até o arquivo de chave do seu certificado digital do tipo .pem. Caso seu tipo de certificado seja .pfx, o preenchimento desse campo não é necessário. Esse arquivo deve estar em um diretório que possa ser acessado a partir do servidor RPW. Exemplo: C:\Users\testes\certificado_digital.key.

Senha Certificado: Este campo deve conter a senha do seu certificado digital do tipo .pfx. Caso seu tipo de certificado seja .pem, o preenchimento desse campo não é necessário. Esse arquivo deve estar em um diretório que possa ser acessado a partir do servidor RPW.


Para realizar as requisições e receber o retorno correto da API do portal da Conformidade Fácil, é necessário que os certificados digitais inseridos nesta tela de parâmetros estejam válidos.

Para maiores informações sobre o funcionamento da API, veja o documento de referência do programa: consumoApiGov - Consumo das APIs do portal da Conformidade Fácil



O programa apresentará mensagens de erro ao tentar salvar a parametrização quando houver campos obrigatórios vazios.



04. ASSUNTOS RELACIONADOS