API docs by Redocly

API LMS-PRO (1.0.0)

Download OpenAPI specification:Download

Suporte da API: suporte@lms-pro.test URL: https://lms-pro.test/suporte

Rotas da API para o LMS-PRO, incluindo autenticação, gerenciamento de usuários, acompanhamentos de campo, caminhos de aprendizado, quizzes, menus e mais.

Autenticação

Endpoints relacionados à autenticação de usuários e gerenciamento de sessões

Login de usuário

Autentica um usuário e retorna um token de portador para requisições subsequentes.

Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "admin@admin.com",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Logout de usuário

Desconecta o usuário atual e invalida a sessão.

Responses

Solicitar validação de email

Envia um email de validação ao usuário para verificação de email.

Authorizations:
bearerAuth
query Parameters
user_id
required
string

ID do usuário para o qual a validação de email será enviada.

Responses

Response samples

Content type
application/json
{
  • "email_sent": true
}

Redefinir senha do usuário

Redefine a senha do usuário usando um token válido.

Request Body schema: application/json
user_id
required
string
password
required
string <password>
token
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "12345",
  • "password": "novaSenha@123",
  • "token": "abcde12345fghij"
}

Response samples

Content type
application/json
{
  • "success": true
}

Solicitação de esqueci a senha

Inicia o processo de redefinição de senha enviando um link de redefinição para o email do usuário.

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "admin@admin.com"
}

Response samples

Content type
application/json
{
  • "email_sent": true
}

Aceitar termos da LGPD

Registra a aceitação dos termos da LGPD (Lei Geral de Proteção de Dados do Brasil) pelo usuário.

Authorizations:
bearerAuth

Responses

Cadastro automático para equipes

Realiza o cadastro automático de equipes na plataforma LMS-PRO.

Authorizations:
bearerAuth

Responses

Cadastro automático para usuários

Realiza o cadastro automático de usuários individuais na plataforma LMS-PRO.

Authorizations:
bearerAuth

Responses

Usuários

Endpoints para gerenciamento de perfis de usuários, notificações e atividades de aprendizado

Obter detalhes do usuário atual

Recupera os detalhes do usuário autenticado atualmente.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "string",
  • "nome": "string"
}

Obter tentativas de caminhos de aprendizado do usuário

Recupera as tentativas de caminhos de aprendizado para um usuário específico.

Authorizations:
bearerAuth
path Parameters
user_id
required
string

O ID do usuário

Responses

Obter notificações do usuário

Recupera todas as notificações do usuário autenticado atualmente.

Authorizations:
bearerAuth

Responses

Marcar todas as notificações como lidas

Marca todas as notificações do usuário atual como lidas.

Authorizations:
bearerAuth

Responses

Marcar uma notificação específica como lida

Marca uma notificação específica como lida para o usuário atual.

Authorizations:
bearerAuth
path Parameters
notification
required
string

O ID da notificação

Responses

Editar perfil do usuário

Atualiza o perfil de um usuário específico.

Authorizations:
bearerAuth
path Parameters
id
required
string

O ID do usuário

Responses

Obter lista de usuários

Recupera uma lista de todos os usuários no sistema.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Cria um novo usuário

Cria um novo usuário.

Request Body schema: application/json
name
required
string
email
required
string <email>
password
required
string <password>
phone
string
personal_document
string
professional_document
string
address
string
uf
string
city
string
generic_field_1
string
generic_field_2
string
generic_field_3
string

Responses

Request samples

Content type
application/json
{
  • "name": "João Silva",
  • "email": "joao@example.com",
  • "password": "12345678",
  • "phone": "(11) 91234-5678",
  • "personal_document": "123.456.789-00",
  • "professional_document": "ABC123456",
  • "address": "Rua Exemplo, 123",
  • "uf": "SP",
  • "city": "São Paulo",
  • "generic_field_1": "string",
  • "generic_field_2": "string",
  • "generic_field_3": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "string",
  • "nome": "string"
}

Obter detalhes do usuário

