01. DADOS GERAIS
| Produto: | TOTVS Backoffice |
|---|---|
| Linha de Produto: | Linha Datasul |
| Segmento: | Backoffice |
| Módulo: | TOTVS Backoffice (Linha Datasul) - Obrigações Fiscais (MOF) |
| Função: | html.mcd.govApiParams / html.mcd.credPres |
| País: | Brasil |
| Requisito/Story/Issue (informe o requisito relacionado) : | DBACKRTDTS-6588, DBACKRTDTS-6612, DBACKRTDTS-6613 |
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. Os parâmetros cadastrados poderão ser usados para consumir as APIs do Governo, conforme será demonstrado para o programa (html.mcd.credPres) - Cadastro de Crédito Presumido.
Foram criadas novas tabelas para suprir as necessidades de armazenar os parâmetros e controlar as requisições realizadas.
| Database | Table Name | Label | Description |
| mgind | parametros-api-gov | Parâmetros API Gov | Parâmetros para uso das APIs do governo. |
| Field Name | Data Type | Format | Label | Column Label | Descripton/Help Text | Mandatory |
| empresa | Character | x(3) | Código Empresa | Código Empresa | Código da empresa que os registros da tabela terão como chave | YES |
| tipo-certificado | Integer | >>9 | Tipo Certificado | Tipo Certificado | Tipo do certificado que será utilizado. Pode ser .pfx ou .pem. | NO |
| caminho-arquivo-certificado | Character | x(500) | Arquivo Certificado | Arquivo Certificado | Caminho de onde está salvo o arquivo do certificado | NO |
| caminho-curl-exe | Character | x(500) | Caminho cUrl | Caminho cUrl | Caminho do arquivo executável curl.exe com versão OpenSSL | NO |
| chave-certificado | Character | x(500) | Chave Certificado | Chave Certificado | Chave do certificado digital | NO |
| senha-certificado | Character | x(500) | Senha Certificado | Senha Certificado | Senha do arquivo do certificado para consumo das APIs. | NO |
| cod-servidor-rpw | Character | x(100) | Servidor RPW | Servidor RPW | Identificação do Servidor RPW. | NO |
| Índice primário | Campo |
| idx-empresa | empresa |
| Database | Table Name | Label | Description |
| mgind | requisicao-api-gov | Requisição API Gov | Controle de requisições das APIs do governo. |
| Field Name | Data Type | Format | Label | Column Label | Descripton/Help Text | Mandatory |
| tipo-servico | Character | x(100) | Tipo do Serviço | Tipo do Serviço | Identificador do tipo da API que foi executada (Ex: credPres) | YES |
| data-exec | Date | 99/99/9999 | Data de Execução | Data de Execução | Data da consulta da API | NO |
| hora-exec | Character | 99:99:99 | Hora de Execução | Hora de Execução | Horário da consulta da API. | NO |
| codigo-status | Integer | >>9 | Codigo Status | Codigo Status | O retorno HTTP (200, 429, 500). | NO |
| sucesso | Logical | YES/NO | Sucesso | Sucesso | Flag rápida para filtrar se a requisição foi feita com sucesso | NO |
| mensagem-erro | Character | x(500) | Mensagem de Erro | Mensagem de Erro | Descrição amigável caso a requisição tenha falhado. | NO |
| Índice primário | Campo |
| 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.
Importante
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.
Foi realizada alteração no programa Cadastro de Crédito Presumido (html.mcd.credPres), permitindo o consumo das APIS do Governo para atualização da listagem de Créditos Presumidos conforme os dados oficiais disponibilizados.
Para viabilizar essa funcionalidade, foi incluído o botão "Atualizar Códigos", na tela principal. Ao acioná-lo, o processo de atualização é iniciado.
Importante
É necessário que os parâmetros estejam devidamente configurados no programa Parâmetros para Consumo das APIs do Governo - (html.mcd.govApiParams). Caso contrário, o processo de atualização não será iniciado.
Opções de Atualização
Durante a execução, o usuário poderá escolher entre as seguintes opções:
- Não Sobrescrever: realiza apenas a inclusão de novos códigos que ainda não existem na base, preservando os registros já existentes;
- Sobrescrever dados: substitui integralmente os registros atuais da listagem de Crédito Presumido pelos dados retornados pela API do Governo;
O processamento é realizado por meio de chamada RPW. O andamento pode ser acompanhado diretamente na tela de Cadastros de Crédito Presumido, por meio de mensagens de status exibidas ao usuário, ou via monitor de pedidos.
Ao término do processo, será exibido uma mensagem de sucesso e a tela será atualizada.
04. ASSUNTOS RELACIONADOS
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas