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

De UltramaxWiki
Ir para navegação Ir para pesquisar
(Deixei no padrão do word)
 
Linha 1: Linha 1:
== Introdução ==
+
==Introdução==
  
 
   Cada endpoint executado retorna uma resposta com um wrap contendo:
 
   Cada endpoint executado retorna uma resposta com um wrap contendo:
Linha 9: Linha 9:
 
·        Response com o código http (200, 409,417, 500 e 204)
 
·        Response com o código http (200, 409,417, 500 e 204)
  
== Endpoints da API ==
+
==Endpoints da API==
Gerar token de autenticação
 
  
 +
==== 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.
  
Linha 44: Linha 44:
 
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
  
Linha 110: Linha 110:
 
}
 
}
  
== 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.
  
Linha 226: Linha 226:
 
}
 
}
  
== 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.
  
Linha 267: Linha 267:
 
|
 
|
 
|-
 
|-
|  
+
|
 
|
 
|
 
|-
 
|-
|  
+
|
 
|
 
|
 
|-
 
|-
|  
+
|
 
|
 
|
 
|}
 
|}

Edição das 20h40min de 6 de janeiro de 2021

Introdução

   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
Sigla Código identificador do Curso, max 15 caracteres
Nome Descrição do curso, Max 70 caracters
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, max 9 caracteres
codigoIntegracao Código único de integração, será a chave entre os diferentes sistemas, max 255 caracteres
modalidadeCurso ‘EAD’ fixo

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","nome":"Curso teste","itemServico":"545454","codigoIntegracao":"SA-KJ-AD-NB","modalidadeCurso":"EAD"}

Resposta

{

   "dados": {

       "sigla": "Curso",

       "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
Sigla Código identificador do Curso, max 15 caracteres
Celular :"Número de telefone celular Ex: 11998465521"
Cpf Sequencia numérica com o CPF do aluno Ex. 65696655565
Email Email do aluno Ex: aluno@aluno.com.br
enderecoBairro Bairro do end residencial do aluno Ex. vila didi
enderecoCep CEP do end residencial do aluno Ex. 13203320
enderecoCidade Cidade do end residencial do aluno Ex. jundiai
enderecoComplemento Complemento do end residencial do aluno Ex. casa
enderecoEstado Estado do end residencial do aluno Ex. SP Max 2 caracteres deve ser a sigla correspondente ao Estado
enderecoLogradouro Logradouro do end residencial do aluno Ex. rua guapore
enderecoNumero Número do end residencial do aluno Ex. 521
Nascimento timestamp com a data de nascimento do aluno Ex 319518000000
Nome Nome do aluno. Max 70 caracteres
Rg RG do aluno Ex: 584245999
Sexo Indicador do gênero do aluno Ex MASCULINO.

MASCULINO/FEMININO

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"

}