API de Integração

Esta é a documentação de referência da API de Integração do SWA.JACAD com outros sistemas. Todos os métodos estão disponíveis exclusivamente sobre o protocolo HTTP e utilizam o modelo de API REST, e pode ser facilmente integrado com sistemas de suportam comunicações através de requisições HTTP e consumo de respostas nos formatos JSON e XML. Para garantir total segurança nos dados trafegados pela API de Integração, certifique-se de sempre realizar as requisições através de HTTPS na porta 8443.
Para testar os métodos você pode utilizar ferramentas como o Postman, e, também ter liberadas as permissões dos métodos no SWA.JACAD da instituição.


Origens liberadas

Estas são as origens (IPs ou domínios) atualmente liberadas para acessar os serviços da API de Integração do SWA.JACAD.

Descrição Origem
SWA Sistemas IP: 182.224.40.25 182.224.40.25
SWA Sistemas IP: 182.224.40.26 182.224.40.26
SWA Sistemas IP: 182.224.40.27 182.224.40.27
SWA Sistemas IP: 182.224.40.28 182.224.40.28
SWA Sistemas IP: 182.224.40.29 182.224.40.29
SWA Sistemas IP: 182.224.40.30 182.224.40.30
SWA Sistemas IP: 186.224.38.7 186.224.38.7

Métodos

Lista todos os Cursos Base cadastrados na instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.curso.base

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/cursos-base/

Lista todas as disciplinas ministradas pelos professores de períodos letivos ativos da instituição combinada com diversos filtros.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.disciplina.professor

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idTurma Não java.lang.Integer Código da Turma
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
idCurso Não java.lang.Integer Código da Matriz Curricular (Curso)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/turmas/disciplinas/

Lista todas as matrizes cadastradas na instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.curso.matriz

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idGrauGraduacao Não java.lang.Integer Código do Grau de Graduação
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/matrizes/

Lista todos os Períodos Letivos da instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.periodo.letivo

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
status Não java.lang.String Status do período (ABERTO,CANCELADO,ENCERRADO)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/periodos-letivos/

Retorna todos os sistemas de Avaliação vigentes.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.sistema.avaliacao

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da Organização
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/sistemas-de-avaliacao/

Lista todas as Turmas da instituição ou de uma organização específica.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.turma

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
status Não java.lang.String Status da turma (AGUARDANDO, ATIVA, CANCELADA, ENCERRADA)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/turmas/

