¶ Primeiros Passos para Utilizar o nWeb
Bem-vindo à integração com o NWEB! Este guia foi criado para ajudá-lo a configurar e iniciar sua integração de maneira simples e eficiente.
Observação: Se você utiliza o Questor Cloud, pode pular a Etapa 1 deste guia, pois essa configuração será realizada pelo nosso time técnico de monitoramento.
¶ 1° Passo - Configurar nWeb
Na pasta de instalação do Questor, clique com o botão direito na aplicação nWeb.exe e envie um atalho para a Área de trabalho.
No atalho criado na Área de trabalho, você deve clicar com o botão direito nele e abrir as propriedades do atalho. Nas propriedades, você pode inserir valores de configuração do nWeb:
Ao informar /log, o nWeb irá retornar todos os Logs ao executar qualquer operação. O /porta:8080 serve para alterar a porta onde o nWeb será executado e pode ser alterado o número para qualquer outra porta que não esteja mais em uso. Estes parâmetros não são obrigatórios, porém se torna necessário em casos onde precisa ser alterada a porta, que por padrão, é executada na porta 8080. Ao inserir essas configurações, clique em “Aplicar” e feche esta tela.
Após a configuração, você já pode iniciar a aplicação e sempre como Administrador.
Ao abrir a aplicação, será apresentada a tela de login do Questor, onde deve ser selecionada a base desejada e o usuário e senha do sistema Questor:
Ao clicar em entrar, o nWeb está pronto para o uso.
Após concluir a configuração do nWeb, você pode testar a conexão utilizando os seguintes Endpoints: /TnWebDMDadosGerais/PegarVersaoQuestor e /TnInfo/Info
Exemplo de requisição: http://localhost:8080/TnWebDMDadosGerais/PegarVersaoQuestor
Se a configuração foi realizada corretamente, o endpoint retornará a seguinte mensagem:
Exemplo de requisição: http://localhost:8080/api/TnInfo/Info
Se a configuração foi realizada corretamente, o endpoint retornará a seguinte mensagem:
¶ 2° Passo - Criar um token.
Este passo é importante para a segurança da API, porém não é um passo obrigatório para o funcionamento da mesma. Caso seja solicitado, é possível criar um Token e ser inserido dentro do sistema Questor para que em todas as requisições seja necessário informar este token.
Dentro de qualquer módulo, você pode inserir um token, que pode ser gerado por qualquer gerador online. No módulo do Questor, esta configuração estará presente no seguinte caminho:
No campo abaixo, você pode inserir o Token que foi gerado e clicar para salvar no cabeçalho da rotina:
Ao salvar o token, em todos os demais endpoints será obrigatório o uso do parâmetro TokenApi. Neste parâmetro, será informado o mesmo token cadastrado na rotina do sistema. Sem esse token a API irá retornar um erro.
¶ 3° Passo - Identificar o Nome interno das rotinas.
Para executar uma rotina, é necessário identificar o nome interno da mesma.
Como identificar no Questor Desktop:
- Acesse a rotina desejada e pressione as teclas ALT + ENTER simultaneamente. Uma janela será exibida com o nome interno.
Como identificar no Questor Cloud: - Utilize o Endpoint
GET - /TnWebDMMenus/Pegarcom os parâmetros:
TokenApi (Não obrigatório)
_ATipo
Para os parâmetro, _ATipo deve ser inserido um dos valores abaixo:
| Valor | Descrição |
| 1 | Cadastros: Fornece os nomes internos de rotinas utilizadas para obter dados cadastrais. |
| 2 | Consultas: Fornece os nomes internos de consultas nativas do sistema. |
| 3 | Processos: Fornece os nomes internos de processos nativos e personalizados do sistema. |
| 4 | Relatórios: Fornece os nomes internos dos relatórios nativos e personalizados do sistema. |
| 5 | Planilhas: Fornece os nomes internos das planilhas do sistema. (Em processo de descontinuação.) |
| 6 | Consultas Personalizadas: Fornece os nomes internos de consultas personalizadas do sistema. |
Exemplo de Requisição: http://localhost:8080/TnWebDMMenus/Pegar
A resposta retornará os nomes internos de todas as rotinas separadas por módulos. O nome interno estará na tag "Name".
¶ 4° Passo - Parâmetros da rotina
Após identificar o nome interno da rotina, descubra os parâmetros necessários para sua execução.
Endpoint para identificar parâmetros:
- Use o Endpoint
GET - /TnWebDMDadosObjetos/Pegarcom os parâmetros:- TokenApi (Não obrigatório)
- _AActionName
Exemplo de Requisição:
- Para a rotina de importação de notas fiscais eletrônicas (NFE):
A resposta exibirá:
"Name":Nome do parâmetro a ser informado no Body."Required":Indica se o parâmetro é obrigatório (True) ou não (False).
¶ Finalizando os Primeiros Passos
Parabéns! Se você chegou até aqui, sua integração inicial está configurada e funcional. Você já está pronto para começar a explorar os recursos avançados e personalizar sua integração para atender às necessidades específicas do seu negócio.
¶ Próximos passos
- Rotinas do Sistema: Avançando na documentação, você poderá verificar como executar uma rotina do sistema Questor através do nWeb.
- Relatórios do Sistema: Execute relatórios nativos ou personalizados do sistema com o nWeb.
- Importação e Exportação de Dados: Importe e exporte dados do sistema Questor utilizando o nWeb