CFe – Validação de ambiente (cfe nfce validate setup)
 |
Este artigo faz parte de uma série dedicada ao Moderator, abordando as diversas funcionalidades e programas disponíveis em suas telas. Cada artigo tem como objetivo fornecer uma visão geral detalhada das operações, características e fluxos de trabalho de cada componente, facilitando o entendimento e a utilização do sistema.
O programa cfe_nfce_validate_setup faz parte do módulo CFe e é responsável pelo setup de configuração requerido para reenviar nota NFCe.
Dados técnicos
| Programa | cfe_nfce_validate_setup |
|---|---|
| Módulo | cfe |
| Versão | 1.1 |
| Requisitos de sistema | N/A |
| Integrações | N/A |
| Tabelas |
|
| Localização | ../emporium/moderator/html/modules/cfe |
| Arquivos |
|
Funcionalidades principais
O programa funciona como um painel de diagnóstico do ambiente de NFC-e, permitindo identificar rapidamente inconsistências que podem impedir a autorização correta das notas fiscais.
Além disso, a ferramenta apresenta toda a estrutura necessária para comunicação com a SEFAZ, informando se os serviços, configurações e componentes do ambiente estão funcionando corretamente ou se existe alguma falha que possa impactar a emissão das NFC-es.
Entre as principais informações disponibilizadas pelo programa, estão:
- Versões dos arquivos do ambiente NFC-e;
- Extensões PHP utilizadas pelo sistema;
- Status do OpenSSL;
- Diretórios e certificados digitais;
- Variáveis de configuração da NFC-e;
- Semáforo das URLs de comunicação com a SEFAZ.
Importante: O acesso ao Módulo CFe do Moderator é limitado aos usuários com perfil administrador e à equipe de Suporte responsável.
Guia do usuário
Acesso ao programa
Siga o passo a passo abaixo para acessar o programa dentro do Moderator.
1. Para acessar a aba "Validação de ambiente", clique no ícone de Menu Principal, disponível no canto superior esquerdo.
2. Em seguida, selecione a opção “CFe”, depois “NFC-e” e, por fim, “Validação de ambiente”.
3. Você será redirecionado para a tela abaixo. Nela, é possível acompanhar todo o processo de diagnóstico e configuração do ambiente de NFC-e, verificando arquivos, certificados, configurações e comunicação com a SEFAZ.
Importante: Cada campo disponível na página é responsável por uma etapa do processo de emissão da NFC-e e deve seguir uma sequência específica de configuração. Confira mais na seção "Visualização (view) v. 1.18" abaixo.
Visualização (view) v. 1.18
Na tela de "Setup de Configuração Requerido para Reenviar Nota NFC-e", é possível identificar alguns arquivos necessários para o correto funcionamento do processo de emissão e reenvio das notas fiscais.
Importante: Sempre que houver divergências, vencimentos ou inserção de dados incorretos, o campo estará destacado em vermelho. Confira o exemplo do passo 6.1 "Variáveis de Configuração NFC-e".
1. O primeiro tópico exibido na tela é “Versões dos Arquivos”. Nesta seção, são apresentadas as versões dos principais arquivos utilizados no processo de NFC-e, como:
- cfe_resend_nfce.php;
- cfe_nfce.js.
2. O segundo tópico é “PHP”, que corresponde à linguagem utilizada no funcionamento das rotinas de emissão, processamento e comunicação das NFC-es no sistema.
Nesta seção, é possível verificar a versão do PHP instalada no ambiente e a versão mínima requerida pela aplicação para o correto funcionamento das rotinas de NFC-e.
No exemplo exibido na imagem abaixo:
- PHP instalada: 7.4.22;
- Versão mínima requerida: 7.4.
3. O terceiro tópico, “Extensões PHP”, demonstra as bibliotecas e extensões utilizadas pelo ambiente PHP da aplicação, responsáveis pelo funcionamento das rotinas de emissão, comunicação e processamento das NFC-es, tais como:
| Arquivo de extensões PHP | Descritivo |
|---|---|
| mbstring | Responsável pelo tratamento de caracteres especiais e codificação de textos |
| gd | Utilizada para processamento e manipulação de imagens |
| mysqli | Permite a comunicação do sistema com bancos de dados MySQL |
| pdo_mysql | Responsável pela conexão com banco de dados MySQL utilizando PDO |
| zlib | Utilizada para compactação e descompactação de arquivos |
| dom | Permite manipular estruturas XML e HTML |
| openssl | Responsável pelos recursos de criptografia e certificados digitais utilizados na comunicação com a SEFAZ |
| soap | Utilizada na comunicação via WebService com a SEFAZ |
| json | Responsável pelo tratamento e leitura de arquivos no formato JSON |
| simplexml | Utilizada para leitura e manipulação simplificada de arquivos XML |
| libxml | Biblioteca base utilizada no processamento de arquivos XML |
| curl | Responsável pela realização de conexões e requisições externas |
| xml | Utilizada no processamento e interpretação de arquivos XML |
| zip | Utilizada para compactação e descompactação de arquivos ZIP |
4. O quarto tópico, “OpenSSL”, traz a verificação da extensão responsável pelos recursos de segurança e criptografia do ambiente PHP, que são:
- OpenSSL instalado: OpenSSL 1.0.2u 20 Dec 2019;
- OpenSSL Legacy Provider: ativo.
Essas informações indicam a versão da biblioteca criptográfica disponível no servidor e o suporte a algoritmos legados necessários para compatibilidade com integrações e comunicação com a SEFAZ.
5. O quinto tópico, “Diretórios e Certificados”, exibe os caminhos dos diretórios onde estão armazenados os arquivos necessários para o processamento das NFC-e, além de apresentar a verificação dos certificados digitais utilizados pelo sistema.
Nesta seção também são identificados possíveis certificados com inconsistências, indicando a loja afetada, o motivo da inconsistência e a data de validade de cada certificado, permitindo a análise e correção de problemas relacionados à autenticação e comunicação com a SEFAZ. Além disso, o módulo disponibiliza um filtro de busca para facilitar a localização de lojas quando há um grande volume de registros vinculados.
Observação: A utilização de certificados digitais inválidos, vencidos ou configurados incorretamente pode impedir a comunicação com os serviços da SEFAZ, comprometendo a autorização, a consulta e o reenvio das NFC-e. Recomenda-se monitorar periodicamente a validade dos certificados e realizar sua renovação antes do vencimento para evitar indisponibilidade na emissão de documentos fiscais.
6. O sexto tópico, “Variáveis de Configuração NFC-e”, apresenta todas as variáveis de configuração necessárias para o funcionamento do ambiente de NFC-e, incluindo parâmetros de URL, ambiente (AMB) e TOKEN de autenticação utilizados pelo sistema para comunicação com serviços externos e com a SEFAZ, tais como:
| Arquivo variáveis de configuração NFCe | Descritivo |
|---|---|
| NFCE_AUTH_URL | URL de solicitação para a SEFAZ da autorização da nota |
| NFCE_CNSPRT_URL | Consulta da nota com a chave de acesso ou protocolo |
| NFCE_CONSCH_URL | Consulta pela chave de acesso fornecida |
| NFCE_EVENT_URL | Consulta dos eventos relacionados a emissão, envio e cancelamento da nota |
| NFCE_INUT_URL | Envio de inutilização da nota emitida |
| NFCE_QRCODE_URL | URL correspondente ao QRCode da nota |
| NFCE_RETAUTH_URL | URL de consulta do PDV referente a autorização da nota pela SEFAZ |
| NFCE_SRVSTS_URL | Consulta parametrizável do status de serviço da SEFAZ |
| NFCE_TP_AMB | Define entre:
|
| TOKEN_NFCE | Código de autorização da NFC-e (TOKEN ID) |
| SENHA_CERT | Senha do certificado para emissão da NFC-e |
6.1. Além disso, em “Variáveis de Configuração NFC-e” também é possível identificar quando uma loja não possui alguma variável configurada, conforme indicado na tela abaixo, onde são destacadas as variáveis não configuradas por loja. Também é disponibilizado um filtro de busca, permitindo facilitar a localização das informações quando há um grande volume de registros.
7. O último tópico, “Semáforo das URLs NFC-e”, apresenta todas as URLs relacionadas à SEFAZ utilizadas pelo sistema, exibindo seu status de funcionamento (ONLINE ou FORA DO AR), além de informações de monitoramento como HTTP, tempo de resposta, validação SSL Trust e o link de cada URL.
Também são apresentadas observações técnicas sobre o critério de avaliação dos status:
- Critério: ONLINE = respondeu (qualquer HTTP code > 0, mesmo 401/403/405); INSTÁVEL = lento (>= 1500ms) ou HTTP 5xx; FORA = timeout/DNS/conexão;
- SOAP: URLs terminadas em .asmx são testadas automaticamente com ?WSDL.
7.1 Além disso, o módulo disponibiliza um "Chat de testes" para validação de conectividade e verificação de confiabilidade do SSL (SSL Trust), permitindo simular e analisar o comportamento das requisições.
