1. API de Integração
  2. Métodos para integração mobile (genérico)
Mobile - Alteração da senha de acesso

Permite alterar a senha de acesso do aluno ao aplicativo mobile e portal do aluno
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID Perfil
senhaAtual Sim java.lang.String Senha Atual
senhaNova Sim java.lang.String Senha Nova
senhaConfirmacao Sim java.lang.String Senha Nova Confirmação
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/senha/alterar
Mobile - Recuperar senha de acesso

Envia um e-mail com a senha atual do aluno.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
raAluno Sim java.lang.String RA do Aluno
cpf Sim java.lang.String CPF do Aluno/Responsável
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/senha/recuperar
Mobile - Avatar do perfil

Retorna a imagem do perfil que foi cadastrada no sistema acadêmico.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID do Perfil

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/perfil/avatar
http://187.60.217.18:8080/academico/api/mobile/perfil/avatar
Mobile - Autenticação de Usuários

Efetua o login de um usuário através do seu RA e/ou E-mail e senha informados.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
login Sim java.lang.String Login (RA/E-Mail)
password Sim java.lang.String Senha
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/autenticar

Formato do objeto de retorno

{
  "idPerfil (Integer)": null,
  "nome (String)": null,
  "email (String)": null,
  "celular (String)": null,
  "fone (String)": null,
  "sexo (String)": null,
  "avatar (String)": null,
  "ra (String)": null,
  "idAluno (Integer)": null,
  "tipoAcesso (String)": null,
  "alunos (ArrayList)": []
}
Mobile - Visualiza Feed

Lista o feed de avisos do aluno.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID perfil
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/feed

Formato do objeto de retorno

{
  "id (Integer)": null,
  "user_id (Integer)": null,
  "user_name (String)": null,
  "user_picture (String)": null,
  "documents (ArrayList)": [],
  "created_at (Long)": null,
  "text (String)": null
}
Mobile - Calendário Acadêmico

Lista todo o calendário acadêmico da instituição onde o aluno está atualmente (organização)
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idAluno Sim java.lang.Integer ID Aluno
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/calendario

Formato do objeto de retorno

{
  "idLegenda (Integer)": null,
  "descricao (String)": null,
  "dataInicio (Timestamp)": null,
  "dataFim (Timestamp)": null,
  "cor (String)": null,
  "feriado (Integer)": null,
  "unixDataInicio (Long)": null,
  "unixDataFim (Long)": null
}
Mobile - Listar Transações

Lista as transações do aluno.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID do perfil responsável das transacações
isSomenteAbertos Não boolean Valida quais transações exibir
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/financeiro

Formato do objeto de retorno

{
  "idTransacao (Integer)": null,
  "status (String)": null,
  "situacao (String)": null,
  "origem (String)": null,
  "idPagador (Integer)": null,
  "idResponsavel (Integer)": null,
  "idReferencia (Integer)": null,
  "tipoReferencia (String)": null,
  "dataEmissao (Date)": null,
  "dataVencimento (Date)": null,
  "dataCompetencia (Date)": null,
  "unixDataEmissao (Long)": null,
  "unixDataVencimento (Long)": null,
  "unixDataCompetencia (Long)": null,
  "valor (Double)": null,
  "valorOriginal (Double)": null,
  "numeroParcela (String)": null,
  "idBoleto (Integer)": null,
  "_boletoNossoNumero (String)": null,
  "_boletoDigitoVerificador (String)": null,
  "_boletoLiberadoWeb (Integer)": null,
  "_boletoDataVencimento (Date)": null,
  "unixBoletoDataVencimento (Long)": null
}
Mobile - Visualizar a linha digitável do boleto

Exibe a linha digitável do Boleto.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idTransacao Sim java.lang.Integer ID Transação
idBoleto Sim java.lang.Integer ID Boleto
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/financeiro/boleto/linha-digitavel

Formato do objeto de retorno

