Documentação da API

Base URL

https://api-erp.escolamorumbisul.com.br/api/index.php

Use esta URL como base para todas as requisições HTTP.

Autenticação

TOKEN

As requisições a esta API exigem o envio de um token simples.

Envie o token em uma das formas abaixo (escolha apenas uma):

Header HTTP Authorization: Bearer SUA_CHAVE_SECRETA_AQUI
Ou como query param: ?token=SUA_CHAVE_SECRETA_AQUI

Endpoints

GET /index.php/dados

Retorna dados relacionados entre vw_alunos, vw_financeiro e vw_descontos.

curl "https://api-erp.escolamorumbisul.com.br/api/index.php/dados?anoletivo=2025&limit=10&token=SUA_CHAVE_SECRETA_AQUI"

GET /index.php/alunos

Retorna dados diretos da view vw_alunos.

GET /index.php/financeiro

Retorna dados diretos da view vw_financeiro.

GET /index.php/descontos

Retorna dados diretos da view vw_descontos.

Parâmetros comuns

anoletivo: texto, ex. 2025 (todos os semestres de 2025) ou 2025/1 (apenas 1º semestre de 2025).
codcurso: numérico, código interno do curso.
situacao: texto, situação do aluno/financeiro, ex. Ativo, Inativo.
nomealuno: texto, busca parcial (LIKE) por nome do aluno.
prontuario: numérico, identificador do aluno no ERP.
codaluno: numérico, código interno do aluno.
page: numérico, número da página (default: 1).
limit: numérico, registros por página (1 a 1000, default: 100).
fields: texto, lista de campos a retornar separados por vírgula (ex.: nomealuno,emailaluno,valorpago).

Exemplo de uso no n8n

Crie um nó HTTP Request.
Método: GET.
URL: https://api-erp.escolamorumbisul.com.br/api/index.php/dados.
Query params:
- anoletivo = 2025
- limit = 100
- token = SUA_CHAVE_SECRETA_AQUI

Documentação detalhada

Estrutura de resposta

{
  "meta": {
    "page": <número da página>,
    "limit": <registros por página>,
    "total": <total de registros encontrados>
  },
  "data": [
    {
      "aluno": { ... },
      "financeiro": { ... },
      "descontos": { ... }
    }
  ]
}

Campos disponíveis em `aluno` (view vw_alunos)

codunidade, descricaounidade, nomecurso, codcurso, turno, anoletivo, id_turma, descricaoturma
ra, prontuario, nomealuno, nomesocial, codaluno, data_primeira_matricula, ano_letivo_primeira_matricula, nascimentoaluno
emailaluno, telefonealuno
nomerespped, cpfrespped, emailrespped, celularrespped
ceprespped, logradourorespped, numerorespped, complementorespped, bairrorespped, cidaderespped, estadorespped
relacao, codrespped
nomerespfin, cpfrespfin, emailrespfin, codrespfin, celularrespfin
ceprespfin, logradourorespfin, numerorespfin, complementorespfin, bairrorespfin, cidaderespfin, estadorespfin, parentescorespfin
situacao, tipocurso, alunonovo, responsavel_saida

Campos disponíveis em `financeiro` (view vw_financeiro)

codparcela, codunidade_fin, id_turma_fin, anoletivo_fin, prontuario_fin, codaluno_fin
data_matricula, parcela, percentual_desconto_parcela
vencimento1, vencimento2, mes_ref
valor1, valor2, codcurso_fin, valorreal, valordotitulo
linhadigitavel, situacao_fin
valorpago, datapagamento, valor_desconto, valor_desconto2

Campos disponíveis em `descontos` (view vw_descontos)

A view de descontos possui muitos pares descricao_descontoN / valor_descontoN. Alguns exemplos:

descricao_desconto1, valor_desconto1
descricao_desconto2, valor_desconto2
...
descricao_desconto17, valor_desconto17 (acessível também como desconto_17 na API)
descricao_desconto18, valor_desconto18 (acessível também como desconto_18 na API)

Filtragem

anoletivo:
- Se enviar apenas o ano (ex.: 2025), a API retorna todos os registros cujo anoletivo começa com 2025/.
- Se enviar ano e semestre (ex.: 2025/1), a API filtra exatamente por esse valor.
nomealuno: é aplicado como LIKE com wildcard em ambos os lados (%texto%).
situacao: filtro exato na situação acadêmica/financeira.
prontuario e codaluno: filtros exatos por identificadores.

Paginação e limites

page: página inicial é 1.
limit: mínimo 1, máximo 1000. Valores maiores que 1000 são automaticamente reduzidos para 1000.
O campo total em meta mostra quantos registros existem para o filtro aplicado (sem paginação).

Seleção de campos (`fields`)

O parâmetro fields permite limitar quais campos serão retornados na resposta. Apenas nomes listados acima são aceitos; campos inválidos são ignorados.

// Exemplo: apenas alguns campos principais
fields=nomealuno,emailaluno,nomecurso,anoletivo,valorpago,desconto_17

API EduxE - Documentação