> For the complete documentation index, see [llms.txt](https://docs.vrsoft.com.br/vrmaster/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vrsoft.com.br/vrmaster/gestao-do-conhecimento/vr-integracao-fiscal-api.md).

# 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**](/vrmaster/equipamentos-homologados/instalacao-impressora-sweda-si-300s-windows/manual-do-sistema-vr-setup-pdv-instalacao-e-configuracao/instalacao-pdv/gestao-do-conhecimento-vr-pdv/gestao-do-conhecimento-vr-pdv-impressora-fiscal/erro-impr-0a29/manual-do-sistema-vr-pdv/manual-do-sistema-vr-pdv-instalacao-e-configuracao/instalacao-e-configuracao-leitores-biometricos/configuracao-leitor-biometrico-generico/configuracao-leitor-biometrico-generico-linux/distribuicoes-linux/vrubuntu/vrubuntu-ferramentas.md)
* 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.

![](/files/uVHvlzcwbRGWCy2QCbDq)

## **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).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.vrsoft.com.br/vrmaster/gestao-do-conhecimento/vr-integracao-fiscal-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.