VR Integracao Fiscal API - Histórico de revisão

Felipe.salome em 16h01min de 25 de março de 2026

2026-03-25T16:01:24Z

Felipe.salome: /* AUTENTICAÇÃO (BEARER TOKEN) */

2026-03-24T12:15:29Z

‎AUTENTICAÇÃO (BEARER TOKEN)

Felipe.salome: Criou página com '==LICENCIAMENTO E ATIVAÇÃO== O processo de liberação do módulo é vinculado ao licenciamento da unidade: * '''Liberação Comercial:''' A unidade ou parceiro deve...'

2026-03-24T11:26:43Z

Criou página com '==LICENCIAMENTO E ATIVAÇÃO== O processo de liberação do módulo é vinculado ao licenciamento da unidade: * '''Liberação Comercial:''' A unidade ou parceiro deve...'

Página nova

==LICENCIAMENTO E ATIVAÇÃO==
O processo de liberação do módulo é vinculado ao licenciamento da unidade:

* '''Liberação Comercial:''' A unidade ou parceiro deve solicitar a ativação do módulo de Integração Fiscal junto à VR Software.
* '''Ativação via VRGestor:''' Após o processamento da licença no '''VRGestor''', o serviço é habilitado automaticamente para a unidade, sem necessidade de manutenção manual em tabelas de banco de dados por parte do cliente.
* '''Habilitação no Service Manager:''' No painel do '''VR Service Manager''', localize o serviço '''VRIntegracaoFiscalAPI''' e clique em '''Ativar'''.

==INSTALAÇÃO==

* '''Certifique-se de as configurações do VR Ubuntu foram todas executadas [[VRUbuntu_Ferramentas|neste link]]'''
* Crie na pasta <code>.vr</code>, dentro da pasta padrão do usuário, a seguinte estrutura de diretórios e arquivos, onde os arquivos e/ou pastas com * são obrigatórios (Em alguns casos a pasta <code>.vr</code> pode estar oculta):

<pre>
├── ./vr
│ ├── data
│ ├── exec
│ ├── servicecontainer*
│ │ └── service
│ │ └── VRIntegracaoFiscalAPI.war*
│ ├── servicemanager*
│ │ └── service
│ │ ├── VRConcentrador.jar
│ │ └── ...
│ ├── docker-compose-sm.yml*
│ └── vr.properties*
</pre>

* Executar <code>docker-compose -f ~/.vr/docker-compose-sm.yml up -d</code> para iniciar o ambiente. Em caso de sucesso na criação dos containers, o terminal exibirá:

<pre style="color: silver; background: black;">
Creating vrredis ... done
Creating vrrabbitmq ... done
Creating vrservicecontainer ... done
Creating vrservicemanager ... done
</pre>

==GERAÇÃO DE TOKEN (VRMASTER)==

Com o serviço em execução no Service Manager, é necessário registrar a API no ERP para obter a chave de acesso inicial:
* Acesse o sistema '''VRMaster''';
* Navegue até o menu '''Sistema > API''';
* Realize o cadastro da nova API para a unidade;
* Ao finalizar, o sistema exibirá o '''Token''' gerado. Este código deve ser armazenado para a etapa de autenticação.

[[Arquivo:VRMaster-Cadastro-API-Token.png]]

==AUTENTICAÇÃO (BEARER TOKEN)==
A API utiliza o padrão de segurança Bearer Token (JWT). O Token gerado no VRMaster deve ser trocado por um hash de autorização:

* '''Obtenção do Hash:''' Realize uma requisição ao endpoint <code>/auth</code> informando o CNPJ da loja e o Token obtido no VRMaster.
* '''Formatação do Cabeçalho:''' O hash retornado deve ser inserido no cabeçalho (Header) de todas as requisições subsequentes sob a chave '''Authorization'''.
* '''Padrão de Envio:''' O valor deve ser rigorosamente <code>Bearer {hash_retornado}</code> (Mantendo o espaço único entre a palavra Bearer e o código hash).

@@ Linha 46: / Linha 46: @@
 ==<b>AUTENTICAÇÃO (BEARER TOKEN)</b>==
-A API utiliza o padrão de segurança Bearer Token (JWT). O Token gerado no VRMaster deve ser trocado por um hash de autorização:
+Diferente das etapas anteriores de instalação e configuração, a autenticação ocorre no momento da utilização da API. Trata-se de um procedimento lógico necessário para que as requisições sejam processadas:
-* '''Obtenção do Hash:''' Realize uma requisição ao endpoint <code>/auth</code> informando o Token obtido no VRMaster.
+* '''Troca do Token:''' Para iniciar o consumo, deve-se realizar uma requisição ao endpoint <code>/auth</code> enviando o Token gerado no VRMaster.
-* '''Formatação do Cabeçalho:''' O hash retornado deve ser inserido no cabeçalho (Header) de todas as requisições subsequentes sob a chave '''Authorization'''.
-* '''Padrão de Envio:''' O valor deve ser rigorosamente <code>Bearer {hash_retornado}</code> (Mantendo o espaço único entre a palavra Bearer e o código hash).
+* '''Hash de Autorização:''' A API retornará um hash de segurança. Este hash é o que valida as chamadas de integração e consulta.