Bling API V3 OAuth

Script desenvolvido para facilitar a obtenção do Access Token da API V3 do Bling e sua atualização com o Refresh Token. Módulo para abstrair essa parte e trazer agilidade no desenvolvimento do seu software.

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

Ter o Git configurado.
Tem tem python3 instalado.
Possui algum gerenciador de ambiente virtual python como: conda ou venv
Você tem uma máquina <Windows / Linux / Mac>.
Você leu documentação Bling API V3.

🎉 Começando

Para instalar o bling_api_v3_oauth, siga estas etapas:

1° Clone o projeto e entre no diretório do projeto

Clone o projeto. Abra o seu terminal e digite:

git clone https://github.com/vcsil/bling_api_v3_oauth.git

Entre no diretório do projeto:
```
cd bling_api_v3_oauth
```

Configure um ambiente virtual e as dependências com conda ou venv

2° Crie um ambiente virtual com conda e instale as dependências

É necessário ter conda previamente instalado.

Crie um ambiente virtual com conda e instale as dependências dos projetos.
```
conda create -n bling_oauth --file environment.txt -y
```
Note que o nome do ambiente virtual criado é “bling_oauth”

A flag -y no final permite a instalação automática dos pacotes, remova caso queria acompanhar quais serão instalados.
Ative o ambiente virtual criado
```
conda activate bling_oauth
```
Você verá o nome do ambiente virtual no seu prompt de comando, indicando que o ambiente está ativo. Exemplo:
```
(bling_oauth) $
```

2° Crie um ambiente virtual com venv e instale as dependências

Crie um ambiente virtual com venv.
```
python3 -m venv bling_oauth
```
Note que o nome do ambiente virtual criado é “bling_oauth”

Ative o ambiente virtual criado

# No Linux/Mac:
source bling_oauth/bin/activate  

# No Windows (PowerShell):
.\bling_oauth\Scripts\Activate
# No Windows (cmd):
.\bling_oauth\Scripts\activate.bat

Você verá o nome do ambiente virtual no seu prompt de comando, indicando que o ambiente está ativo. Exemplo:
```
(bling_oauth) $
```
Instale as dependências necessárias.
```
pip install -r requirements.txt
```

3° Configure as variáveis de ambientes necessárias

Faça uma cópia do arquivo .env.example e crie o .env que será usado

# No Linux/Mac:
cp ./.env.example ./.env

# No Windows (PowerShell):
Copy-Item -Path "./.env.example" -Destination "./.env"

# No Windows (cmd)
copy ./.env.example ./.env

Abra o arquivo .env com o seu editor de texto preferido e forneça as credenciais
- BLING_CLIENT_ID: fornecido na página do aplicativo no Bling
- BLING_CLIENT_SECRET: fornecido na página do aplicativo no Bling
  
  Acesse a documentação da API BLING V3
- BLING_USUARIO: Usuário do bling para liberar acesso as informações necessárias da conta. Utilizado para fazer o login com a autentificação OAuth e gerar as credenciais. Verifique sempre o escopo da aplicação.
- BLING_SENHA_USUARIO: Senha do usuário
[!WARNING]
Nunca compartilhe os dados contido no .env

Exemplo de .env preenchido

☕ Usando bling_api_v3_oauth

Após fazer toda a instalação do projeto e configurar as variáveis de ambiente.

Execute o seguinte comando na raiz do projeto para gerar novas credenciais dentro do arquivo .env
```
python3 BlingV3.py
# ou 
python3 BlingV3.py create
```
O script ira se autenticar automaticamente e ira preencher o arquivo .env com as credenciais criadas.

Não feche as jenelas que abrirem

Exemplo de .env após gerar as credenciais:
Execute o seguinte comando raiz do projeto para gerar atualizar as credenciais dentro do arquivo .env
```
python3 BlingV3.py refresh
```
O script ira se autenticar automaticamente e ira atualizar o arquivo .env com as credenciais criadas.

📫 Contribuindo para bling_api_v3_oauth

Para contribuir com <nome_do_projeto>, siga estas etapas:

Bifurque este repositório.
Crie um branch: git checkout -b <nome_branch>.
Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
Envie para o branch original: git push origin bling_api_v3_oauth / <local>
Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

Agradecemos às seguintes pessoas que contribuíram para este projeto:

_MatheusBruno

_vcsil

vcsil / bling_api_v3_oauth Goto Github PK