Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

O campo arquivo indica em qual arquivo será salvo a resposta da requisição efetuada para o portal da Conformidade Fácil. Esse arquivo serve apenas para conferência dos registros que foram retornados pela API.
O campo cod-endpoint indica qual dos serviços da API do portal da Conformidade Fácil será consumido. Os serviços disponíveis podem ser consultados por meio deste link.
O campo cod-programa-area indica qual o programa que será executado para realizar o tratamento dos dados retornados pela requisição feita pelo programa principal conusmoApiGov.p. Ao final da execução do programa consumoApiGov.p, será executado o programa que foi informado no campo cod-programa-area.
O campo l-sobrescreve é apenas um utilitário para indicar se o programa específico da área deve sobrescrever os dados ou apenas considerar códigos novos. Atenção! A lógica para sobrescrever ou não os códigos é responsabilidade do programa específico da área, o programa consumoApiGov.p apenas realiza a comunicação com o portal da Conformidade Fácil.

As APIs do portal da Conformidade Fácil utilizam de certificados digitais para realizar a autorização de acesso ao recurso. O certificado digital pode ser do tipo PEM ou PFX, no entanto, se for o tipo PFX, o programa irá automaticamente converter o certificado para o tipo PEM, gerando dois arquivos de certificado digital com as extensões .pem.key. Esse processo é feito utilizando a biblioteca OpenSSL disponível a partir dos arquivos de instalação do Progress da sessão. Em caso de erros durante o processo de conversão, é necessário consultar os logs do servidor RPW procurando no arquivo pela chave AppError. Os comandos utilizados durante a conversão são gravados nos logs buscando pela chave AppLog.

Para realizar as requisições para o portal da Conformidade Fácil, o programa utiliza da biblioteca cURL para realizar requisições a partir da linha de comando usando o sistema operacional. O uso do cURL em detrimento das bibliotecas próprias do Progress para realizar a requisição se deve a necessidade de uso de certificado digital na requisição e esta funcionalidade não é suportada pelo Progress em versões mais antigas como a 12.2. 

Em caso de sucesso na requisição, o programa recebe os dados em formato JSON e realiza os tratamentos para enviar o JSON de retorno para a API da área. Em caso de falha na requisição, o resultado do comando comando cURL será salvo em um arquivo chamado api_gov_response.txt no diretório temporário da sessão. Outros erros durante a execução do programa serão gravados nos logs da sessão com o código AppError

...

Temp-Tables


RowErrors

Entrada/Saída

Temp-table Tabela temporária com dados dos erros ocorridos durante o processo

Saída

AtributoTipoDescrição

Obrigatório

Evolução

ErrorSequenceINTEGERNúmero da sequência do erro.

Sim

Não se aplica

ErrorNumberINTEGERCódigo do erro.

Sim

Não se aplica

ErrorDescriptionCHARACTERDescrição detalhada do erro.NãoNão se aplica
ErrorTypeCHARACTERTipo do erro (Ex: ERROR, INTERNAL).NãoNão se aplica
ErrorSubTypeCHARACTERSubtipo do erro.NãoNão se aplica



CadNbsTemp-table campos a serem retornados na busca dos códigos de NBS.

tt-param

Entrada/Saída

Tabela temporária com os

parâmetros de execução do programa consumoApiGov.

EntradaSaída

AtributoNome no Objeto (JSON)TipoDescriçãoObrigatório

Evolução

destinoINTEGERDestino de geração do relatório (Online, Impressora e outros)Não

Não se aplica

arquivoCHARACTERCaminho no qual será salvo o arquivo JSON de resposta da requisição.
Se não for preenchido, o arquivo será gerado no diretório de spool do servidor RPW com o nome consumoApiGov.json.
Não

Não se aplica

usuarioCHARACTERCódigo do usuário que está executando o programa.Não

Não se aplica

data-execDATEData de execução do programa.Nãocod-nbscodNbsCharacterCódigo da Nomenclatura Brasileira de Serviços (Chave).Sim

Não se aplica

desc-nbs
hora-execINTEGERHora de execução do programa.Não

Não se aplica

cod-endpoint
CHARACTERNome do serviço do portal da Conformidade Fácil ao qual será realizado a requisição. Os serviços podem ser consultados neste link descNbsCharacterDescrição do serviço.Sim

Não se aplica

cod-programa-areaCHARACTERPrograma da área que será executado recebendo o retorno da requisição feita ao portal da Conformidade Fácil como parâmetroSim

Não se aplica

l-sobrescreve
LOGICALParâmetro auxiliar para identificar se o programa da área deve sobrescrever ou não os códigos com o retorno da requisição ao portal da Conformidade Fácil.Não

Não se aplica.