Lista todos os cursos ingressos dos alunos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.curso.ingresso

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código do Organização
idAluno Não java.lang.Integer Código do Aluno
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do curso ingresso
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do curso ingresso
nomeAluno Não java.lang.String Nome do aluno (será aplicado em um comando 'LIKE'
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/cursos-ingressos/listar/

Lista todos os alunos da instituição com diversos filtros. Caso não seja informado nenhum filtro, a consulta irá retornar apenas os primeiros 1000 registros.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.aluno

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
tipo Sim java.lang.String Tipo do resultado da busca:
-BASICA: somente os dados básicos do aluno;
-COMPLETA:todos os dados do aluno;
idOrg Não java.lang.Integer Código do Organização
filtrarPor Não java.lang.String Flag do campo de referência para a consulta (CPF, RA, NOME ou ID_ALUNO)
termo Não java.lang.String Conteúdo para a busca
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do aluno
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do aluno
isSomenteComCursoIngressoAtivo Não boolean Somente alunos que possuem um Curso Ingresso ativo
isSomenteComMatriculaAtiva Não boolean Somente alunos que possuem um Matrícula ativa
idPeriodoLetivo Não java.lang.Integer Que tenha uma matrícula no Período Letivo
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/

Lista todos os Centros de Custos ativos na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.centro.custo

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/centros-de-custos/

Lista todas as contas bancárias ativas da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.agencia.conta

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/contas-bancarias/

Lista todas as Cores/Raças cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.cor.raca

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/cores-racas/

Lista todas as formas de conhecimento cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.forma.conhecimento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/formas-conhecimento/

Lista todos os graus de graduação cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.grau.graduacao

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/graus-de-graduacao/

Lista todos os métodos de recebimento/cedente ativos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.metodo.recebimento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/metodos-de-recebimento/

Lista todas as Nacionalidades cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.nacionalidade

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/nacionalidades/

Lista todas as Necessidades Especiais cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.necessidade.especial

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/necessidades-especiais/

Lista todas as organizações (Org) da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.org

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/organizacoes/

Lista todos os planos de contas ativos da instituição podendo ser filtrado pelo tipo de operação.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.plano.conta

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
operacao Sim java.lang.String Tipo do plano (SOMA/SUBTRAI)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/planos-de-contas/

Lista todos os planos de pagamento ativos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.plano.pagamento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/planos-de-pagamento/

Lista todas as Profissões cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.profissao

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/profissoes/

Lista todos os Tipos de Processos Seletivos cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.tipo.processo.seletivo

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/tipos-de-processo-seletivo/

Lista todos os tipos de recebimento/pagamento disponíveis na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.tipo.recebimento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
tipoRecebimento Sim java.lang.String Tipo do recebimento/pagamento (DINHEIRO, CHEQUE, CARTAO)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/tipos-de-recebimento/

Lista todas as Unidades Físicas ativas da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.unidade.fisica

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/unidades-fisicas/

Lista todos os eventos da instituição podendo também filtrá-los por status.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.eventos

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
status Não java.lang.String Status do Evento (AGUARDANDO, ATIVO, CANCELADO, ENCERRADO)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/eventos/

Lista todos os perfis dos palestrantes da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.eventos

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/eventos/palestrantes/

Lista toda a programação dos eventos da instituição ou de um evento em específico.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.eventos

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idEvento Sim java.lang.Integer Código do Evento
tipo Não java.lang.String Tipo da atividade (PALESTRA, MINICURSO, WORKSHOP, AULA_MAGNA, SEMINARIO, DEBATE, POS_GRADUACAO)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/eventos/programacao/

Cancela um determinado conta a receber informado.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.cancelar.conta.receber

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idTransacao Sim java.lang.Integer Código da transação
motivo Sim java.lang.String Motivo do cancelamento
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/contas-receber/cancelar/

Permite consultar todas as contas a receber da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.conta.receber

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
dataInicio Sim java.sql.Date Vencimentos de
dataFim Sim java.sql.Date até da data
idTransacao Não java.lang.Integer Código da transação
idPerfil Não java.lang.Integer Código do perfil do pagador
idOrg Não java.lang.Integer Código da organização
situacao Não java.lang.String Situação da transação (PARCIAL, ABERTO, PAGO,BAIXADA,ACORDADO)
status Não java.lang.String Status da transação (ATIVO, INATIVO, CANCELADO, ACORDO)
isSomenteConsolidada Não boolean Somente consolidadas
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/conta-receber/

Lista todos os recebimentos efetuados na instituição ou numa organização específica combinado com vários filtros.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.recebimento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
dataPagamentoInicio Não java.sql.Date Data de início dos pagamentos
dataPagamentoFim Não java.sql.Date Data limite dos pagamentos
idAgenciaConta Não java.lang.Integer Conta em que foram efetuados os recebimentos
idTipoRecebimento Não java.lang.Integer Tipo do recebimento
idTransacao Não java.lang.Integer Código da transação
idPerfil Não java.lang.Integer Código do perfil do pagador
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/listar-recebimentos/

Permite criar um registro de conta a receber no sistema acadêmico com base nos parâmetros informados. Irá retornar todas as transações que foram criadas.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.cadastro.conta.receber

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Sim java.lang.Integer Código da Organização
idPerfil Sim java.lang.Integer Código do Perfil
descricao Sim java.lang.String Descrição da conta a receber
valor Sim java.lang.Double Valor da conta a receber (deve ser maior que zero)
dataVencimento Sim java.sql.Date Data de vencimento da conta a receber
idPlanoConta Sim java.lang.Integer Código do Plano de Contas da conta a receber
idCentroCusto Sim java.lang.Integer Código do Centro de Custo da conta a receber
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/criar-conta-receber

Permite imprimir a NFS-e que foi previamente autorizada através do ManagerSaas.
Método: POST
Resposta: application/pdf
Permissão: api.integracao.habilitar.impressao.nfse

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML) para as mensagens de erro (caso houver)
idTransacao Sim java.lang.Integer Código de uma transação que possua uma NFS-e
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/transacoes/nfse/

