Referência da API

Referência endpoint a endpoint da API REST do Beyou, agrupada por controller, com o contrato OpenAPI de cada uma.

• API do Controlador de Autenticação

  Endpoints de API para autenticação de usuário, registro, redefinição de senha e OAuth.

• API do Controlador de Verificação de E-mail

  Emite e consome o token de verificação de e-mail que libera o login.

• API do Controlador de Usuário

  Endpoints de API para gerenciar perfil, preferências e configurações do usuário.

• API do Controlador de Foto de Perfil

  Enviar a foto de perfil, removê-la, e servi-la de volta somente por URL assinada.

• API do Controlador de Exportação

  A exportação completa dos dados da conta.

• API do Controlador de Categoria

  Endpoints de API para gerenciar categorias de hábitos, tarefas e metas.

• API do Controlador de Hábitos

  Endpoints de API para gerenciar hábitos, suas verificações e progresso.

• API do Controlador de Tarefas

  Endpoints de API para gerenciar tarefas, incluindo tarefas únicas e recorrentes.

• API do Controlador de Metas

  Endpoints de API para criar, atualizar e rastrear metas.

• API do Controlador de Rotinas

  Endpoints de API para rotinas diárias, seções e agendamento.

• API do Controlador de Agendamento

  Endpoints de API para agendar rotinas em dias específicos.

• API do Controlador de Snapshots

  Snapshots diários imutáveis de rotina e check-ins atrasados com decaimento de XP.

• API do Controlador de Histórico de Checks

  Desfechos diários de check para hábitos, tarefas, rotinas e a conta.

• API do Controlador de Histórico de XP

  Séries de XP por dia para o usuário, categorias, hábitos e rotinas, densas na janela pedida.

• API do Controlador do Agente de IA

  CRUD dos chats do agente e o endpoint de streaming SSE por trás do assistente.

• API do Controlador de Onboarding

  Sugestões de IA tipadas para cada passo do assistente de onboarding.

• API do Controlador de Feedback

  Endpoints de API para enviar feedback do usuário com anexos de imagem, e para triagem e respostas do administrador.

• API do Controlador Admin de Feedback

  Triagem exclusiva de admin: listar, ler, responder e atualizar feedbacks.

• API do Controlador de Documentação de Arquitetura

  Endpoints de API para recuperar tópicos de documentação de arquitetura.

• API do Controlador de Blog

  Endpoints da API para recuperar posts e tópicos do blog.

• API do Controlador de Documentação da API

  Endpoints de API para recuperar tópicos de documentação da API.

• API do Controlador de Documentação de Projetos

  Endpoints da API para recuperar tópicos de documentação de projetos.

• API do Controlador de Busca de Docs

  Busca de documentação entre áreas com destaques de correspondência.

• API do Controlador de Importação de Documentação

  Endpoints de API para importar documentação de repositórios GitHub.

• API do Controller de Preferências de Notificação

  A chave dos e-mails de engajamento e o endpoint público do link de cancelamento.