Recupera os detalhes de um usuário específico pelo seu ID.

Authorizations:
bearerAuth
path Parameters
user
required
string

O ID do usuário

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "string",
  • "nome": "string"
}

Atualizar detalhes do usuário

Atualiza os detalhes de um usuário específico.

Authorizations:
bearerAuth
path Parameters
user
required
string

O ID do usuário

Responses

Obter detalhes de experiência do usuário

Recupera os detalhes de experiência de um usuário específico.

Authorizations:
bearerAuth
path Parameters
user
required
string

O ID do usuário

Responses

Cria um novo detalhe de experiência para o usuário

Criar os detalhes de experiência de um usuário específico.

path Parameters
user
required
integer

ID do usuário

Request Body schema: application/json
user_id
required
integer
experience_amount
required
number
year
required
integer

Responses

Request samples

Content type
application/json
{
  • "user_id": 0,
  • "experience_amount": 0,
  • "year": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "string",
  • "nome": "string"
}

Acompanhamentos de Campo

Endpoints para gerenciamento de acompanhamentos de campo e avaliações

Obter acompanhamentos de campo para um usuário

Recupera os acompanhamentos de campo associados a um usuário específico.

Authorizations:
bearerAuth
path Parameters
user
required
string

O ID do usuário

Responses

Obter detalhes de uma avaliação de campo

Recupera os detalhes de uma avaliação de campo específica.

Authorizations:
bearerAuth
path Parameters
field_rating
required
string

O ID da avaliação de campo

Responses

Reabrir formulário de avaliação (FieldRating)

Reabrir formulário de avaliação.

Authorizations:
bearerAuth
Request Body schema: application/json
field_rating_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "field_rating_id": 42
}

Response samples

Content type
application/json
{
  • "messages": "Formulário reaberto com sucesso"
}

Obter detalhes de um acompanhamento de campo

Recupera os detalhes de um acompanhamento de campo específico.

Authorizations:
bearerAuth
path Parameters
field_followup
required
string

O ID do acompanhamento de campo

Responses

Jogos

Endpoints para gerenciamento de atividades relacionadas a jogos, como jogos Articulate

Armazenar uma tentativa de jogo Articulate

Armazena uma nova tentativa para o jogo Articulate.

Authorizations:
bearerAuth
Request Body schema: application/json

Dados da tentativa de jogo Articulate a serem armazenados.

learning_artifact_id
integer

ID do artefato de aprendizado.

score
number <float>

A pontuação obtida pelo jogador.

game_id
integer

ID do jogo Articulate.

conclusion
boolean

Indica se a tentativa foi concluída.

current_attempt
integer

O número da tentativa atual.

generic_field_1
string

Campo genérico adicional.

generic_field_2
string

Outro campo genérico adicional.

object

Responses

Request samples

Content type
application/json
{
  • "learning_artifact_id": 0,
  • "score": 0,
  • "game_id": 0,
  • "conclusion": true,
  • "current_attempt": 0,
  • "generic_field_1": "string",
  • "generic_field_2": "string",
  • "details": {
    }
}

Response samples

Content type
application/json
{
  • "messages": "Success",
  • "user_name": "admin"
}

Exibir uma tentativa de jogo Articulate

Recupera os detalhes de uma tentativa específica do jogo Articulate.

Authorizations:
bearerAuth
path Parameters
gameId
required
string

O ID do jogo

learningPath
required
string

O ID do caminho de aprendizado (opcional)

Responses

Artefatos de Aprendizado

Endpoints para gerenciamento de artefatos de aprendizado

Obter artefatos de aprendizado

Recupera uma lista de artefatos de aprendizado.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Listar artefatos de aprendizado

Recupera uma lista de todos os artefatos de aprendizado.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Armazenar um novo artefato de aprendizado

Armazena um novo artefato de aprendizado na plataforma.

Authorizations:
bearerAuth
Request Body schema: application/json

Dados do artefato de aprendizado a ser armazenado.

type
string