Permite imprimir um boleto bancário de uma transação ABERTA no formato PDF.
Método: POST
Resposta: application/pdf
Permissão: api.integracao.habilitar.impressao.boleto.bancario

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML) para as mensagens de erro (caso houver)
idTransacao Sim java.lang.Integer Código de uma transação ativa
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/boleto/imprimir/

Este método irá criar um novo boleto para uma transaçao informada. Este boleto irá respeitar o valor da transação em questão e irá utilizar o Nosso Número informado por um sistema terceiro.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.cadastro.registrar.boleto

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
nossoNumero Sim java.lang.String Nosso número gerado por um sistema terceiro
digitoVerificador Não java.lang.String Dígito verificador informado por um sistema terceiro
idTransacao Sim java.lang.Integer Código da transação para registro do boleto
idMetodoRecebimento Sim java.lang.Integer Código do Método Recebimento/Cedente
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/boleto/registrar/

Este método permite que sistema externos registrem pagamentos no SWA.JACAD. Para que tenha sucesso, deverão ser informados todos os parâmetros listados abaixo.
Este método retorna um objeto contendo as informações do recebimento no SWA.JACAD.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.cadastro.registrar.pagamento

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idTransacao Sim java.lang.Integer Código da transação para o registro do recebimento
idAgenciaConta Sim java.lang.Integer Código da Conta para o registro do recebimento
idTipoRecebimento Sim java.lang.Integer Código do Tipo de Recebimento para o registro do recebimento
idBoleto Não java.lang.Integer Código do Boleto Bancário (opcional) para o registro do recebimento
valorPago Sim java.lang.Double Valor pago para o registro do recebimento
valorEncargos Sim java.lang.Double Valor de encargos
valorDescontos Sim java.lang.Double Valor de descontos concedidos
dataPagamento Sim java.sql.Date Data do pagamento
dataLiquidacao Não java.sql.Date Data de liquidação (opcional)
observacao Sim java.lang.String Alguma observação para o registro do recebimento
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/financeiro/registrar-pagamento/

Este método retorna todos os alunos, funcionários e professores ATIVOS na instituição neste momento que tenham login e senha preenchidos em seu perfil.
Este método trará somente alunos com matrícula ATIVA num período letivo ABERTO, professores que estejam lecionando numa turma ATIVA num período letivo ABERTO e funcionários que não sejam professores e que tenham o seu status com ATIVO.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.pessoas.ativas

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/integracoes/wifi/ativos

Lista todas as cidades cadastradas na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.locais

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
uf Não java.lang.String Sigla do Estado
nomeCidade Não java.lang.String Nome da Cidade (será aplicado numa instrução de LIKE)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/cidades/

Lista todos os estados cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.locais

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/estados/

Lista todos os países cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.locais

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/paises/

Submete os dados de autentição ao portal do aluno redirecionando para página inicial caso a autenticação seja realizada com sucesso.
Método: POST
Resposta: text/html
Permissão:

Parâmetro Obrigatório Tipo Descrição
usuarioAluno.login Sim String Login definido no perfil do aluno.
usuarioAluno.senha Sim String Senha definida no perfil do aluno.
URIs de acesso
http://academico.faesi.com.br:80/aluno/aluno.efetuaLogin.logic

Submete os dados de autentição ao portal do professor redirecionando para página inicial caso a autenticação seja realizada com sucesso.
Método: POST
Resposta: text/html
Permissão:

