## **API PGD**
O envio de dados (planos individuais) para o governo é feito por uma subaplicação externa ao sistema Polare disponível no endereço [https://github.com/djangonauta/dj-polare-pgd](https://github.com/djangonauta/dj-polare-pgd). Essa aplicação também é utilizada para visualizar a formatação dos dados a serem enviados e pode ser utilizada para consultas e análise de planos individuais.
### **Instalação**
Como se trata de um aplicação [django](https://www.djangoproject.com/) / [python](https://www.python.org/) disponibilizada no [github](https://github.com/), os seguintes passos para a instalação são necessários:
1. Instalação do interpretador python e as dependências do ambiente
2. Instalação do Git e clonagem do projeto
3. Instalação e configuração das dependências do Projeto##### **Instalação do interpretador python e as dependências do ambiente**
As versões mais novas de sistemas Linux (como [Ubuntu](https://ubuntu.com/)) provavelmente já possuem o interpretador Python3 instalado. A aplicação citada anteriormente foi testada utilizando a versão mais recente da linguagem Python no momento que esta documentação é escrita (Versão 3.11.2).Para gerenciar múltiplas versões do interpretador Python (incluindo as versões mais novas) recomendamos utilizar [Pyenv](https://github.com/pyenv/pyenv).O comando a seguir instala as dependências (pacotes Python) do ambiente utilizando o gerenciador de pacotes [Pip](https://pypi.org/project/pip/):
```
pip3 install -U pip setuptools wheel bpython
```
##### **Instalação do Git e clonagem do projeto**
O Git pode ser encontrado no endereço [https://git-scm.com/downloads](https://git-scm.com/downloads). Em sistemas linux (Ubuntu) o seguinte comando pode ser utilizado para instalá-lo:
```
sudo apt install git -y
```
Para clonar o projeto o seguinte comando pode ser utilizado:
```
git clone git@github.com:djangonauta/dj-polare-pgd.git
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/8o7UrjE2LxCmgpvQ-image.png)
##### **Instalação e configuração das dependências do projeto**
As configurações do projeto são feitas via variáveis de ambiente e/ou adicionando as seguintes variáveis no arquivo localizado em dj-polare-pgd/projeto/settings/.env:
```mysql
SECRET_KEY='cixd(5rsi2$0h@z7m2juljajcm$%f8c&yy7m7mzqtc73!+e@(-'
DATABASE_URL='postgres://postgres:admin@localhost:5432/polaredb'
ADMINS='admin=admin@domain.com'
EMAIL_URL='consolemail://:@'
CACHE_URL='redis://127.0.0.1:6379'
BROKER_URL='amqp://usuario:senha@localhost:5672/projeto'
DISABLE_ACCOUNT_REGISTRATION='False'
ACCOUNT_EMAIL_VERIFICATION='none'
API_PGD_LOGIN_URL='http://hom.api.programadegestao.economia.gov.br/auth/jwt/login'
API_PGD_PLANO_TRABALHO_URL='http://hom.api.programadegestao.economia.gov.br/plano_trabalho'
API_PGD_CREDENCIAIS='username=usuario@edu.br,password=senha'
```
As URLs referentes a configurações contendo usuário e senha possuem o seguinte formato: protocolo://usuario:senha@host:porta/recurso.A variável SECRET\_KEY é necessária para o funcionamento do framework Django especialmente relacionada com segurança. O seguinte site pode ser utilizado para gerar essa string: [https://djecrety.ir/](https://djecrety.ir/).A variável DATABASE\_URL contém as configurações de acesso ao banco de dados postgresql. Recomendamos que inicialmente seja utilizada uma nova base (backup) do sistema Polare. A configuração apresentada tenta conectar em um banco de dados postgresql chamado polaredb-backup rodando em localhost na porta 5432 utilizando o usuário postgres e a senha admin. O responsável pela distribuição da aplicação deve alterar esses valores conforme as especificidades de sua instituição.A variável ADMINS configura os usuários admin do sistema no formato usuario1=usuario1@domain.edu.br,usuario2=usuario2@domain.edu.br. Esses usuários normalmente são notificados por email quando erros acontecem no sistema.A variável EMAIL\_URL configura o servidor de email utilizado para enviar mensagens. Essa aplicação no momento não trabalha enviando emails. A configuração apresentada configura o sistema para enviar mensagens para a linha de comando.As variáveis API\_PGD\_\*\_URL são utilizadas para conexão e envio de dados para a API PGD do governo. As URLS apresentadas apontam para o ambiente local de desenvolvimento dessa api descrito em [https://github.com/economiagovbr/api-pgd](https://github.com/economiagovbr/api-pgd). A variável API\_PGD\_CREDENCIAIS deve ser definida conforme cadastrada no ambiente de desenvolvimento, ou obtida para o ambiente de produção. As credenciais de produção podem ser obtidas na documentação oficial [https://api-programadegestao.economia.gov.br/docs](https://api-programadegestao.economia.gov.br/docs)
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/zA9mPA7BLhW4axMu-image.png)
As dependências do projeto são gerenciadas utilizando [pipenv](https://pipenv.pypa.io/en/latest/). Inicialmente deve ser criado o ambiente virtual a partir do diretório dj-polare-pgd utilizando o seguinte comando:
```
pipenv shell
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/kcmI0jht2nhcLeLR-image.png)
Após a criação do ambiente virtual as dependências podem ser instaladas com o comando:
```
pipenv install --dev
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/IFbZlJNGaBrhmktQ-image.png)
##### **Execução da aplicação**
Com as dependências instaladas e as váriaveis de ambiente configuradas é possível executar a aplicação no modo desenvolvimento com o comando:
```
invoke
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/VyQekNGWnNZmkGam-image.png)
A aplicação deve estar rodando em localhost:8000:[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/xWov2vH4qcs8jpob-image.png)
É necessário criar um usuário administrador para visualizar os endpoints contendo os planos individuais serializados no formato json.Para criar um usuário administrador deve-se utilizar o seguinte comando e fornecer os dados que o utilitário necessita (usuário, email e senha):
```
./manage.py createsuperuser
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/NliywN3MeGrCxJRv-image.png)
Com pelo menos um usuário admin criado é possível logar na aplicação clicando no link login no canto superior direito:Após logar na aplicação é possível visualizar os planos individuais no formato json esperado pela API PGD do governo clicando no link [http://localhost:8000/api/v1/plano-individual/](http://localhost:8000/api/v1/plano-individual/):[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/MweZG2vPJy1OGIWM-image.png)
É possível fazer consultas de planos individuais clicando no botão “filter”. A aplicação busca pelas chaves matricula\_siape, nome\_participante e modalidade\_execucao (presencial, remoto e híbrido - valores 1, 2 e 3 respectivamente).#### **Envio de dados**
O envio de dados para a API PGD do governo é feita utilizando o seguinte comando:
```
./manage.py enviar_dados
```
[](https://base.ifpa.edu.br/uploads/images/gallery/2023-07/NdZpkPfHjynnp9mK-image.png)
No momento que esta documentação é escrita ocorre um erro ao enviar os dados para o banco de dados da API PGD localmente (desenvolvimento). Esse erro acontece porque alguns código de unidade do instituto são muito longos, ultrapassando o limite do tipo de dados inteiro da coluna cod\_unidade\_exercicio da tabela public.plano\_trabalho do banco api\_pgd.Para contornar esse problema localmente, o tipo de dados da referida coluna foi alterado de int para bigint utilizando a SQL a seguir (conectado no banco da aplicação de recebimento de dados api\_pgd):
```
api_pgd=# alter table public.plano_trabalho alter cod_unidade_exercicio type bigint;
```