> 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/manual-do-sistema/manual-do-sistema-vr-ficha-api/instalacao-vrficha-api.md). # Instalação e Configuração ## **REQUISITOS MÍNIMOS** Para que o VR Ficha API funcione corretamente de maneira consistente é necessário ter um computador com esta configuração ou superior: * VRUbuntu 20.04.0-1 (No Windows, utilizar o WSL) * Processador: i3 (5ª geração +) ou equivalente * Memória RAM: 8 GB * Disco: 80 GB * Docker instalado ## **INSTALAÇÃO** * **Certifique-se de que 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) * Certifique-se de que o Docker está instalando no sistema operacional na versão mais recente. * Faça o download do arquivo **docker-compose-vrfichaapi.yml** [clicando aqui](https://storage.googleapis.com/docker-compose-yml/docker-compose-vrfichaapi.yml) * Se o cliente já possuir o VR Service Manager rodando, o RabbitMQ do Service Manager pode ser utilizado, caso contrário, baixe o arquivo **docker-compose-rabbitmq.yml** [clicando aqui](https://storage.googleapis.com/docker-compose-yml/docker-compose-rabbitmq.yml) para subir o sistema de mensageria no servidor onde ficará o VR Ficha API. * No arquivo **docker-compose-vrfichaapi.yml** é configurado a **porta de comunicação** com a API, a **conexão com o banco de dados** e a **conexão com o RabbitMQ**. (Obs.: A conexão com o RabbitMQ configurada tem que ser a mesma no serviço de impressão dos pedidos, para que este funcione corretamente) ``` services:   vrficha-api:     image: vrsoftbr/vrfichaapi:4.1.10     ports:       - "9015:9015"     environment:       - TZ=GMT-3       - PORT=9015       - DATABASE_IP=       - DATABASE_PORTA=       - DATABASE_NOME=       - DATABASE_USUARIO=       - DATABASE_SENHA=       - SYSTEM_NUMEROLOJA=       - RABBITMQ_IP=       - RABBITMQ_PORTA=5672       - RABBITMQ_USUARIO=vr       - RABBITMQ_SENHA=vr!RbtMQ     networks:       - vr-network networks:   vr-network:     external: true ``` * Você deve preencher corretamente os dados de conexão com o banco, o numero da loja e os dados de conexão com o RabbitMQ. **Não é mais utilizado vr.properties**. A configuração é feita diretamente no arquivo de compose do docker. * Caso seja necessário alterar a porta, alterar em environment o valor de *PORT*, e também alterar as portas em *ports* ## **INICIALIZAÇÃO** * Para iniciar a API, basta executar este comando, passando na flag **-f** o nome do arquivo yml (Executar comando no mesmo diretório onde o arquivo está) ``` docker compose -f docker-compose-vrfichaapi.yml up -d ``` ***Obs: Será necessário estar autenticado no docker, pois a imagem é privada. Caso não esteja, executar o comando docker login e informar as credenciais*** * Caso seja necessário subir o RabbitMQ, executar o **docker compose** no arquivo do RabbitMQ também ``` docker compose -f docker-compose-rabbitmq.yml up -d ``` ## **IMPRESSÃO DAS FICHAS** * Para realizar a impressão das fichas, é necessário que o **VRFichaMobileImpressao** esteja sendo executado no servidor e conectado ao mesmo serviço do RabbitMQ em que a API do VRFicha Mobile está, pois ele irá consumir a fila do RabbitMQ e imprimir as fichas na impressora configurada no VRFicha. Você pode encontrar como configura-lo [clicando aqui](/vrmaster/manual-do-sistema/manual-do-sistema-vr-ficha-api/instalacao-vrficha-api/manual-do-sistema-vr-ficha-mobile-impressao.md) ## **CATRACAS** * A aplicação VRFicha API gera arquivos XML para integração com catracas dos tipos Acesso e Blantech * A aplicação grava os arquivos no diretório configurado para o tipo de catraca utilizada no VRMaster **Configuração do diretório** Para configurar o diretório onde os arquivos serão gerados, basta ir em: \*\*\_ ``` VRMaster -> PDV -> Parâmetro -> Periféricos -> Catraca ``` \_\*\* Então selecionar o tipo de catraca utilizado, ir até a aba da catraca selecionada, especificar o diretório e salvar. **PONTOS IMPORTANTES** ***Configuração correta do caminho no VRMaster*** O diretório configurado deve ser o caminho de uma pasta compartilhada na rede, sempre informando IP e o diretório. Não utilizar caminhos locais ou referenciar outras máquinas por nome, pois essa abordagem não funcionará. Obrigatoriamente deve ser no seguinte formato: ``` \\192.168.0.1\catraca ``` Referenciando o IP da máquina com a pasta compartilhada, e o nome da pasta. A barra pode ser tanto a invertida () quanto a comum (/), funcionará da mesma forma no app, se atentar se funcionará no desktop, pois ambos compartilham a mesma configuração feita no VRMaster. ***Configuração correta do compartilhamento*** O diretório precisa ser compartilhado com permissão para acesso Guest, ou seja, sem informar usuário e senha. --- # 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/manual-do-sistema/manual-do-sistema-vr-ficha-api/instalacao-vrficha-api.md?ask=&goal= ``` `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.