{
  "idBoleto (Integer)": null,
  "idMetodoRecebimento (Integer)": null,
  "idAgenciaConta (Integer)": null,
  "idBoletoRateio (Integer)": null,
  "nossoNumero (String)": null,
  "digitoVerificador (String)": null,
  "dataVencimento (Date)": null,
  "dataEmissao (Date)": null,
  "valorBoleto (Double)": null,
  "liberadoWeb (Integer)": null,
  "_liberacaoImpressaoWeb (Integer)": null,
  "status (String)": null,
  "dataRemessa (Date)": null,
  "arquivoRemessa (String)": null,
  "idPagador (Integer)": null,
  "_pagador (String)": null,
  "_email (String)": null,
  "_metodoRecebimento (String)": null,
  "_cedente (String)": null,
  "_carteira (String)": null,
  "_codigoCedente (String)": null,
  "_numeroAgencia (String)": null,
  "_idTipoRecebimentoCedente (Integer)": null,
  "_valor_atualizado (Double)": null,
  "dataLiquidacao (Date)": null,
  "dataRecebimento (Date)": null,
  "valorDescontos (Double)": null,
  "valorJuros (Double)": null,
  "valorMulta (Double)": null,
  "valorRecebido (Double)": null,
  "observacaoRetorno (String)": null,
  "dataProcessamentoBanco (Date)": null,
  "motivoOcorrencia (String)": null,
  "codigoBarras (String)": null,
  "linhaDigitavel (String)": null,
  "_bancoNumero (String)": null,
  "idTransacaoRecebimentoBoleto (Integer)": null,
  "boletosDuplicados (ArrayList)": null,
  "_usuarioCancelamento (String)": null,
  "_organizacao (String)": null,
  "valorPagoAMaior (boolean)": false,
  "isAssessoriaCobranca (Integer)": null,
  "rateiosConta (ArrayList)": null,
  "rateiosRetorno (ArrayList)": null,
  "_situacaoTransacao (String)": null,
  "valorBaixado (Double)": null,
  "inconsistenciaBaixa (boolean)": false,
  "_isScpcSerasa (Integer)": null,
  "quantidadeRenovacoes (Integer)": null,
  "_idBoletoGateway (Integer)": null,
  "_utilizarConfigMetodoRecebimento (Integer)": null,
  "_statusBoletoRegistroGateway (String)": null,
  "idBoletoArquivo (Integer)": null,
  "_boletoArquivo (String)": null,
  "id_org (Integer)": null
}
Mobile - Visualizar a linha digitável do boleto

Exibe a linha digitável do Boleto.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idBoleto Sim java.lang.Integer ID Boleto
idPerfil Sim java.lang.Integer ID Perfil do aluno
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/financeiro/boleto/envio/email
Mobile - Download Boleto

Permite o download de um boleto no formato PDF.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idTransacao Sim java.lang.Integer ID Transação
idBoleto Sim java.lang.Integer ID Boleto
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/financeiro/boleto/download
Mobile - Consulta de notas do aluno

Lista todas as disciplinas ativas (disciplina, professor, nota, status, etc.) de um determinado aluno
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idAluno Sim java.lang.Integer ID Aluno
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/notas

Formato do objeto de retorno

{
  "idMatricula (Integer)": null,
  "idMatriculaDisciplina (Integer)": null,
  "idDisciplinaProfessor (Integer)": null,
  "idTurma (Integer)": null,
  "disciplina (String)": null,
  "periodo (String)": null,
  "turma (String)": null,
  "periodoLetivo (String)": null,
  "professor (String)": null,
  "notaFinal (Double)": null,
  "notaExame (Double)": null,
  "frequencia (Double)": null,
  "quantidadeAulas (Integer)": null,
  "status (String)": null,
  "statusLegivel (String)": null,
  "statusCor (String)": null
}
Mobile - Lista de Avaliações da disciplina do aluno

Lista todas as avaliações de uma disciplina do aluno
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idAluno Sim java.lang.Integer ID Aluno
idMatriculaDisciplina Sim java.lang.Integer ID da Matrícula Disciplina
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/notas/avaliacoes

Formato do objeto de retorno

{
  "idMatriculaDisciplina (Integer)": null,
  "frequencia (Double)": null,
  "avaliacao (String)": null,
  "identificacao (String)": null,
  "nota_para_apresentar (String)": null,
  "notaFinal (Double)": null,
  "statusDescricao (String)": null,
  "statusLegivel (String)": null,
  "quantFaltas (Integer)": null,
  "disciplina (String)": null,
  "dataAvaliacao (Date)": null,
  "dataVisualizacaoNota (Date)": null,
  "unixDataAvaliacao (Long)": null,
  "unixDataVisualizacaoNota (Long)": null,
  "id_org (Integer)": null
}
Mobile - Lista de Alunos do Responsável

Lista os alunos do responsável.
Método: POST
Resposta: JSON/XML

Parâmetro Obrigatório Tipo Descrição
idPerfil Sim java.lang.Integer ID perfil responsável
format Sim java.lang.String Formato do retorno (JSON/XML)

URIs de acesso

http://187.60.217.18:8080/academico/api/mobile/alunos

Formato do objeto de retorno

{
  "idPerfil (Integer)": null,
  "nome (String)": null,
  "email (String)": null,
  "celular (String)": null,
  "fone (String)": null,
  "sexo (String)": null,
  "avatar (String)": null,
  "ra (String)": null,
  "idAluno (Integer)": null,
  "tipoAcesso (String)": null,
  "alunos (ArrayList)": []
}