O tipo do artefato de aprendizado (documento, vídeo, etc.).

title
string

O título do artefato de aprendizado.

description
string

Descrição do artefato de aprendizado.

file
string <binary>

O arquivo do artefato de aprendizado (por exemplo, PDF, vídeo).

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "description": "string",
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "messages": "Success",
  • "learning_artifact_id": 0
}

Exibir um artefato de aprendizado

Recupera os detalhes de um artefato de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_artifact
required
string

O ID do artefato de aprendizado

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "título": "string",
  • "descrição": "string"
}

Atualizar um artefato de aprendizado

Atualiza um artefato de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_artifact
required
string

O ID do artefato de aprendizado

Responses

Caminhos de Aprendizado

Endpoints para gerenciamento de caminhos de aprendizado, grupos e tentativas

Listar grupos de caminhos de aprendizado

Recupera uma lista de todos os grupos de caminhos de aprendizado.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Criar um novo grupo de caminho de aprendizado

Cria um novo grupo de caminho de aprendizado para organizar os caminhos de aprendizado na plataforma.

Authorizations:
bearerAuth
Request Body schema: application/json

Dados necessários para criar um novo grupo de caminho de aprendizado.

name
string

O nome do grupo de caminho de aprendizado.

description
string

Descrição do grupo de caminho de aprendizado.

is_active
boolean

Indica se o grupo de caminho de aprendizado está ativo.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true
}

Response samples

Content type
application/json
{
  • "message": "Success",
  • "learning_path_group_id": 0
}

Armazenar um passo de resultado de um grupo de caminho de aprendizado

Cria um novo passo de resultado para um grupo de caminho de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path_group_result
required
integer

ID do resultado do grupo de caminho de aprendizado ao qual o passo de resultado será associado.

Request Body schema: application/json

Dados necessários para criar um novo passo de resultado para o grupo de caminho de aprendizado.

step_name
string

Nome do passo de resultado.

status
string
Enum: "pending" "completed" "failed"

Status do passo (pendente, concluído, falhou).

details
string

Detalhes adicionais sobre o passo.

Responses

Request samples

Content type
application/json
{
  • "step_name": "string",
  • "status": "pending",
  • "details": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success",
  • "result_step_id": 0
}

Exibir um grupo de caminhos de aprendizado

Recupera os detalhes de um grupo de caminhos de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
string

O ID do grupo de caminhos de aprendizado

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "nome": "string",
  • "descrição": "string"
}

Atualizar um grupo de caminhos de aprendizado

Atualiza um grupo de caminhos de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
string

O ID do grupo de caminhos de aprendizado

Responses

Listar resultados de grupo de caminhos de aprendizado

Recupera uma lista de resultados para um grupo de caminhos de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
string

O ID do grupo de caminhos de aprendizado

Responses

Criar um resultado para um grupo de caminho de aprendizado

Cria um novo resultado para um grupo de caminho de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
integer

ID do grupo de caminho de aprendizado ao qual o resultado será associado.

Request Body schema: application/json

Dados necessários para criar um novo resultado para o grupo de caminho de aprendizado.

status
string
Enum: "pending" "completed" "failed"

Status do resultado (pendente, concluído, falhou).

completion_date
string <date-time>

Data e hora de conclusão do resultado.

details
string

Detalhes adicionais sobre o resultado.

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "completion_date": "2019-08-24T14:15:22Z",
  • "details": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success",
  • "result_id": 0
}

Exibir um resultado de grupo de caminhos de aprendizado

Recupera os detalhes de um resultado específico para um grupo de caminhos de aprendizado.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
string

O ID do grupo de caminhos de aprendizado

results
required
string

O ID do resultado

Responses

Atualizar um resultado de grupo de caminhos de aprendizado

Atualiza um resultado específico para um grupo de caminhos de aprendizado.

Authorizations:
bearerAuth
path Parameters
learning_path_group
required
string

O ID do grupo de caminhos de aprendizado

results
required
string

O ID do resultado

Responses

