Comunicação com API do Sistema Aula ( V. 2.4)
Requisitos:
1 - Ter o link do cliente do Sistema Aula;
2 – Ter o token de acesso;
3 – Conhecer a lista de APIs (URL / Endpoint)
4 – Passar os parâmetros GET (query string) na URL
Informações de teste
URL = https://colegio.cloud/nomeescola
TOKEN = u8AxWey5nqmnUzvekab4U6VjgEvn1lyD58508e5o66e4489f6bdd19f5c60b3g8d
Obs.: Recomendamos sempre usar https
API para retornar a foto do aluno ou funcionário
Endpoint (GET): /api/aca/getfoto
Parâmetros:
token = Passar o token informado pelo Sistema Aula
tabela = aca_fichacadastralaluno ou pes_servidores
unidade = código da unidade
user = matrícula do aluno ou código do funcionário
link = 0 ou 1, sendo
0 = retorna uma resposta HTTP do tipo Content-Type: image/jpeg
1 = retorna JSON com a URL com a imagem
Exemplo de chamada a API
Respostas em JSON:
{"status":false,"id":"2580","mensagem":"Parametros invalidos"}
{"status":false,"id":"2581","mensagem":"Parametro invalido - tabela"}
{"status":false,"id":"2582","mensagem":"Parametro invalido - unidade"}
{"status":false,"id":"2583","mensagem":"Parametro invalido - user"}
{"status":false,"id":"2584","mensagem":"Token invalido"}
{"status":false,"id":"2588","mensagem":"Tabela nao informada"}
{"status":false,"id":"2589","mensagem":"Campo de imagem nao existe"}
{"status":false,"id":"2590","mensagem":"Falha ao Buscar dados"}
{"status":true,"id":"2588","mensagem":"Sem foto cadastrada"}
{"status":true,"id":"2586","mensagem":"Link da imagem gerado","url":"https://colegio.cloud/nomeescola/externo/catraca/tmp/foto_1_m_1003.jpg"}
Ou se parâmetro link=0 e conter foto cadastrada será retornado o conteúdo HTTP do tipo:
Content-Type: image/jpeg
API para retornar dados após data
Endpoint (GET): /api/aca/getdados
Parâmetros:
token = Passar o token informado pelo Sistema Aula
tabela =
aca_fichacadastralaluno
aca_inscricaoalunocurso
fin_parcelas
aca_totalcreditosaluno
pes_servidores
situacao_inscricaoficha
aca_ficha_e_inscricao
aca_ficha_inscricao_cracha
pes_servidores_simples
aca_inscricaoalunocurso_login
data = Data e hora válida para selecionar os dados após esta data,
Formato: YYYY-MM-DD+HH-mm-SS Exemplo: 2020-03-14+14-38-32
matricula = Informa quando usar a tabela aca_inscricaoalunocurso_login
senacesso = Informa quando usar a tabela aca_inscricaoalunocurso_login, passar a senha do usuário em MD5
Exemplo de chamada API
https://colegio.cloud/nomeescola/api/aca/getdados?token=zOAxWUy5NAgnuZvekab4U6VjgEvn1lyD58508e5033e4489f6bdd19f5c60b5f9d&tabela=aca_inscricaoalunocurso&data=2021-03-14+14%3A38%3A32
https://colegio.cloud/nomeescola/api/aca/getdados?token=zOAxWUy5NAmnusverab4t6VjgRvn1lyD58508e5033e4489f6bdd19f5c60b5f9d&tabela=aca_inscricaoalunocurso_login&matricula=1003&data=2021-03-14+14-38-32&senacesso=aa68c75c7a77c87w97ft686b2fe68676
Respostas em JSON
{"status":false,"id":"2779","mensagem":"Token invalido"}
{"status":false,"id":"2790","mensagem":"Data invalida"}
{"status":false,"id":"2782","mensagem":"Nao foram encontrado o parametro data"}
{"status":false,"id":"2783","mensagem":"Nao foram encontrado o parametro tabela"}
Os dados serão em formato texto, sendo a primeira linha os campos de retorno separados com pipe |
Exemplo:
codigounidade|codigocurso|matricula|codigogrupohabilitacao|codigosituacaoalunoescola|codigoturno|alunoretido|anoinscricao|semestreinscricao|datainscricao|iac_cursar_programa_brasileiro|numero_contrato|iac_dt_ingresso_prouni|bac_co_campus|iac_data_alteracao_banco|iac_co_contrato_curso|serie_ead|aluno_ead
A cada registro retorna uma linha com os dados separados com pipe |
Exemplo:
1|002|1315|EF|4|1||2016|0|2016-05-03 00:00:00|||||2021-01-04 09:07:18|||
1|002|1404|EF|4|1||2016|0|2016-05-03 00:00:00|||||2021-01-05 09:00:54|||
1|002|1365|EF|3|1||2016|0|2016-05-03 00:00:00|||||2021-04-19 14:26:39|||
Respostas em JSON da tabela aca_inscricaoalunocurso_login
{"status":true,"id":"2260","mensagem":"Senha valida","matricula":"1003","codigounidade":"1","nome":"Davi Teste da Silva","email":"nome@email.com","acesso":"1003","senha":"aa68c75c7a77c87w97ft686b2fe68676","curso":"["EI","004"],"cod_unidade":"1","situacao":"1"}
API para enviar acesso de pessoas, por catracas, ponto digital, QRCode, App, ...
e/ou enviar a frequencia do aluno
Endpoint (GET): /api/aca/setacesso
Parâmetros:
token = Passar o token informado pelo Sistema Aula
unidade = Código da unidade
anosemestre = Período atual no Sistema Aula = Ano2021
operacao = logacesso (Somente gravar acesso de entrada, saida ou acesso indevido) /
logacessofrequencia (Gravar acesso de entrada, saida ou acesso indevido e executar a frequencia do aluno Presença ou Falta )
tipopessoa = 1 (aluno), 2 (Funcionário), 3 (Visitante)
codigopessoa = matrícula do aluno, código do funcionário, código do visitante, ...
datahora = Data e hora do evento de leitura,
Formato YYYY-MM-DD+HH-mm-SS, Exemplo: 2021-02-21+13-30-00
sentido = e / s (entrada/saída)
origem = código do dispositivo de leitura (código da catraca, código do app, código do leitor, ...)
estado = liberado / bloqueado
Exemplo de chamada API
Respostas em JSON
{"status":false,"id":"2779","mensagem":"Token invalido"}
{"status":false,"id":"2780","mensagem":"Nao foram encontradas as parametros"}
{"status":false,"id":"2781","mensagem":"Nao foram encontradas as parametros"}
{"status":false,"id":"2783","mensagem":"Nao foram encontrado o parametro operacao"}
{"status":false,"id":"2784","mensagem":"Nao foram encontrado o parametro anosemestre"}
{"status":false,"id":"2784","mensagem":"Nao foram encontrado o parametro unidade"}
{"status":false,"id":"2785","mensagem":"Nao foram encontrado o parametro tipopessoa"}
{"status":false,"id":"2786","mensagem":"Nao foram encontrado o parametro codigopessoa"}
{"status":false,"id":"2787","mensagem":"Nao foram encontrado o parametro datahora"}
{"status":false,"id":"2787","mensagem":"Nao foram encontrado o parametro sentido"}
{"status":false,"id":"2788","mensagem":"Nao foram encontrado o parametro origem"}
{"status":false,"id":"2789","mensagem":"Nao foram encontrado o parametro estado"}
{"status":false,"id":"2790","mensagem":"Data invalida"}
{"status":false,"id":"2793","mensagem":"A pessoa nao foi encontrada"}
{"status":false,"id":"2794","mensagem":"Ocorreu um problema ao inserir o Caf_LogAcesso ou Caf_AcessoIndevido"}
{"status":true,"id":"2795","mensagem":"Acesso Inserido com sucesso"}
{"status":false,"id":"2796","mensagem":"A pessoa nao foi encontrada"}
{"status":false,"id":"2797","mensagem":"Problema ao gerar Frequencia. Segunda PA. PA_ATU_FREQUENCIA_CATRACA"}
{"status":true,"id":"2798","mensagem":"Frequencia Inserida com sucesso"}
{"status":false,"id":"2799","mensagem":"Problema ao gerar Frequencia. primeira PA. PA_ATU_FREQUENCIADIARIA 0"}