VR Integracao Fiscal API

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 .vr pode 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 -d para 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)

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:

• Troca do Token: Para iniciar o consumo, deve-se realizar uma requisição ao endpoint /auth enviando o Token gerado no VRMaster.

• Hash de Autorização: A API retornará um hash de segurança. Este hash é o que valida as chamadas de integração e consulta.

• Configuração do Header: O hash deve ser inserido obrigatoriamente no cabeçalho (Header) de todas as requisições subsequentes sob a chave Authorization.

• Padrão de Envio: O preenchimento do Header deve seguir rigorosamente o padrão: Bearer {hash_retornado} (Mantendo obrigatoriamente o espaço único entre a palavra Bearer e o código hash).