Skip to content

MOCK API

MOCK API

Todos os endpoints são expostos via REST e vinculados ao serviço
MOODLE_OFFICIAL_MOBILE_SERVICE.


Endpoint Base

https://hom-moodle.helico.dev/webservice/rest/server.php

Parâmetros obrigatórios

  • wstoken → token do usuário/app
  • moodlewsrestformat → json
  • wsfunction → nome da função

Modelo:

GET /webservice/rest/server.php?wstoken=TOKEN&moodlewsrestformat=json&wsfunction=NOME_DA_FUNCAO


Lista de Funções

Área do Aluno

Função
local_helico_temp_area_do_aluno_get_courses
local_helico_temp_area_do_aluno_get_disciplinas_cards
local_helico_temp_area_do_aluno_get_alerts
local_helico_temp_area_do_aluno_get_metrics
local_helico_temp_area_do_aluno_get_exam_performance
local_helico_temp_area_do_aluno_get_module_performance

Roteiro de Estudos

Função
local_helico_temp_roteiro_de_estudos_get_modulos
local_helico_temp_roteiro_de_estudos_get_subject_tabs_atividades

Flashcards

Função
local_helico_temp_flashcards_get_disciplinas
local_helico_temp_flashcards_get_general_stats
local_helico_temp_flashcards_get_disciplines_stats

Revisão

Função
local_helico_temp_revisao_get_review_data
local_helico_temp_revisao_get_reduced_review_data
local_helico_temp_revisao_get_flashcard_data
local_helico_temp_revisao_get_video_review_data

Exemplo de Chamada

GET https://seumoodle.com/webservice/rest/server.php ?wstoken=TOKEN &moodlewsrestformat=json &wsfunction=local_helico_temp_area_do_aluno_get_courses

Exemplo em JS

async function callMoodle(wsfunction, params = {}) {
  const url = new URL(`https://hom-moodle.helico.dev/webservice/rest/server.php`);
  url.searchParams.set('wstoken', TOKEN);
  url.searchParams.set('moodlewsrestformat', 'json');
  url.searchParams.set('wsfunction', wsfunction);

  Object.entries(params).forEach(([k, v]) =>
    url.searchParams.set(k, String(v))
  );

  const res = await fetch(url);
  return await res.json();
}

// Exemplo
callMoodle('local_helico_temp_area_do_aluno_get_metrics', {});

Erro Padrão Moodle

{
  "exception": "...",
  "errorcode": "...",
  "message": "..."
}

Navigation

Type to search…

↑↓ navigate↵ selectEsc close