Mudanças entre as edições de "VR Integracao Fiscal API"
De VRWiki
(Criou página com '==<b>LICENCIAMENTO E ATIVAÇÃO</b>== O processo de liberação do módulo é vinculado ao licenciamento da unidade: * '''Liberação Comercial:''' A unidade ou parceiro deve...') |
(→AUTENTICAÇÃO (BEARER TOKEN)) |
||
| Linha 48: | Linha 48: | ||
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: | 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 | + | * '''Obtenção do Hash:''' Realize uma requisição ao endpoint <code>/auth</code> informando 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'''. | * '''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). | * '''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). | ||
Edição das 12h15min de 24 de março de 2026
Índice
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 neste link
- Crie na pasta
.vr, 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.vrpode estar oculta):
├── ./vr │ ├── data │ ├── exec │ ├── servicecontainer* │ │ └── service │ │ └── VRIntegracaoFiscalAPI.war* │ ├── servicemanager* │ │ └── service │ │ ├── VRConcentrador.jar │ │ └── ... │ ├── docker-compose-sm.yml* │ └── vr.properties*
- Executar
docker-compose -f ~/.vr/docker-compose-sm.yml up -dpara iniciar o ambiente. Em caso de sucesso na criação dos containers, o terminal exibirá:
Creating vrredis ... done Creating vrrabbitmq ... done Creating vrservicecontainer ... done Creating vrservicemanager ... done
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.
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
/authinformando 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
Bearer {hash_retornado}(Mantendo o espaço único entre a palavra Bearer e o código hash).
