Como acessar a API do SUAP e começar a criar seus próprios aplicativos

O SUAP é o sistema de gestão usado pelos Institutos Federais e reúne informações de ensino, pesquisa, extensão e administração. Para incentivar o desenvolvimento de aplicativos e sistemas que complementem o seu uso, a Diretoria de Tecnologia da Informação (DIGTI) do IFRN criou a API SUAP, um conjunto de serviços que pode ser usado em aplicações feitas em qualquer linguagem de programação.

Neste post, vou mostrar como acessar a API e dar um exemplo simples de uso.

O que é a API SUAP?

A API (Application Programming Interface) permite que um programa solicite dados do SUAP de forma padronizada, em vez de depender das telas do sistema. Segundo a notícia de lançamento, o objetivo é que alunos, professores e técnicos-administrativos usem as bases de dados públicas do SUAP para desenvolver sistemas e aplicativos, além de sugerir melhorias para o próprio sistema.

Os dados acessados seguem o nível de permissão do usuário, o que garante segurança e a confiabilidade das informações.

Onde encontrar a documentação

Existem duas formas de consultar a API:

1. Documentação interativa
Substitua SEU_CAMPUS pelo domínio do seu campus:

https://suap.SEU_CAMPUS.edu.br/api/docs

Exemplo, para o IFPI:

https://suap.ifpi.edu.br/api/docs

Nessa página você encontra os endpoints disponíveis, os parâmetros aceitos e as respostas esperadas, e pode testá-los diretamente no navegador.

Exemplo prático

O exemplo abaixo faz uma requisição GET e exibe o resultado. Os nomes de endpoint e o formato do cabeçalho de autenticação são ilustrativos: troque-os pelos valores da documentação.

import requests

BASE_URL = "https://suap.SEU_CAMPUS.edu.br"
USUARIO = "SEU_USUARIO"
SENHA = "SUA_SENHA"

# 1. Login: obtém o token de acesso
resp = requests.post(
    f"{BASE_URL}/api/token/pair",
    json={"username": USUARIO, "password": SENHA},
)
access = resp.json()["access"]

# 2. Consulta: dados do usuário logado
resp = requests.get(
    f"{BASE_URL}/api/rh/eu/",
    headers={"Authorization": f"Bearer {access}"},
)
print(resp.json()["nome"])

Para rodar, instale a biblioteca com pip install requests.

Ideias de aplicações

Painel pessoal com informações acadêmicas ou funcionais
Bot de Telegram ou WhatsApp que consulta dados do SUAP
Relatórios e gráficos personalizados para coordenações e departamentos
Integração com calendário, ferramentas de produtividade ou outros sistemas institucionais
Aplicativos mobile ou web complementares ao SUAP

Boas práticas

Nunca publique seu token em repositórios públicos. Use variáveis de ambiente ou um arquivo .env ignorado pelo Git.
Respeite as permissões: a API mostra apenas o que o seu usuário pode ver.
Cuide dos dados pessoais: tenha cuidado com o armazenamento e a exibição de informações de terceiros, considerando a LGPD.
Consulte os limites de uso definidos pela instituição e evite requisições em excesso.

Fonte: notícia “DIGTI cria interface que auxilia o desenvolvimento de sistemas e aplicativos”, IFRN. A notícia é de 2017 e foi atualizada em 2023, então confirme se a documentação atual ainda corresponde às informações deste post.

Fr. Junio Alves