Anônimo

Mudanças

De UltramaxWiki
sem sumário de edição
Linha 1: Linha 1: −
== Introdução ==
+
==Introdução==
 
Este manual é utilizado para fazer as configurações necessárias para funcionamento da API de integração de cadastro de cursos e matrículas.
 
Este manual é utilizado para fazer as configurações necessárias para funcionamento da API de integração de cadastro de cursos e matrículas.
    
Veja a API em [[Gestão Escolar - API de integração]]
 
Veja a API em [[Gestão Escolar - API de integração]]
   −
== Configurando o sistema ==
+
==Configurando o sistema==
   −
=== Administradoras de cartão ===
+
===Administradoras de cartão===
 
Para utilizar a API de matrícula e geração de financeiro, caso seja utilizada a forma de pagamento como cartão de crédito ou débito, é necessário configurar qual a administradora padrão para cada modalidade (crédito/débito).
 
Para utilizar a API de matrícula e geração de financeiro, caso seja utilizada a forma de pagamento como cartão de crédito ou débito, é necessário configurar qual a administradora padrão para cada modalidade (crédito/débito).
   Linha 12: Linha 12:  
[[Arquivo:Admcartao1.png|nenhum|miniaturadaimagem|1169x1169px]]
 
[[Arquivo:Admcartao1.png|nenhum|miniaturadaimagem|1169x1169px]]
   −
=== Cadastro de curso padrão ===
+
===Cadastro de curso padrão===
 
Quando utilizada a API de cadastro de curso, para que o sistema possa cadastrar um novo curso pela API é necessário ter várias configurações do curso e para que a API não fique muito complexa, deve ser criado um curso no menu Tabelas -> Cursos com o código "[PADRAO]" (sem as aspas) conforme abaixo:
 
Quando utilizada a API de cadastro de curso, para que o sistema possa cadastrar um novo curso pela API é necessário ter várias configurações do curso e para que a API não fique muito complexa, deve ser criado um curso no menu Tabelas -> Cursos com o código "[PADRAO]" (sem as aspas) conforme abaixo:
 
[[Arquivo:Cursopadrao.png|nenhum|miniaturadaimagem|586x586px]]
 
[[Arquivo:Cursopadrao.png|nenhum|miniaturadaimagem|586x586px]]
 
Dentro do cadastro desse curso padrão deve ser configurado todas as informações que serão utilizadas como base para os novos cursos criados pela API, ou seja, quando a API incluir algum curso, irá DUPLICAR os dados desse curso padrão e criar o novo curso com o código e nome informado pela API.
 
Dentro do cadastro desse curso padrão deve ser configurado todas as informações que serão utilizadas como base para os novos cursos criados pela API, ou seja, quando a API incluir algum curso, irá DUPLICAR os dados desse curso padrão e criar o novo curso com o código e nome informado pela API.
   −
=== Cadastro de período letivo ===
+
===Cadastro de período letivo===
 
Na API quando utilizada a modalidade de curso "EAD" deve-se criar um período letivo com o nome "EAD" que será onde todas as séries, turmas e matrículas serão feitas.
 
Na API quando utilizada a modalidade de curso "EAD" deve-se criar um período letivo com o nome "EAD" que será onde todas as séries, turmas e matrículas serão feitas.
   Linha 23: Linha 23:  
[[Arquivo:Ead periodo 1.png|nenhum|miniaturadaimagem]]
 
[[Arquivo:Ead periodo 1.png|nenhum|miniaturadaimagem]]
   −
=== Cadastro de série ===
+
===Cadastro de série===
 
No cadastro de série é necessário cadastrar uma série padrão para quando a API for cadastrar um novo curso o sistema poder também DUPLICAR além do cursão padrão também duplicar todas as séries desse curso.
 
No cadastro de série é necessário cadastrar uma série padrão para quando a API for cadastrar um novo curso o sistema poder também DUPLICAR além do cursão padrão também duplicar todas as séries desse curso.
   Linha 32: Linha 32:  
Caso não seja curso EAD, pode ter mais de uma receita obrigatória, e os valores dos boletos gerados serão o valor configurado na receita e não o valor informado na API.
 
Caso não seja curso EAD, pode ter mais de uma receita obrigatória, e os valores dos boletos gerados serão o valor configurado na receita e não o valor informado na API.
   −
=== Configurações gerais ===
+
===Configurações gerais===
 
Para utilizar a API de matrícula, precisa habilitar a auto numeração de matrícula no menu abaixo:
 
Para utilizar a API de matrícula, precisa habilitar a auto numeração de matrícula no menu abaixo:
 
[[Arquivo:Cfg auto rm.png|nenhum|miniaturadaimagem|314x314px]]
 
[[Arquivo:Cfg auto rm.png|nenhum|miniaturadaimagem|314x314px]]
 +
 +
=== Geração de código e senha para uso da API ===
 +
Para poderem ter acesso a API, é necessário criar um código e senha e disponibilizar para o desenvolvedor que irá utilizar a API.
 +
 +
Esse código e senha deve ser único para cada desenvolvedor/empresa que for integrar.
 +
 +
Acessar o menu Tabelas -> API e criar uma chave para o desenvolvedor. Manter essa chave em sigilo e somente compartilhar com o desenvolvedor.
 
[[Category:GestaoEscolar]]
 
[[Category:GestaoEscolar]]
 
[[Category:API]]
 
[[Category:API]]
1 358

edições