### Listar Categorias Ativas (GET /api/categorias) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma lista de todas as categorias ativas com a contagem de questões publicadas em cada uma. Necessita de um token de autenticação válido. ```Shell curl https://api.simuladorapido.com.br/api/categorias \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Listar Questões Publicadas (GET /api/questoes) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma lista paginada de questões publicadas, com opções de filtro por categoria e dificuldade. Permite especificar o número de questões por página e a página desejada. Retorna uma lista de questões com seus detalhes. ```Shell curl 'https://api.simuladorapido.com.br/api/questoes?category_id=1&difficulty=medium&per_page=15&page=1' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Listar Relatórios do Usuário Autenticado (GET /api/v1/issue-reports) Source: https://api.simuladorapido.com.br/workspace/default/scalar Recupera uma lista paginada de relatórios de problemas criados pelo usuário autenticado. Suporta filtragem por status e tipo, além de paginação para gerenciar grandes volumes de dados. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/issue-reports?status=pending&type=bug&page=1' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Listar Prioridades Disponíveis (GET /api/v1/issue-reports/priorities) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma lista de todas as prioridades que podem ser atribuídas a relatórios de problemas. Este endpoint é útil para entender as opções de prioridade disponíveis para a criação de relatórios. ```Shell curl https://api.simuladorapido.com.br/api/v1/issue-reports/priorities ``` -------------------------------- ### Obter Análise de Consistência e Streaks (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma análise detalhada de streaks, frequência de estudos e padrões de consistência do aluno. O endpoint GET requer autenticação e fornece dados como streak atual, melhor streak, total de dias de estudo e um padrão semanal de atividades. ```shell curl https://api.simuladorapido.com.br/api/v1/statistics/streaks \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ```json { "data": { "current_streak": 7, "best_streak": 21, "total_study_days": 89, "streak_history": [ { "start_date": "2024-01-01", "end_date": "2024-01-15", "duration": 15 } ], "weekly_pattern": { "monday": 0.8, "tuesday": 0.9, "wednesday": 0.7, "thursday": 0.85, "friday": 0.6, "saturday": 0.4, "sunday": 0.3 }, "consistency_score": 78.5 } } ``` -------------------------------- ### Iniciar Novo Simulado com Rate Limiting (POST) Source: https://api.simuladorapido.com.br/workspace/default/scalar Cria um novo simulado com questões aleatórias. O acesso é limitado para usuários 'free' (1 simulado a cada 24h). Usuários 'premium/admin/instrutor' têm simulações ilimitadas. Retorna informações sobre o rate limit ou os dados do simulado criado. ```Shell curl https://api.simuladorapido.com.br/api/simulados/start \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "question_count": 20, "categories": [ 1, 2, 3 ], "difficulty": "mixed" }' ``` -------------------------------- ### Upload de Imagem para Conteúdo Markdown Source: https://api.simuladorapido.com.br/workspace/default/scalar Permite o upload de imagens a serem utilizadas em conteúdo markdown de questões. Suporta diversos formatos de imagem (JPG, PNG, GIF, SVG, WebP) com um limite de tamanho de 2MB. ```Shell curl https://api.simuladorapido.com.br/api/upload/markdown-image \ --request POST \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --form 'image=' ``` -------------------------------- ### Upload de Imagem de Capa para Questões Source: https://api.simuladorapido.com.br/workspace/default/scalar Realiza o upload de uma imagem de capa para ser associada a questões. Aceita formatos como JPG, PNG, GIF, SVG, WebP com limite de 2MB. A requisição é do tipo multipart/form-data. ```Shell curl https://api.simuladorapido.com.br/api/upload/cover-image \ --request POST \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --form 'image=' ``` -------------------------------- ### Obter Progresso do Usuário (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna dados abrangentes de progresso do usuário, incluindo histórico de simulados, estatísticas gerais, performance por categoria e análise de dificuldade. Permite incluir histórico detalhado e paginar os resultados. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/user/progress?include_history=true&history_limit=20&history_offset=0' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Resposta de Sucesso - Autenticação Apple (JSON) Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo de resposta JSON para o login bem-sucedido via Apple Sign In, contendo uma mensagem de sucesso, os dados do usuário e um token de autenticação. ```JSON { "message": "Login realizado com sucesso", "user": { "id": 1, "name": "João Silva", "email": "joao@example.com", "role": "aluno", "plan": "free" }, "token": "1|abcdef..." } ``` -------------------------------- ### Estrutura de Resposta JSON para Progresso do Usuário Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo da estrutura JSON retornada pela API ao obter o progresso do usuário. Contém um resumo geral, informações sobre sequências de acertos (streaks), desempenho por categoria, análise de dificuldade e atividades recentes. ```JSON { "progress": { "overview": { "total_simulations": 15, "completed_simulations": 12, "in_progress_simulations": 1, "abandoned_simulations": 2, "total_questions_answered": 300, "total_correct_answers": 240, "total_wrong_answers": 60, "average_score": 78.5, "best_score": 95, "worst_score": 45, "completion_rate": 80 }, "streaks": { "current_streak": 7, "best_streak": 12, "last_simulation_date": "2024-01-15", "days_since_last_simulation": 0, "has_simulation_today": false }, "category_performance": [ { "category_id": 1, "category_name": "Legislação de Trânsito", "total_questions": 50, "correct_answers": 40, "wrong_answers": 10, "accuracy_percentage": 80 } ], "difficulty_analysis": [ { "difficulty": "medium", "total_questions": 80, "correct_answers": 65, "wrong_answers": 15, "accuracy_percentage": 81.3 } ], "recent_activity": { "recent_simulations": [ { "id": 15, "status": "completed", "score": 85, "total_questions": 20, "created_at": "string", "completed_at": null } ], "simulations_last_7_days": 3, "simulations_last_30_days": 12 }, "time_statistics": { "average_duration_minutes": 25.5, "fastest_completion_minutes": 12, "slowest_completion_minutes": 45, "average_time_per_question_seconds": 76.5, "total_study_time_minutes": 510 } }, "history": [ { "id": 1, "status": "completed", "score": 85, "score_percentage": 85, "correct_answers": 17, "wrong_answers": 3, "total_questions": 20, "started_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T11:15:00Z", "duration_minutes": 45, "categories": [ "Legislação de Trânsito" ], "difficulty_filter": "mixed", "selected_categories": [ 1 ] } ], "pagination": { "limit": 20, "offset": 0, "has_more": false, "total": 15 } } ``` -------------------------------- ### Exemplo de Resposta JSON para Estatísticas de Performance Source: https://api.simuladorapido.com.br/workspace/default/scalar Estrutura de resposta JSON para a requisição de estatísticas de performance detalhadas, incluindo linha do tempo, análise por dificuldade e percentil. ```JSON { "data": { "timeline": [ { "date": "2024-01-15", "accuracy": 82.5, "simulations_count": 3 } ], "difficulty_analysis": { "easy": 95.2, "medium": 78.8, "hard": 62.1 }, "percentile": 78.5, "improvement_rate": 12.3 } } ``` -------------------------------- ### Exemplo de Resposta JSON para Atividade Recente Source: https://api.simuladorapido.com.br/workspace/default/scalar Estrutura de resposta JSON para a requisição de atividade recente do aluno, contendo informações sobre simulados e análise de tendências. ```JSON { "data": { "recent_simulations": [ { "id": 123, "score": 85.5, "total_questions": 20, "correct_answers": 17, "completed_at": "2024-01-20T14:30:00Z", "duration_minutes": 18.5, "difficulty_filter": "mixed" } ], "trend_analysis": { "trend": "improving", "change_percentage": 8.5, "last_week_average": 82.3, "current_week_average": 89.1 }, "weekly_summary": { "simulations_this_week": 5, "simulations_last_week": 3, "average_score_this_week": 89.1 } } } ``` -------------------------------- ### Obter Atividade Recente do Aluno (Shell) Source: https://api.simuladorapido.com.br/workspace/default/scalar Recupera os últimos simulados realizados por um aluno, incluindo análise de tendências. Requer um token de autorização e permite especificar um limite para o número de resultados. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/statistics/recent?limit=10' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Upload de Imagem para Placas de Trânsito Source: https://api.simuladorapido.com.br/workspace/default/scalar Faz o upload de imagens de placas de trânsito. O serviço aceita formatos comuns de imagem (JPG, PNG, GIF, SVG, WebP) com um limite de 2MB por arquivo. ```Shell curl https://api.simuladorapido.com.br/upload/placa-image \ --request POST \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --form 'image=' ``` -------------------------------- ### Listar Placas de Trânsito com Filtros Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma lista paginada de placas de trânsito com opções de filtros e formatos de resposta. Permite filtrar por categoria, subcategoria, dificuldade, frequência em provas, tags, busca textual e controlar a quantidade de itens por página. Também é possível obter dados simplificados ou todas as placas em uma única requisição. ```Shell curl 'https://api.simuladorapido.com.br/api/placas?categoria_id=1&subcategoria_id=1&dificuldade=medio&frequencia_prova=alta&tags=1%2C2%2C3&search=pare&per_page=20&simple=false&all=false' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Autenticação com Apple Sign In (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Autentica um usuário usando o token de identidade da Apple e retorna um token de acesso. A requisição é feita via POST para o endpoint /api/v1/auth/apple, aceitando um corpo JSON com o token de identidade, identificador do usuário e, opcionalmente, email e nome. ```Shell curl https://api.simuladorapido.com.br/api/v1/auth/apple \ --request POST \ --header 'Content-Type: application/json' \ --data '{ \ "identity_token": "", \ "user_identifier": "", \ "name": "João Silva", \ "email": "joao@example.com" \ }' ``` -------------------------------- ### Obter Dados do Usuário Autenticado (v2) Source: https://api.simuladorapido.com.br/workspace/default/scalar Recupera os dados do usuário autenticado, incluindo informações adicionais, através da versão 2 da API. Um token de autenticação é obrigatório no cabeçalho 'Authorization'. ```Shell curl https://api.simuladorapido.com.br/api/v2/auth/me \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Exemplo de Resposta JSON - Histórico de Simulados Source: https://api.simuladorapido.com.br/workspace/default/scalar Este é um exemplo da estrutura JSON retornada ao solicitar o histórico de simulados. Ele contém uma lista de simulados com detalhes como ID, contagem de questões, status, pontuação e tempo de duração. ```JSON { "history": [ { "id": 1, "question_count": 20, "status": "completed", "score_percentage": 80, "correct_answers": 16, "total_questions": 20, "started_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T11:15:00Z", "duration_minutes": 45 } ] } ``` -------------------------------- ### Obter Estatísticas por Categoria (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna o desempenho detalhado em cada categoria de questões, com recomendações de estudo. Requer um token de autenticação e permite filtrar por período e número mínimo de questões. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/statistics/categories?period=30d&min_questions=5' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Estrutura de Resposta JSON para Estatísticas por Categoria Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo da estrutura JSON retornada pela API ao obter estatísticas por categoria. Inclui dados de desempenho por categoria e sugestões de áreas para focar ou que o usuário domina. ```JSON { "data": { "categories": [ { "category_id": 1, "category_name": "Legislação de Trânsito", "accuracy": 85.7, "questions_answered": 120, "correct_answers": 103, "improvement_needed": false, "proficiency_level": "advanced" } ], "recommendations": { "focus_categories": [ "Sinalização", "Primeiros Socorros" ], "strong_categories": [ "Legislação de Trânsito", "Direção Defensiva" ] } } } ``` -------------------------------- ### Registrar Novo Usuário (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Cria uma nova conta de usuário no sistema. Requer nome, e-mail, senha e confirmação de senha, além do papel do usuário (aluno, admin, instrutor). ```shell curl https://api.simuladorapido.com.br/api/auth/register \ --request POST \ --header 'Content-Type: application/json' \ --data '{ \ "name": "João Silva", \ "email": "joao@example.com", \ "password": "password123", \ "password_confirmation": "password123", \ "role": "aluno" \ }' ``` -------------------------------- ### Obter Estatísticas de Performance Detalhadas (Shell) Source: https://api.simuladorapido.com.br/workspace/default/scalar Fornece uma análise detalhada do desempenho do aluno, incluindo evolução temporal e comparação com outros alunos. Permite filtrar por período e agrupar os dados por dia, semana ou mês. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/statistics/performance?period=90d&group_by=week' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Atualizar Nome do Usuário (PUT) Source: https://api.simuladorapido.com.br/workspace/default/scalar Atualiza o nome do usuário autenticado e, opcionalmente, os campos de onboarding e dados customizados. Permite modificar o nome principal do usuário e outros detalhes associados. ```shell curl https://api.simuladorapido.com.br/api/v1/auth/update-name \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "name": "João da Silva", \ "isOnboardingCompleted": true, \ "customData": { \ "preferences": { \ "theme": "dark", \ "language": "pt-BR" \ }, \ "profile": { \ "avatar": "avatar-url" \ } \ } \ }' ``` -------------------------------- ### Resposta de Sucesso - Atualizar Senha (JSON) Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo de resposta JSON para a atualização bem-sucedida da senha do usuário, indicando que a senha foi atualizada e todos os tokens de sessão foram invalidados por segurança. ```JSON { "message": "Senha atualizada com sucesso. Todos os tokens foram invalidados por segurança.", "token": "1|abcdef..." } ``` -------------------------------- ### Exemplo de Resposta JSON - Status Atual do Simulado Source: https://api.simuladorapido.com.br/workspace/default/scalar Este JSON ilustra a resposta ao consultar o status de um simulado em andamento. Contém informações sobre o progresso, questão atual, respostas dadas e dados da questão corrente. ```JSON { "simulation": { "id": 1, "question_count": 20, "current_question": 5, "answered_questions": 4, "correct_answers": 3, "status": "in_progress", "started_at": "2024-01-15T10:30:00Z", "completed_at": null, "progress_percentage": 25, "current_question_data": { "id": 15, "statement": "Qual é a velocidade máxima em vias urbanas?", "cover_image": "storage/questions/cover-images/image.jpg", "alternatives": [ { "letter": "A", "text": "60 km/h", "current_response": false } ] } } } ``` -------------------------------- ### Exemplo de Resposta JSON para Estatísticas Gerais Source: https://api.simuladorapido.com.br/workspace/default/scalar Estrutura de resposta JSON para a requisição de estatísticas gerais do aluno, contendo métricas como total de simulados, acurácia geral e streaks. ```JSON { "data": { "total_simulations": 45, "completed_simulations": 42, "abandoned_simulations": 3, "overall_accuracy": 78.5, "current_streak": 7, "best_streak": 21, "average_duration_minutes": 15.7, "total_study_hours": 11.8, "last_simulation_date": "2024-01-20" }, "meta": { "period": "30d", "last_updated": "2024-01-20T15:30:00Z", "cache_expires_at": "2024-01-20T16:30:00Z" } } ``` -------------------------------- ### Obter Status Atual do Simulado (Shell Curl) Source: https://api.simuladorapido.com.br/workspace/default/scalar Este snippet demonstra como consultar o progresso atual de um simulado, incluindo a questão em que o usuário se encontra e estatísticas de desempenho. O ID do simulado é necessário como parâmetro de caminho, e a autenticação é feita com um token. ```Shell curl https://api.simuladorapido.com.br/api/simulados/1/status \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Listar Tipos de Relatórios Disponíveis (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna uma lista de todos os tipos de relatórios que podem ser enviados através da API. A resposta inclui um código de status 200 com os tipos disponíveis em formato JSON. ```shell curl https://api.simuladorapido.com.br/api/v1/issue-reports/types ``` ```json { "success": true, "data": { "bug": "Bug", "feature": "Funcionalidade", "content_error": "Erro de Conteúdo", "other": "Outro" } } ``` -------------------------------- ### Obter Histórico de Simulados (Shell Curl) Source: https://api.simuladorapido.com.br/workspace/default/scalar Este snippet demonstra como obter o histórico de simulados de um usuário autenticado usando o comando curl. Ele inclui um parâmetro de query 'limit' para paginar os resultados e um header de autorização com um token secreto. ```Shell curl 'https://api.simuladorapido.com.br/api/simulados/history?limit=10' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Visualizar Detalhes de Relatório Específico (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Recupera os detalhes completos de um relatório específico do usuário autenticado. O endpoint requer um ID de relatório como parâmetro de caminho e retorna informações como título, descrição, tipo, status e datas de criação/atualização. Respostas de erro incluem 401 (não autorizado) e 404 (não encontrado). ```shell curl https://api.simuladorapido.com.br/api/v1/issue-reports/123 \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ```json { "success": true, "data": { "id": 123, "title": "Login button não funciona", "description": "Quando clico no botão de login, nada acontece e não consigo acessar minha conta.", "type": "bug", "priority": "medium", "status": "reviewing", "url": "https://app.exemplo.com/login", "admin_notes": "Problema identificado no sistema de autenticação. Correção prevista para próxima atualização.", "created_at": "2025-01-15T10:30:00.000000Z", "updated_at": "2025-01-16T14:45:00.000000Z", "resolved_at": null } } ``` -------------------------------- ### Obter Dados Customizados do Usuário Autenticado Source: https://api.simuladorapido.com.br/workspace/default/scalar Recupera informações customizadas (customData) do usuário atualmente autenticado. É necessário fornecer um token de autenticação válido no cabeçalho 'Authorization'. Retorna os dados customizados ou um erro de não autenticado. ```Shell curl https://api.simuladorapido.com.br/api/v1/auth/custom-data \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Estrutura de Resposta da API de Placas Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo da estrutura JSON retornada pela API ao listar placas de trânsito. Inclui detalhes como ID, código técnico, nome, descrição, URL da imagem, cores, legislação, classificação e informações da categoria e subcategoria. ```JSON { "data": [ { "id": 1, "codigo_tecnico": "R-1", "variacao": "A", "nome": "PARE", "descricao": "Placa de parada obrigatória", "aplicacao": "Cruzamentos e intersecções", "imagem_url": "https://exemplo.com/storage/placas/r1.jpg", "cores": { "primaria": "#FF0000", "secundaria": "#FFFFFF" }, "formato": "octogonal", "tem_informacao_complementar": false, "legislacao": { "artigo_ctb": "Art. 214", "tipo_penalidade": "grave", "pontos_cnh": 5, "valor_multa": 195.23 }, "classificacao": { "dificuldade": "medio", "frequencia_prova": "alta" }, "categoria": { "id": 1, "codigo": "REG", "nome": "Regulamentação", "descricao": "Placas que regulamentam o trânsito", "cor_primaria": "#FF0000", "cor_secundaria": "#FFFFFF", "formato_padrao": "circular" }, "subcategoria": { "id": 1, "codigo": "VEL", "nome": "Velocidade", "descricao": "Placas de regulamentação de velocidade" }, "tags": [ { "id": 1, "nome": "Velocidade", "slug": "velocidade", "tipo": "regulamentacao", "descricao": "Placas relacionadas a velocidade" } ], "ordem_exibicao": 100, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } ], "current_page": 1, "last_page": 5, "per_page": 20, "total": 95 } ``` -------------------------------- ### Solicitar Redefinição de Senha (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Envia um e-mail com um link de redefinição de senha para o usuário especificado. Requer apenas o e-mail do usuário no corpo da requisição. ```shell curl https://api.simuladorapido.com.br/api/v1/auth/forgot-password \ --request POST \ --header 'Content-Type: application/json' \ --data '{ \ "email": "usuario@exemplo.com" \ }' ``` -------------------------------- ### Obter Dados do Usuário Autenticado (v1) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna os dados do usuário autenticado, incluindo informações sobre rate limiting para simulações. Requer um token de autenticação no cabeçalho 'Authorization'. O endpoint é a versão 1 da API. ```Shell curl https://api.simuladorapido.com.br/api/v1/auth/me \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Obter Estatísticas Gerais do Aluno (Shell) Source: https://api.simuladorapido.com.br/workspace/default/scalar Retorna estatísticas gerais do aluno logado, como total de simulados, média de acertos e streaks. Os dados podem ser filtrados por um período específico. ```Shell curl 'https://api.simuladorapido.com.br/api/v1/statistics/overview?period=30d' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Login de Usuário com Credenciais Source: https://api.simuladorapido.com.br/workspace/default/scalar Autentica um usuário na API fornecendo email e senha. Retorna um token de acesso em caso de sucesso ou uma mensagem de credenciais inválidas. Requer o envio de um corpo JSON com as credenciais. ```Shell curl https://api.simuladorapido.com.br/api/auth/login \ --request POST \ --header 'Content-Type: application/json' \ --data '{ \ "email": "admin@cnhsimulado.com", \ "password": "admin123" \ }' ``` -------------------------------- ### Atualizar Senha do Usuário (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Atualiza a senha do usuário autenticado com validação de segurança avançada. Requer a senha atual e aplica políticas rigorosas de senha. A requisição é feita via PUT para o endpoint /api/v1/auth/update-password. ```Shell curl https://api.simuladorapido.com.br/api/v1/auth/update-password \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "current_password": "currentPassword123!", \ "password": "NewSecurePassword123!", \ "password_confirmation": "NewSecurePassword123!" \ }' ``` -------------------------------- ### Redefinir Senha de Usuário (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Redefine a senha de um usuário utilizando um token de redefinição enviado por e-mail. Requer o token, e-mail, nova senha e confirmação da senha no corpo da requisição. ```shell curl https://api.simuladorapido.com.br/api/v1/auth/reset-password \ --request POST \ --header 'Content-Type: application/json' \ --data '{ \ "token": "abc123...", \ "email": "usuario@exemplo.com", \ "password": "NovaSenha123!", \ "password_confirmation": "NovaSenha123!" \ }' ``` -------------------------------- ### Resposta de Limpeza de Cache (JSON) Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo de resposta JSON indicando o sucesso da limpeza do cache de enriquecimento, com detalhes sobre a mensagem e o template afetado. ```json { "success": true, "message": "Cache cleared successfully", "template": "category_description" } ``` -------------------------------- ### Exemplo de Resposta JSON - Resultado Final do Simulado Source: https://api.simuladorapido.com.br/workspace/default/scalar Este JSON exemplifica a resposta ao obter o resultado detalhado de um simulado. Inclui estatísticas gerais, respostas selecionadas e corretas, explicações e estatísticas por categoria. ```JSON { "results": { "simulation_id": 1, "total_questions": 20, "correct_answers": 16, "wrong_answers": 4, "score_percentage": 80, "status": "completed", "started_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T11:15:00Z", "duration_minutes": 45, "questions": [ { "question_id": 15, "statement": "Qual é a velocidade máxima em vias urbanas?", "selected_answer": "A", "correct_answer": "A", "is_correct": true, "explanation": "De acordo com o CTB, a velocidade máxima em vias urbanas é 60 km/h" } ], "category_stats": [ { "category_name": "Legislação de Trânsito", "total_questions": 8, "correct_answers": 6, "accuracy_percentage": 75 } ] } } ``` -------------------------------- ### Alterar Status do Simulado para Abandonado (PATCH) Source: https://api.simuladorapido.com.br/workspace/default/scalar Permite alterar o status de um simulado existente para 'abandoned'. Requer o ID do simulado nos parâmetros de URL e o novo status no corpo da requisição. Somente transições seguras são permitidas. ```Shell curl https://api.simuladorapido.com.br/api/simulados/1/status \ --request PATCH \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "status": "abandoned" }' ``` -------------------------------- ### Criar Relatório de Problema (POST /api/v1/issue-reports) Source: https://api.simuladorapido.com.br/workspace/default/scalar Permite que usuários autenticados criem relatórios de problemas, bugs ou sugestões. O relatório é associado ao usuário logado e inclui proteção contra spam e rate limiting. Requer autenticação e um corpo JSON com detalhes do problema. ```Shell curl https://api.simuladorapido.com.br/api/v1/issue-reports \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "title": "Erro ao fazer login", \ "description": "Quando tento fazer login com minha conta, recebo uma mensagem de erro 500", \ "type": "bug", \ "priority": "medium", \ "url": "https://exemplo.com/login", \ "browser_info": { \ "user_agent": "Mozilla/5.0...", \ "screen_resolution": "1920x1080", \ "viewport": "1366x768" \ }, \ "metadata": null \ }' ``` -------------------------------- ### Resposta JSON da Placa (200 OK) Source: https://api.simuladorapido.com.br/workspace/default/scalar Estrutura JSON de resposta bem-sucedida (código 200) ao solicitar os dados de uma placa específica. Contém informações detalhadas sobre a placa, como código, descrição, imagem, legislação e classificação. ```JSON { "data": { "id": 1, "codigo_tecnico": "R-1", "variacao": "A", "nome": "PARE", "descricao": "Placa de parada obrigatória", "aplicacao": "Cruzamentos e intersecções", "imagem_url": "https://exemplo.com/storage/placas/r1.jpg", "cores": { "primaria": "#FF0000", "secundaria": "#FFFFFF" }, "formato": "octogonal", "tem_informacao_complementar": false, "legislacao": { "artigo_ctb": "Art. 214", "tipo_penalidade": "grave", "pontos_cnh": 5, "valor_multa": 195.23 }, "classificacao": { "dificuldade": "medio", "frequencia_prova": "alta" }, "categoria": { "id": 1, "codigo": "REG", "nome": "Regulamentação", "descricao": "Placas que regulamentam o trânsito", "cor_primaria": "#FF0000", "cor_secundaria": "#FFFFFF", "formato_padrao": "circular" }, "subcategoria": { "id": 1, "codigo": "VEL", "nome": "Velocidade", "descricao": "Placas de regulamentação de velocidade" }, "tags": [ { "id": 1, "nome": "Velocidade", "slug": "velocidade", "tipo": "regulamentacao", "descricao": "Placas relacionadas a velocidade" } ], "ordem_exibicao": 100, "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-15T10:30:00Z" } } ``` -------------------------------- ### Obter Resultado Final do Simulado (Shell Curl) Source: https://api.simuladorapido.com.br/workspace/default/scalar Este snippet mostra como recuperar o resultado completo de um simulado finalizado, incluindo todas as respostas e estatísticas. O endpoint requer o ID do simulado como parâmetro de caminho e autenticação via token. ```Shell curl https://api.simuladorapido.com.br/api/simulados/1/gabarito \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Obter Placa Específica (Shell cURL) Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo de requisição utilizando cURL para obter os dados completos de uma placa específica através da API. A requisição inclui o ID da placa e um parâmetro opcional para dados simplificados, além de um cabeçalho de autorização. ```Shell curl 'https://api.simuladorapido.com.br/api/placas/1?simple=false' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Resposta de Sucesso - Deletar Conta (JSON) Source: https://api.simuladorapido.com.br/workspace/default/scalar Exemplo de resposta JSON indicando que a conta do usuário foi deletada com sucesso e todos os dados associados foram removidos permanentemente. ```JSON { "message": "Conta deletada com sucesso. Todos os dados foram removidos permanentemente." } ``` -------------------------------- ### Limpar Cache de Enriquecimento (Shell) Source: https://api.simuladorapido.com.br/workspace/default/scalar Limpa o cache de respostas para todos os templates de enriquecimento ou para um template específico. Requer um token de autenticação. ```Shell curl 'https://api.simuladorapido.com.br/api/prompts/cache?template=category_description' \ --request DELETE \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Atualizar Dados Customizados do Usuário (PUT) Source: https://api.simuladorapido.com.br/workspace/default/scalar Atualiza os dados customizados (customData) do usuário autenticado. O campo customData é um objeto JSON dinâmico que pode armazenar qualquer estrutura de dados, como preferências, perfil e configurações. ```shell curl https://api.simuladorapido.com.br/api/v1/auth/update-custom-data \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "customData": { \ "preferences": { \ "theme": "dark", \ "language": "pt-BR", \ "notifications": true \ }, \ "profile": { \ "avatar": "https://example.com/avatar.jpg", \ "bio": "Estudante de trânsito" \ }, \ "settings": { \ "autoSave": true, \ "soundEnabled": false \ }, \ "progress": { \ "simulationsCompleted": 25, \ "favoriteCategories": [ \ "1", \ "3", \ "5" \ ] \ } \ } \ }' ``` -------------------------------- ### Registrar Resposta de Questão (POST /api/simulados/{id}/answer) Source: https://api.simuladorapido.com.br/workspace/default/scalar Submete a resposta selecionada para uma questão específica do simulado. Aceita o ID do simulado, ID da questão e a resposta (letra ou texto completo). Retorna o status do registro e detalhes do resultado. ```Shell curl https://api.simuladorapido.com.br/api/simulados/1/answer \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "question_id": 15, \ "selected_letter": "A", \ "selected_answer": "60 km/h" \ }' ``` -------------------------------- ### Logout de Usuário e Invalidação de Token Source: https://api.simuladorapido.com.br/workspace/default/scalar Invalida todos os tokens associados a um usuário autenticado. Requer um token de autenticação no cabeçalho 'Authorization'. Retorna uma mensagem de sucesso ou um erro de não autenticado. ```Shell curl https://api.simuladorapido.com.br/api/auth/logout \ --request POST \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Deletar Simulado Específico (DELETE) Source: https://api.simuladorapido.com.br/workspace/default/scalar Remove um simulado específico do usuário autenticado. Requer o ID do simulado nos parâmetros de URL. Retorna uma mensagem de sucesso ou erros de acesso negado/simulado não encontrado. ```Shell curl https://api.simuladorapido.com.br/api/simulados/1 \ --request DELETE \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` -------------------------------- ### Deletar Imagem via API Source: https://api.simuladorapido.com.br/workspace/default/scalar Remove uma imagem específica do sistema utilizando o caminho do arquivo. Requer autenticação e o caminho da imagem no corpo da requisição JSON. ```Shell curl https://api.simuladorapido.com.br/api/upload/image \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ "path": "questions/markdown-images/1755123456_abc123def.jpg" }' ``` -------------------------------- ### Limpar Cache de Estatísticas (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Remove o cache de estatísticas do usuário logado para forçar um recálculo na próxima consulta. Este endpoint DELETE retorna uma mensagem de sucesso (código 200) ou um erro de autorização (código 401). ```shell curl https://api.simuladorapido.com.br/api/v1/statistics/cache \ --request DELETE \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' ``` ```json { "message": "Cache de estatísticas limpo com sucesso", "cleared_at": "2024-01-20T15:30:00Z" } ``` -------------------------------- ### Deletar Conta do Usuário (API) Source: https://api.simuladorapido.com.br/workspace/default/scalar Deleta permanentemente a conta do usuário autenticado e todos os dados associados. Requer a confirmação da senha atual. A operação é realizada via DELETE no endpoint /api/v1/auth/delete-account. ```Shell curl https://api.simuladorapido.com.br/api/v1/auth/delete-account \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \ --data '{ \ "password": "password123" \ }' ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.