Parâmetro Obrigatório Tipo Descrição
usuarioProfessor.login Sim String Login definido no perfil do professor.
usuarioProfessor.senha Sim String Senha definida no perfil do professor.
URIs de acesso
http://academico.faesi.com.br:80/prof/professor.efetuaLogin.logic

Lista todas as matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.matriculas

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código do Organização
idAluno Não java.lang.Integer Código do Aluno
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
idTurma Não java.lang.Integer Código da Turma
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do curso ingresso
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do curso ingresso
nomeAluno Não java.lang.String Nome do aluno (será aplicado em um comando 'LIKE'
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/matriculas/listar/

Lista todas as últimas matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.ultima.matricula

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código do Organização
idAluno Não java.lang.Integer Código do Aluno
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do curso ingresso
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do curso ingresso
nomeAluno Não java.lang.String Nome do aluno (será aplicado em um comando 'LIKE'
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/ultimas-matriculas/listar/

Lista todas as matrículas alunos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.todas.matriculas

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código do Organização
idAluno Não java.lang.Integer Código do Aluno
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do curso ingresso
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do curso ingresso
nomeAluno Não java.lang.String Nome do aluno (será aplicado em um comando 'LIKE'
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/todas-matriculas/listar/

Lista todas as disciplinas matriculadas dos alunos da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.matricula.disciplina

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código do Organização
idAluno Não java.lang.Integer Código do Aluno
idPeriodoLetivo Não java.lang.Integer Código do Período Letivo
idTurma Não java.lang.Integer Código do Turma
idCurso Não java.lang.Integer Código do Curso
idMatricula Não java.lang.Integer Código da Matrícula
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do curso ingresso (DD/MM/YYYY)
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do curso ingresso (DD/MM/YYYY)
nomeAluno Não java.lang.String Nome do aluno (será aplicado em um comando 'LIKE')
nomeDisciplina Não java.lang.String Nome da Disciplina (será aplicado em um comando 'LIKE')
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/disciplinas/

Permite cadastrar um perfil de pessoa física. Caso o CPF informado já esteja cadastrado, serão retornados os dados da pessoa existente na base de dados.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.cadastrar.perfil.fisico

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idCliente Sim java.lang.Integer Código do Cliente
nome Sim java.lang.String Nome da Pessoa física
cpf Sim java.lang.String CPF
rg Não java.lang.String Nùmero do RG
rgOrgaoExpedidor Não java.lang.String Órgão Expedidor
rgDataEmissao Não java.sql.Date Data de emissão do RG
pai Não java.lang.String Nome do Pai
mae Não java.lang.String Nome da Mãe
cpfPai Não java.lang.String CPF do Pai
cpfMae Não java.lang.String CPF da Mãe
dataNascimento Não java.sql.Date Data de Nascimento
estadoCivil Sim java.lang.String Estado Civil (SOLTEIRO, CASADO, DIVORCIADO, VIUVO, UNIAO_ESTAVEL, DESQUITADO, NAO_INFORMADO)
sexo Sim java.lang.String Sexo (MASCULINO, FEMININO)
idNacionalidade Não java.lang.Integer Código da Nacionalidade
idReligiao Não java.lang.Integer Código da Religião
idNecessidadeEspecial Não java.lang.Integer Código da Necessidade Especial
idCidadeNatural Não java.lang.Integer Código da Cidade de Naturalidade
idCor Não java.lang.Integer Código da Cor/Raça
status Sim java.lang.String Status da Pessoa (ATIVO,INATIVO)
idCidade Não java.lang.Integer Código da Cidade de Endereço
bairro Não java.lang.String Bairro
logradouro Não java.lang.String Logradouro
cep Não java.lang.String CEP
complemento Não java.lang.String Complemento do Endereço
localidade Não java.lang.String Localidade do Endereço
numero Não java.lang.String Número da residência
celular Não java.lang.String Número do Celular
fone Não java.lang.String Número do Telefone fixo
fax Não java.lang.String Número do FAX
foneComercial Não java.lang.String Número do Telefone Comercial
email Não java.lang.String E-mail
observacao Não java.lang.String Observações sobre o cadastro ou registro da pessoa
idProfissao Não java.lang.Integer Código da Profissão
cargo Não java.lang.String Descrição do cargo exercido
facebook Não java.lang.String URL do perfil do Facebook
googlePlus Não java.lang.String URL do perfil do Google+
linkedIn Não java.lang.String URL do perfil do Linkedin
twitter Não java.lang.String URL do perfil do Twitter
lattes Não java.lang.String URL do perfil da Plataforma Lattes
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/perfil/fisicos/inserir/

Lista todos os perfis de pessoas físicas cadastrados na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.perfil.fisico

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
tipo Sim java.lang.String Tipo do resultado da busca:
-BASICA: somente os dados básicos do perfil;
-COMPLETA:todos os dados do perfil;
idPerfil Não java.lang.Integer Código do Perfil
dataAlteracaoInicio Não java.sql.Date Data início de alteração da inscrição do perfil (DD/MM/YYYY)
dataAlteracaoFim Não java.sql.Date Data final de alteração da inscrição do perfil (DD/MM/YYYY)
filtrarPor Não java.lang.String Flag do campo de referência para a consulta (CPF, NOME ou EMAIL)
termo Não java.lang.String Conteúdo para a busca
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/basicos/perfil/fisicos/

Lista todos os funcionários da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.funcionario

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
status Não java.lang.String Status do funcionário (ATIVO, INATIVO)
idFuncionario Não java.lang.Integer Código do funcionário
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/rh/funcionarios/

Lista todos os professores da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.consulta.professor

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
status Não java.lang.String Status do professor (ATIVO, INATIVO)
idProfessor Não java.lang.Integer Código do Professor
idFuncionario Não java.lang.Integer Código do Funcionário associado ao professor
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/rh/professores/

Permite criar um novo token ou então recuperar um token existente para um dado usuário do SWA.JACAD que ainda esteja ativo e dentro do período de liberação.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.criacao.token.remoto

Parâmetro Obrigatório Tipo Descrição
format Sim java.lang.String Formato do retorno (JSON/XML)
idUsuario Sim java.lang.Integer Código do Usuário do SWA.JACAD
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/usuarios/criar-token-usuario/

Lista todos os Cursos ofertads nos editais da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.vestibular

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idEdital Não java.lang.Integer Código do Edital
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/vestibular/cursos/

Lista todos os editais disponíveis na instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.vestibular

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/vestibular/

Lista todos os candidatos inscritos nos editais da instituição combinado com diversos filtros.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.vestibular

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idEdital Sim java.lang.Integer Código do Edital
filtrarPor Não java.lang.String Flag do campo de referência para a consulta (CPF, NOME ou EMAIL)
termo Não java.lang.String Conteúdo para a busca
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/vestibular/inscricoes/

Lista todos os locais de prova dos editais da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.vestibular

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idEdital Não java.lang.Integer Código do Edital
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/vestibular/locais-de-prova/

Lista todas as salas dos locais de prova dos editais da instituição.
Método: POST
Resposta: JSON/XML
Permissão: api.integracao.habilitar.modulo.vestibular

Parâmetro Obrigatório Tipo Descrição
token Sim java.lang.String Token do usuário
format Sim java.lang.String Formato do retorno (JSON/XML)
idOrg Não java.lang.Integer Código da instituição
idEdital Não java.lang.Integer Código do Edital
URIs de acesso
http://academico.faesi.com.br:80/academico/api/v1/vestibular/salas/

Todas as URIs de todos os métodos

Método URIs de acesso
POST http://academico.faesi.com.br:80/academico/api/v1/academico/cursos-base/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/turmas/disciplinas/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/matrizes/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/periodos-letivos/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/sistemas-de-avaliacao/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/turmas/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/cursos-ingressos/listar/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/centros-de-custos/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/contas-bancarias/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/cores-racas/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/formas-conhecimento/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/graus-de-graduacao/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/metodos-de-recebimento/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/nacionalidades/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/necessidades-especiais/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/organizacoes/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/planos-de-contas/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/planos-de-pagamento/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/profissoes/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/tipos-de-processo-seletivo/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/tipos-de-recebimento/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/unidades-fisicas/
POST http://academico.faesi.com.br:80/academico/api/v1/eventos/
POST http://academico.faesi.com.br:80/academico/api/v1/eventos/palestrantes/
POST http://academico.faesi.com.br:80/academico/api/v1/eventos/programacao/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/contas-receber/cancelar/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/conta-receber/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/listar-recebimentos/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/criar-conta-receber
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/transacoes/nfse/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/boleto/imprimir/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/boleto/registrar/
POST http://academico.faesi.com.br:80/academico/api/v1/financeiro/registrar-pagamento/
POST http://academico.faesi.com.br:80/academico/api/v1/integracoes/wifi/ativos
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/cidades/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/estados/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/locais/paises/
POST http://academico.faesi.com.br:80/aluno/aluno.efetuaLogin.logic
POST http://academico.faesi.com.br:80/prof/professor.efetuaLogin.logic
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/matriculas/listar/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/ultimas-matriculas/listar/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/todas-matriculas/listar/
POST http://academico.faesi.com.br:80/academico/api/v1/academico/aluno/matriculas/disciplinas/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/perfil/fisicos/inserir/
POST http://academico.faesi.com.br:80/academico/api/v1/basicos/perfil/fisicos/
POST http://academico.faesi.com.br:80/academico/api/v1/rh/funcionarios/
POST http://academico.faesi.com.br:80/academico/api/v1/rh/professores/
POST http://academico.faesi.com.br:80/academico/api/v1/usuarios/criar-token-usuario/
POST http://academico.faesi.com.br:80/academico/api/v1/vestibular/cursos/
POST http://academico.faesi.com.br:80/academico/api/v1/vestibular/
POST http://academico.faesi.com.br:80/academico/api/v1/vestibular/inscricoes/
POST http://academico.faesi.com.br:80/academico/api/v1/vestibular/locais-de-prova/
POST http://academico.faesi.com.br:80/academico/api/v1/vestibular/salas/

Exemplos

Abaixo um exemplo de chamada a um método da API de Integração do SWA.JACAD feita através da linguagem JavaScript usando o framework jQuery.

	$(document).ready(function(){
		
		var url = "http://servidor.jacad.bla.com.br:8080/academico/caminho-do-metodo/";
		
		var params = {
			token: 'f4cf73555046318ea46a0edebe0f28b9',
			format: 'json',
			idOrg: 1232049
		};
		
		$.post(url, params, function(data){
			console.log(data);
		});
	});
		

PHP

$data = array('token' => 'f4cf73555046318ea46a0edebe0f28b9', 'format' => 'json');
$URI = "http://servidor.jacad.bla.com.br:8080/academico/caminho-do-metodo/";
		
$ch = curl_init($URI);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
		
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_URL, $URI);
		
$result=curl_exec($ch);
curl_close($ch);
$result = json_decode($result, true);
		

Java

Utilizando a lib Retrofit

Retrofit retrofit = new Retrofit.Builder()
			    .baseUrl("http://127.0.0.1:8080/academico/api/v1/")
			    .addConverterFactory(GsonConverterFactory.create())
			    .addConverterFactory(SimpleXmlConverterFactory .create())
			    .build();


JACADService service = retrofit.create(JACADService.class);

Call<<ist<PeriodoLetivo>> caller = service.listarPeriodosLetivos("seu-token", "JSON");

List<PeriodoLetivo> periodos = caller.execute().body();

for (PeriodoLetivo pl : periodos) {
	System.out.println(pl.getDescricao());
}