A API(Application Programming Inteface) do software Gerentia tem como único objetivo ser um meio de comunicação entre os setores de estoque, vendas e administração. É responsável por sincronizar o banco de dados local presente em ambas as aplicações, de forma que todos no final possam ter as mesmas informações. É destinando exclusivamente aos desenvolvedores do software Gerentia: Estoque, Gerentia: Vendas e Gerentia: admin.
Link do repositório do Gerentia: Estoque -> https://github.com/RobertsCJ/Project-Gerentia
Para usar o serviço, o desenvolvedor precisa conectar a sua aplicação local com a API, utilizando uma URL correspondente ao domínio a qual a API está localizada. Um exemplo: em ambiente de desenvolvimento local, o serviço da API estará escutando na sua máquina. Portanto, a URL seria “http://localhost:PORT/”, onde a palavra-chave “PORT” referencia a porta do seu computador, na qual a API está rodando.
Está API por padrão escuta na porta 8000.
A documentação completa da API Gerentia está localizada na pasta Docs deste repositório. Mas é muito importante conferir o básico sobre consumo de APIs para que o desenvolvedor tenha menos problemas na hora de integrar o serviço com sua aplicação local.
// Para iniciar o ambiente virtual:
- source venv/bin/activate
// E para executar a API basta rodar o comando:
- python3 main.py
// Para iniciar o ambiente virtual:
- venv\Scripts\activate
// E para executar a API basta rodar o comando:
- python3 main.py
// instala todas as depedências do projeto
- pip install -r requirements.txt