Burocratas, privado, Administradores
1 362
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 3:
Linha 3: − + − + − + − + − + Linha 25:
Linha 25: − + Linha 37:
Linha 37: − + Linha 49:
Linha 49: − + Linha 70:
Linha 70: − + Linha 77:
Linha 77: − + − + − + Linha 112:
Linha 112: − + Linha 165:
Linha 165: − + Linha 172:
Linha 172: − + − + − + Linha 225:
Linha 225: − + Linha 259:
Linha 259: − + Linha 270:
Linha 270: − + − + − +
Gestão Escolar - API de integração (ver código-fonte)
Edição das 23h19min de 6 de janeiro de 2021
, 23h19min de 6 de janeiro de 2021sem sumário de ediçã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.
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 ==
==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.
#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]
#Para gerar o codigoAPI e senhaAPI entre em contato com o suporte da Ultramax através do e-mail 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.
#Além do codigoAPI e senhaAPI entrar em contato com a Ultramax para solicitar a criação de um ambiente de testes.
== Padrões ==
==Padrões==
Cada endpoint executado retorna uma resposta com um wrap contendo:
Cada endpoint executado retorna uma resposta com um wrap contendo:
(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
(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 =====
=====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=====
{
{
(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 =====
=====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=====
{
{
(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 =====
=====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=====
{
{