Mudanças entre as edições de "Gestão Escolar - API de integração"

De UltramaxWiki
Ir para navegação Ir para pesquisar
Linha 142: Linha 142:
 
|'''Atributo'''
 
|'''Atributo'''
 
|'''Descrição'''
 
|'''Descrição'''
 +
|Tipo
 
|Minímo
 
|Minímo
 
|Máximo
 
|Máximo
Linha 147: Linha 148:
 
|'''Celular'''
 
|'''Celular'''
 
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
 
|Número de telefone celular Ex: 11998465521 ou (11) 99999-9999
 +
|S
 
|11
 
|11
 
|15
 
|15
Linha 152: Linha 154:
 
|'''Cpf'''
 
|'''Cpf'''
 
|Sequencia numérica com o CPF do aluno Ex. 65696655565
 
|Sequencia numérica com o CPF do aluno Ex. 65696655565
 +
|S
 
|11
 
|11
 
|11
 
|11
Linha 157: Linha 160:
 
|'''Email'''
 
|'''Email'''
 
|Email  do aluno Ex: aluno@aluno.com.br
 
|Email  do aluno Ex: aluno@aluno.com.br
 +
|S
 
|>1
 
|>1
 
|255
 
|255
Linha 162: Linha 166:
 
|'''enderecoBairro'''
 
|'''enderecoBairro'''
 
|Bairro do end residencial do aluno Ex. vila didi
 
|Bairro do end residencial do aluno Ex. vila didi
 +
|S
 
|1
 
|1
 
|60
 
|60
Linha 167: Linha 172:
 
|'''enderecoCep'''
 
|'''enderecoCep'''
 
|CEP  do end residencial do aluno Ex. 13203320
 
|CEP  do end residencial do aluno Ex. 13203320
 +
|S
 
|8
 
|8
 
|8
 
|8
Linha 172: Linha 178:
 
|'''enderecoCidade'''
 
|'''enderecoCidade'''
 
|Cidade do end residencial do aluno Ex. jundiai
 
|Cidade do end residencial do aluno Ex. jundiai
 +
|S
 
|1
 
|1
 
|20
 
|20
Linha 177: Linha 184:
 
|'''enderecoComplemento'''
 
|'''enderecoComplemento'''
 
|Complemento  do end residencial do aluno Ex. casa
 
|Complemento  do end residencial do aluno Ex. casa
 +
|S
 
|0
 
|0
 
|60
 
|60
Linha 182: Linha 190:
 
|'''enderecoEstado'''
 
|'''enderecoEstado'''
 
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
 
|Estado do end residencial do aluno Ex. SP Max 2 caracteres  deve ser a sigla correspondente ao Estado
 +
|S
 
|2
 
|2
 
|2
 
|2
Linha 187: Linha 196:
 
|'''enderecoLogradouro'''
 
|'''enderecoLogradouro'''
 
|Logradouro  do end residencial do aluno Ex. rua guapore
 
|Logradouro  do end residencial do aluno Ex. rua guapore
 +
|S
 
|1
 
|1
 
|60
 
|60
Linha 192: Linha 202:
 
|'''enderecoNumero'''
 
|'''enderecoNumero'''
 
|Número do end residencial do aluno Ex. 521
 
|Número do end residencial do aluno Ex. 521
 +
|S
 
|0
 
|0
 
|7
 
|7
Linha 197: Linha 208:
 
|'''Nascimento'''
 
|'''Nascimento'''
 
|Date com a data de nascimento do aluno dd/MM/yyyy
 
|Date com a data de nascimento do aluno dd/MM/yyyy
 +
|S
 
|10
 
|10
 
|10
 
|10
Linha 202: Linha 214:
 
|'''Nome'''
 
|'''Nome'''
 
|Nome do aluno.
 
|Nome do aluno.
 +
|S
 
|1
 
|1
 
|70
 
|70
Linha 207: Linha 220:
 
|'''Rg'''
 
|'''Rg'''
 
|RG  do aluno Ex: 584245999
 
|RG  do aluno Ex: 584245999
 +
|S
 
|>1
 
|>1
 
|25
 
|25
Linha 214: Linha 228:
  
 
MASCULINO/FEMININO
 
MASCULINO/FEMININO
 +
|S
 
|8
 
|8
 
|15
 
|15

Edição das 20h04min de 8 de janeiro de 2021

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

  1. 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.
  2. 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 www.ultramax.com.br
  3. 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:

·        Os dados que foram processados

·        A situação do processamento (OK, JAPROCESSADO, ERRO, CURSO_NAO_EXISTE, ALUNO_NAO_EXISTE)

·        Response com o código http (200, 409,417, 500 e 204)

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.

(base)/gestaoescolar/services/login/login/autentica

Body

Atributo Descrição
senhaApi Deve ter a senha que foi gerada ao cadastrar um registro de api no sistema gestão escolar
codigoApi Deve ter o código de api que foi gerado ao cadastrar um registro de api no sistema gestão escolar

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 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

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

(base)/gestaoescolar/services/curso/rest/add

Body

Atributo Descrição Tipo Minímo Máximo
Sigla Código identificador do Curso S 1 15
CodigoUnidade Código da unidade de ensino que o curso pertence Int 1 99999
Nome Descrição do curso S 1 70
itemServico Código do serviço para emissão de NFS-e. Depende de cada instituição e do curso. Por exemplo: 05673. Ver com a instituição qual código usar para cada curso S 4 9
codigoIntegracao Código único de integração, será a chave entre os diferentes sistemas S 1 255
modalidadeCurso ‘EAD’ fixo S 1 30