Listar caminhos de aprendizado

Recupera uma lista de todos os caminhos de aprendizado.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Criar um novo caminho de aprendizado

Cria um novo caminho de aprendizado com os dados fornecidos.

Authorizations:
bearerAuth
Request Body schema: application/json

Dados necessários para criar um novo caminho de aprendizado.

title
string

Título do caminho de aprendizado.

description
string

Descrição do caminho de aprendizado.

cover_path
string

Caminho para a capa do caminho de aprendizado.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "cover_path": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success",
  • "learning_path_id": 0
}

Listar tentativas de caminhos de aprendizado

Recupera uma lista de todas as tentativas de caminhos de aprendizado.

Authorizations:
bearerAuth

Responses

Armazenar uma tentativa de caminho de aprendizado

Armazena uma nova tentativa de caminho de aprendizado.

Authorizations:
bearerAuth

Responses

Exibir uma tentativa de caminho de aprendizado

Recupera os detalhes de uma tentativa específica de caminho de aprendizado.

Authorizations:
bearerAuth
path Parameters
learning_paths_attempt
required
string

O ID da tentativa de caminho de aprendizado

Responses

Atualizar uma tentativa de caminho de aprendizado

Atualiza uma tentativa específica de caminho de aprendizado.

Authorizations:
bearerAuth
path Parameters
learning_paths_attempt
required
string

O ID da tentativa de caminho de aprendizado

Responses

Exibir tentativa de caminho de aprendizado por usuário e caminho

Recupera uma tentativa de caminho de aprendizado para um usuário e caminho específicos.

Authorizations:
bearerAuth
path Parameters
user_id
required
string

O ID do usuário

learning_path_id
required
string

O ID do caminho de aprendizado

Responses

Armazenar um passo de caminho de aprendizado

Armazena um novo passo para um caminho de aprendizado.

Authorizations:
bearerAuth

Responses

Exibir um caminho de aprendizado

Recupera os detalhes de um caminho de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path
required
string

O ID do caminho de aprendizado

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "nome": "string",
  • "descrição": "string"
}

Atualizar um caminho de aprendizado

Atualiza um caminho de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learning_path
required
string

O ID do caminho de aprendizado

Responses

Menus

Endpoints para gerenciamento de menus e itens de menu

Obter informações do menu

Recupera informações sobre um menu específico pelo seu slug.

Authorizations:
bearerAuth
path Parameters
menu_slug
required
string

O slug do menu

Responses

Exibir um item de menu

Recupera os detalhes de um item de menu específico.

Authorizations:
bearerAuth
path Parameters
item_id
required
string

O ID do item de menu

Responses

Obter itens de menu recomendados

Recupera uma lista de itens de menu recomendados.

Authorizations:
bearerAuth

Responses

Listar menus

Recupera uma lista de todos os menus.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Criar um menu

Cria um novo menu.

Authorizations:
bearerAuth
Request Body schema: application/json

Dados necessários para criar um novo menu.

name
string

Nome atribuído ao menu.

created_at
string

Data de criação.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "created_at": "string"
}

Exibir um menu

Recupera os detalhes de um menu específico.

Authorizations:
bearerAuth
path Parameters
menu
required
string

O ID do menu

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "nome": "string"
}

Atualizar um menu

Atualiza um menu específico.

Authorizations:
bearerAuth
path Parameters
menu
required
string

O ID do menu

Responses

Quizzes

Endpoints para gerenciamento de quizzes e resultados de quizzes

Listar quizzes

Recupera uma lista de todos os quizzes.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Criar um quiz

Cria um novo quiz.

Authorizations:
bearerAuth

Responses

Obter próxima chance de tentativa de quiz

Recupera a próxima chance disponível para uma tentativa de quiz.

Authorizations:
bearerAuth

Responses

Exibir um quiz

Recupera os detalhes de um quiz específico.

Authorizations:
bearerAuth
path Parameters
quiz
required
string

O ID do quiz

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "título": "string",
  • "descrição": "string"
}

