Integrar

Este guia é para quem quer ler ou escrever dados do Presente a partir de outro sistema, como um sistema acadêmico: trazer alunos, turmas e atividades, ou consultar frequência. A API é a mesma que o aplicativo usa.

O que existe e o que não existe

• Existe: uma API HTTP com corpo JSON, descrita em Referência da API e no arquivo OpenAPI.
• Autenticação: login de uma pessoa (e-mail e senha) que devolve um token de acesso de curta duração e um token de renovação. Veja Autenticação.
• Não existe: chave de API de longa duração, webhooks (o Presente não avisa o seu sistema; você consulta), portal de cadastro de desenvolvedor nem ambiente de testes separado do de demonstração.
• Quem pode o quê depende do papel da conta que você usa: veja Permissões. Você só consegue ler e alterar o que essa conta já poderia no aplicativo.

Endereços

Ambiente	Base da API	Para quê
Produção	https://app.presente.app.br/api	Dados reais da sua instituição.
Demonstração	https://demo.presente.app.br/api	Dados fictícios, restaurados todo domingo de madrugada (o que você alterar lá não permanece). Bom para testar o código.

Os exemplos usam $API para a base e $TOKEN para o token de acesso:

export API=https://demo.presente.app.br/api

Chamadas feitas direto de um navegador, de outro site, não são liberadas (CORS). Integre a partir de um servidor seu.

Por onde começar

1. Autenticação: obter e renovar o token.
2. Permissões: que papel a conta de integração precisa ter.
3. Erros e Paginação e limites: como a API responde quando algo dá errado e como listar muitos itens.
4. As jornadas, passo a passo: alunos, turmas e atividades.

Estabilidade

As rotas descritas aqui são as que o aplicativo usa. São internas e não têm garantia de estabilidade: campos podem ser acrescentados, e uma rota pode mudar quando o aplicativo mudar. Acrescentar campos à resposta não é tratado como mudança incompatível, então ignore campos que você não conhece. Se a sua integração precisa de uma garantia maior, escreva para contato@presente.app.br.

O arquivo OpenAPI e esta referência são gerados a partir do código da API; por isso refletem a versão publicada.

Dados de exemplo

Todos os exemplos usam dados fictícios (pessoas, e-mails e identificadores inventados). Nunca coloque dados pessoais reais em testes na demonstração.