Burocratas, privado, Administradores
1 362
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 1:
Linha 1: + + + + + + + + + Linha 11:
Linha 20: − ====Gerar token de autenticação====+ − + Linha 28:
Linha 37: − + − + − − − − − − − − − Linha 44:
Linha 44: − + − + Linha 70:
Linha 70: − + − Linha 78:
Linha 77: − + − − Requisição + − + − Linha 110:
Linha 107: − + − + Linha 168:
Linha 165: − + − Linha 176:
Linha 172: − + − − Requisição + − + − Linha 226:
Linha 220: − + − + Linha 265:
Linha 259: − + − Linha 277:
Linha 270: − + − − Requisição + − + −
Gestão Escolar - API de integração (ver código-fonte)
Edição das 23h18min de 6 de janeiro de 2021
, 23h18min de 6 de janeiro de 2021sem sumário de edição
==Introdução==
==Introdução==
Este manual é utilizado principalmente para integração com o site de vendas/e-commerce da instituição de ensino de modo que o site de vendas possa cadastrar e matricular os alunos no sistema Ultramax.
== Pré-Requisitos ==
# No endereço dos endopoints abaixo trocar o "(base)" pelo host da instituição, por exemplo: https://demo.ultramax.com.br/, já que cada instituição tem o seu host independente.
# Para gerar o codigoAPI e senhaAPI entre em contato com o suporte da Ultramax através do e-mail [[Mailto:suporte@ultramax.com.br|suporte@ultramax.com.br]] ou através de outros canais de atendimento do site [https://www.ultramax.com.br www.ultramax.com.br]
# Além do codigoAPI e senhaAPI entrar em contato com a Ultramax para solicitar a criação de um ambiente de testes.
== Padrões ==
Cada endpoint executado retorna uma resposta com um wrap contendo:
Cada endpoint executado retorna uma resposta com um wrap contendo:
==Endpoints da API==
==Endpoints da API==
===Gerar token de autenticação===
Gera um token de autenticação para acessar os recursos da API de Integração do gestão escolar. Este token deve ser utilizado para consumir os demais endpoints.
Gera um token de autenticação para acessar os recursos da API de Integração do gestão escolar. Este token deve ser utilizado para consumir os demais endpoints.
(base)/gestaoescolar/services/login/login/autentica
(base)/gestaoescolar/services/login/login/autentica
Body
==== Body ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
Respostas esperadas:
==== Respostas esperadas: ====
Status 200 , com o respectivo código de token gerado. Onde o código é composto por: Código da api, Data hora atual, Tempo de expiração em 15 minutos, Chave interna
Status 200 , com o respectivo código de token gerado. Onde o código é composto por:
Código da api
Data hora atual
Tempo de expiração em 15 minutos
Chave interna
Status 401. Quando a senha e o código de api fornecidos não estão de acordo com o cadastro na área de tabelas/API do Gestão Escolar;
Status 401. Quando a senha e o código de api fornecidos não estão de acordo com o cadastro na área de tabelas/API do Gestão Escolar;
Status 500. Caso algum erro interno ocorra durante o processamento
Status 500. Caso algum erro interno ocorra durante o processamento
==Manutenção de cursos==
===Manutenção de cursos===
Faz a manutenção de um curso. Através do código de integração será localizado um curso existente para alteração ou, caso não exista, será criado um novo curso
Faz a manutenção de um curso. Através do código de integração será localizado um curso existente para alteração ou, caso não exista, será criado um novo curso
(base)/gestaoescolar/services/curso/rest/add
(base)/gestaoescolar/services/curso/rest/add
Body
==== Body ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
Respostas esperadas:
==== Respostas esperadas ====
Status 200: Status Processamento: OK
Status 200: Status Processamento: OK
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
Exemplo:
==== Exemplo: ====
===== Requisição =====
{"sigla":"Curso","nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
{"sigla":"Curso","nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}
Resposta
===== Resposta =====
{
{
}
}
==Manutenção de alunos==
===Manutenção de alunos===
Adiciona ou altera um aluno. Através do C.P.F informado será localizado na base de dados do gestão escolar o aluno correspondente. Caso encontre, será atualizado todos os campos bases enviados no header, por outro lado, caso não encontre, será incluído um novo registro para o aluno.
Adiciona ou altera um aluno. Através do C.P.F informado será localizado na base de dados do gestão escolar o aluno correspondente. Caso encontre, será atualizado todos os campos bases enviados no header, por outro lado, caso não encontre, será incluído um novo registro para o aluno.
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro
Body
==== Body ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
Respostas esperadas
==== Respostas esperadas ====
Status 200: Status Processamento: OK
Status 200: Status Processamento: OK
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
Exemplo
==== Exemplo ====
===== Requisição =====
{"celular":"11998465521","cpf":2865474325,"email":"wescleyfcosta@gmail.com","enderecoBairro":"vila didi","enderecoCep":"13203320","enderecoCidade":"jundiai","enderecoComplemento":"casa","enderecoEstado":"SP","enderecoLogradouro":"rua guapore","enderecoNumero":"521","nascimento":319518000000,"nome":"wescley","rg":"584245999","sexo":"MASCULINO"}
{"celular":"11998465521","cpf":2865474325,"email":"wescleyfcosta@gmail.com","enderecoBairro":"vila didi","enderecoCep":"13203320","enderecoCidade":"jundiai","enderecoComplemento":"casa","enderecoEstado":"SP","enderecoLogradouro":"rua guapore","enderecoNumero":"521","nascimento":319518000000,"nome":"wescley","rg":"584245999","sexo":"MASCULINO"}
Resposta
===== Resposta =====
{
{
}
}
==Manutenção de matrículas==
===Manutenção de matrículas===
Adiciona ou altera uma matrícula. Pelo código da matrícula único, código de integração entre os sistemas, será possível atualizar os dados de uma matrícula, caso ela exista, ou incluir uma nova.
Adiciona ou altera uma matrícula. Pelo código da matrícula único, código de integração entre os sistemas, será possível atualizar os dados de uma matrícula, caso ela exista, ou incluir uma nova.
(base)/gestaoescolar/services/matricula/rest/add
(base)/gestaoescolar/services/matricula/rest/add
Body
==== Body ====
{| class="wikitable"
{| class="wikitable"
|'''Atributo'''
|'''Atributo'''
|}
|}
Respostas esperadas
==== Respostas esperadas ====
Status 200: Status Processamento: OK
Status 200: Status Processamento: OK
Status 500: Status Processamento: ERRO
Status 500: Status Processamento: ERRO
Exemplo
==== Exemplo ====
===== Requisição =====
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO","bandeiraCartao":"VISA"}
{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO","bandeiraCartao":"VISA"}
Resposta
===== Resposta =====
{
{