webhook-ons

🗺️ Conteúdo

1. O que o serviço faz?
2. Quais tecnologias posso usar?
3. Como utilizar o serviço?

📜 O que o serviço faz?

Repositório com o webhook do Sintegre configurado, faz o download dos arquivos que o Sintegre disponibiliza. Esse serviço optou por utilizar o Ngrok (ferramenta que te permite criar um túnel seguro, atrás de NATs e Firewalls, que expõem serviços locais para a Internet) fazendo com que o usuário não precise expor uma porta do computador de forma manual.

Para criar sua conta ngrok gratuitamente visite: https://ngrok.com

⚠️ Quais tecnologias posso usar?

Há duas maneiras de executar este repositório, utilizando Python ou Docker.

• Python
• Docker

📝 Como utilizar o serviço?

Execute o comando abaixo para clonar o repositório:

git clone https://github.com/Rodrigo-Caldas/webhook-ons.git

Para o webhook ter mais segurança, o serviço foi pensado para ter autenticação por usuário e senha. Não é obrigatório, mas segue uma boa prática de segurança para evitar qualquer tipo de invasão.

No arquivo config.py altere as 4 variáveis de configuração especificadas aqui no readme. As variáveis usuario e senha não são obrigatórias, mas são recomendadas como já explicado anteriormente:

usuario: str = "usuario-webhook"
senha: str = "senha-do-webhook"
token_ngrok: str = "token-do-usuário-ngrok"
dominio_ngrok: str = "domínio-da-aplicação-ngrok.app"

É possível rodar a aplicação de duas formas: através da criação de ambiente python 🐍 ou utilizando docker 🐳

🐍 Via Python

Crie um ambiente com o python 3.13 a partir do comando:

python -m venv webhook-ons

Ative o ambiente a partir do comando:

source webhook-ons/bin/activate

Instale as bibliotecas com:

pip install -r requirements.txt

E por fim rode a aplicação com:

uvicorn src.main:app --reload

🐳 Via Docker

Para rodar a aplicação em um container, construa a imagem da aplicação a partir do comando:

docker build . -t webhook-ons

Com a imagem construída podemos criar o container onde a aplicação será rodada, mas antes verifique o caminho da pasta download presente neste repositório. Ela será necessária para criarmos um volume que a ligará com a pasta download presente no container.

Após verificar o caminho, insira o caminho dela no comando de criação do container:

docker run -v /caminho/da/pasta/download/local:/home/download -t webhook-ons:latest