Referência da API

Referência dos endpoints, parâmetros, modelos e erros da API do Presente. Cada rota indica quem pode chamá-la e o limite de uso. As rotas são as mesmas que o aplicativo usa: não há uma API separada para integrações, e as rotas internas não têm garantia de estabilidade. Para os conceitos (autenticação, permissões, paginação, erros), comece pelo guia de integração.

Baixar o OpenAPI (JSON)

• Autenticação — 11. Entrar, renovar e encerrar sessões; convite, primeiro acesso, troca e recuperação de senha.
• Meu início — 4. Visões da própria pessoa: início, painel de atividades e estatísticas de presença.
• Perfil e sessões — 11. Perfil da própria pessoa, foto, conexões ativas, termos e a pesquisa de satisfação do aplicativo.
• Exclusão de conta — 3. Exclusão da própria conta, no aplicativo ou pela web.
• Instituições — 8. Instituições, política de privacidade e termo de uso de cada uma.
• Disciplinas — 4. Disciplinas de uma instituição.
• Catálogo de atividades — 5. Itens de catálogo de atividades profissionais de uma disciplina, usados para classificar as atividades.
• Critérios de avaliação — 4. Critérios (e rubricas) que a disciplina usa para dar notas.
• Turmas — 8. Turmas de uma disciplina: cadastro, período, equipe auxiliar e prontidão.
• Matrículas — 3. Alunos matriculados em uma turma.
• Atividades — 5. Calendário de atividades de uma turma (aulas, plantões, práticas).
• Importação CSV — 3. Importação em lote de pessoas, alunos e atividades, com simulação antes de gravar.
• Presença (aluno) — 3. O que o aluno faz: pedir presença, editar o relato e gerar o QR da atividade.
• Presença (avaliação) — 7. O que quem avalia faz: fila de pedidos, confirmar ou rejeitar, lote, leitura de QR e versões do relato.
• Frequência — 1. Matriz de frequência de uma turma (alunos × atividades).
• Notas e avaliação — 2. Notas e avaliação de uma matrícula, vistas pela equipe ou pelo próprio aluno.
• Autoavaliação final — 2. Autoavaliação final do aluno em uma turma.
• Feedback final — 4. Feedback de encerramento que a equipe escreve para cada aluno.
• Evolução — 3. Evolução longitudinal do aluno por disciplina.
• Estatísticas da turma — 1. Estatísticas de presença e notas de uma turma, com exportação.
• Conversa da turma — 5. Mensagens entre os participantes de uma turma.
• Notificações — 5. Avisos da pessoa e suas preferências por tipo.
• Dispositivos — 2. Aparelhos que recebem notificações push.
• Parâmetros — 4. Parâmetros da plataforma e da instituição, com herança entre os níveis.
• Usuários e vínculos — 8. Pessoas e papéis de uma instituição: cadastro, convite e vínculos.
• Auditoria — 3. Registro de eventos da instituição, com estatísticas e exportação.
• Contato — 1. Formulário de contato do site, sem login.
• Política de privacidade pública — 1. Página pública da política de privacidade de uma instituição, sem login.
• Push no navegador — 1. Configuração pública para receber notificações push no navegador.
• Saúde do serviço — 1. Verificação simples de que a API está no ar.
• Modelos de dados