Atualizar um quiz

Atualiza um quiz específico.

Authorizations:
bearerAuth
path Parameters
quiz
required
string

O ID do quiz

Responses

Listar resultados de quiz

Recupera uma lista de resultados para um quiz específico.

Authorizations:
bearerAuth
path Parameters
quiz
required
string

O ID do quiz

Responses

Armazenar um resultado de quiz

Armazena um novo resultado para um quiz específico.

Authorizations:
bearerAuth
path Parameters
quiz
required
string

O ID do quiz

Responses

Relatórios

Endpoints para geração e acesso a relatórios

Exibir relatório de acesso

Recupera o relatório de acesso para um artefato de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learningArtifact
required
string

O ID do artefato de aprendizado

Responses

Armazenar acesso de relatório

Armazena uma nova entrada de acesso de relatório.

Authorizations:
bearerAuth
Request Body schema: application/json
report_access_id
integer

ID do acesso de relatório (opcional para atualização)

report_accessable_id
required
integer

ID do item acessado (obrigatório)

report_accessable_type
required
string

Tipo do item acessado (obrigatório)

uri
required
string

URI do relatório acessado (obrigatório)

time_spent
required
number <float>

Tempo gasto no relatório (obrigatório)

mark_as_read
boolean

Marca o relatório como lido (opcional)

Responses

Request samples

Content type
application/json
{
  • "report_access_id": 0,
  • "report_accessable_id": 0,
  • "report_accessable_type": "string",
  • "uri": "string",
  • "time_spent": 0,
  • "mark_as_read": true
}

Response samples

Content type
application/json
{
  • "messages": "Registro de acesso gravado com sucesso",
  • "report_access_id": 123
}

Armazenar login de relatório

Registra um novo login de relatório com informações do usuário.

Authorizations:
bearerAuth
Request Body schema: application/json
user_agent
string

Agente do usuário, como o navegador (opcional)

ip
string

IP do usuário (gerado automaticamente pelo backend)

Responses

Request samples

Content type
application/json
{
  • "user_agent": "string",
  • "ip": "string"
}

Response samples

Content type
application/json
{
  • "messages": "Login registrado com sucesso",
  • "user_ip": "192.168.1.1"
}

Diversos

Endpoints diversos para várias funcionalidades como busca, sliders e configurações

Exibir dados SCORM

Recupera dados SCORM para um artefato de aprendizado específico.

Authorizations:
bearerAuth
path Parameters
learningArtifact
required
string

O ID do artefato de aprendizado

Responses

Buscar itens

Busca itens com base em parâmetros de consulta.

Authorizations:
bearerAuth

Responses

Obter banners secundários

Recupera banners secundários para uma posição específica.

Authorizations:
bearerAuth
path Parameters
position
required
string

A posição dos banners secundários

Responses

Obter configurações

Recupera as configurações do sistema.

Authorizations:
bearerAuth

Responses

Listar sliders

Recupera uma lista de todos os sliders.

Authorizations:
bearerAuth

Responses

Exibir um slider

Recupera os detalhes de um slider específico.

Authorizations:
bearerAuth
path Parameters
slider
required
string

O ID do slider

Responses

Armazenar transcrição de artefato de aprendizado

Armazena ou atualiza a transcrição de um artefato de aprendizado.

Authorizations:
bearerAuth
Request Body schema: application/json
learning_artifact_id
required
integer

ID do artefato de aprendizado relacionado.

text
required
string

Texto da transcrição a ser armazenado.

Responses

Request samples

Content type
application/json
{
  • "learning_artifact_id": 0,
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "transcription": { }
}

Enviar sugestão

Envia uma sugestão para o sistema, associada ao usuário autenticado.

Authorizations:
bearerAuth
Request Body schema: application/json
title
required
string

Título da sugestão.

suggestion
required
string

Conteúdo da sugestão.

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "suggestion": "string"
}

Response samples

Content type
application/json
{
  • "message": "Suggestion submitted successfully"
}