Respostas esperadas

Status 200: Status Processamento: OK

Status 417: Status Processamento: JACADASTRADO. Quando a mesma sigla de curso está cadastrado em mais de um registro.

Status  500:  Status Processamento: ERRO

Exemplo:

Requisição

{"sigla":"Curso","codigoUnidade":"1","nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}

Resposta

{

   "dados": {

       "sigla": "Curso",

"codigoUnidade":"1",

       "nome": "Curso teste",

       "itemServico": "545454",

       "codigoIntegracao": "SA-KJ-AD-NB",

       "modalidadeCurso": "EAD"

   },

   "statusProcessamento": "OK",

   "response": "ACCEPTED",

   "acao": "Manutenção OK"

}

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.

(base)/gestaoescolar/services/aluno/rest/responsavelfinanceiro

Body

Atributo Descrição Tipo Minímo Máximo
Celular Número de telefone celular Ex: 11998465521 ou (11) 99999-9999 S 11 15
Cpf Sequencia numérica com o CPF do aluno Ex. 65696655565 S 11 11
Email Email do aluno Ex: aluno@aluno.com.br S >1 255
enderecoBairro Bairro do end residencial do aluno Ex. vila didi S 1 60
enderecoCep CEP do end residencial do aluno Ex. 13203320 S 8 8
enderecoCidade Cidade do end residencial do aluno Ex. jundiai S 1 20
enderecoComplemento Complemento do end residencial do aluno Ex. casa S 0 60
enderecoEstado Estado do end residencial do aluno Ex. SP Max 2 caracteres deve ser a sigla correspondente ao Estado S 2 2
enderecoLogradouro Logradouro do end residencial do aluno Ex. rua guapore S 1 60
enderecoNumero Número do end residencial do aluno Ex. 521 S 0 7
Nascimento Date com a data de nascimento do aluno dd/MM/yyyy S 10 10
Nome Nome do aluno. S 1 70
Rg RG do aluno Ex: 584245999 S >1 25
Sexo Indicador do gênero do aluno Ex MASCULINO.

MASCULINO/FEMININO

S 8 15

Respostas esperadas

Status 200: Status Processamento: OK

Status 417: Status Processamento: JACADASTRADO

Status  500:  Status Processamento: ERRO

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"}

Resposta

{

   "dados": {

       "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"

   },

   "statusProcessamento": "OK",

   "response": "ACCEPTED",

   "acao": "Manutenção OK"

}

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.

(base)/gestaoescolar/services/matricula/rest/add

Body

Atributo Descrição
cpf_cnpj CPF do aluno que será gerada a matrícula, apenas numeros
codigoIntegracao Código de integração para um Curso existente
codigoMatriculaUnico Código de integração para busca de uma matrícula ou para criar uma nova
numeroSerieDeMatricula numero inteiro indicando com a sequência da série no curso que a matrícula deve ser feita. Ex: um curso que tenha três séries e a matrícula deve ser feita no primeira delas, deve passar 1
Valor Valor equivamente ao curso: Ex: 1000.0
quantidadeParcelas Quantidade de parcelas. Ex 1
formaPagamento Forma de pagamento que deve usado na baixa do título.

Valores válidos:

DINHEIRO, CHEQUE, C_CREDITO,C_DEBITO, BOLETO, DEB_AUTOMATICO,TRANSFERENCIA, DOC,OUTRO_BAIXA_ADM,DEPOSITO,DUPLICADA, FIES, PREFEITURA,PROUNI, FOLHA_DE_PGTO, CHEQUE_PRE,PAGAMENTO_ONLINE, PERMUTA, PIX

bandeiraCartao Bandeira do cartão EX VISA". Esse campo depende de novas conversas com ASAS. Por enquanto pode ficar VISA fixo

Respostas esperadas

Status 200: Status Processamento: OK

Status 417: Status Processamento: JACADASTRADO (quando existe uma outra matrícula não cancelada no mesmo período letivo)

Status 417: Status Processamento: CURSO_NAO_EXISTE (quando o código de integração informado não encontrou um curso correspondente cadastrado)

Status 417: Status Processamento: ALUNO_NAO_EXISTE (quando o C.P.F informado não encontrou um aluno correspondente cadastrado)

Status  500:  Status Processamento: ERRO

Exemplo

Requisição

{"cpf_cnpj":2865474325,"codigoIntegracao":"SA-KJ-AD-NB","codigoMatriculaUnico":"201254","numeroSerieDeMatricula":1,"valor":1000.0,"quantidadeParcelas":1,"formaPagamento":"DINHEIRO","bandeiraCartao":"VISA"}

Resposta

{

   "dados": {

       "pagamentoCartao": false,

       "cpf_cnpj": 2865474325,

       "codigoIntegracao": "SA-KJ-AD-NB",

       "codigoMatriculaUnico": "201254",

       "numeroSerieDeMatricula": 1,

       "valor": 1000.0,

       "quantidadeParcelas": 1,

       "formaPagamento": "DINHEIRO",

       "bandeiraCartao": "VISA"

   },

   "statusProcessamento": "OK",

   "response": "ACCEPTED",

   "acao": "Manutenção OK"

}