Este documento tem como objetivo esclarecer a utilização das APIs pelo app.

API: api-01-verifica-usuario
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-01-
verifica-usuario

Página referência de acesso: /api/01_verifica_usuario_app.php

Objetivo: verificar se um usuário do aplicativo está cadastrado em algum processo

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 cpf – (cpf criptografado)
 cpfN – (nonce do cpf criptografado)
 fone – (telefone criptografado)
 foneN – (nonce do telefone criptografado)
 email – (email criptografado)
 emailN – (nonce do email criptografado)

Retornos:

Se usuário já estiver cadastrado como usuário do app

array('retorno' => FALSE, 'msg' => 'Usuário já Cadastrado!')

Se usuário ainda não estiver cadastrado como usuário do app e os campos cpf, fone e
email coincidirem com os campos cadastrados no processo é enviado um email para o
usuário com o código de segurança (tokenEmail) para validar o email dele.

array('retorno' => TRUE, 'tokenEmail' => “xxxxxxx”, 'Foi enviado um e-

mail com código de segurança para validação do cadastro!')

Se o email do usuário não for igual ao email cadastrado no processo

array('retorno' => FALSE, 'msg' => 'E-mail inválido!')

Se o fone do usuário não for igual ao fone cadastrado no processo

array('retorno' => FALSE, 'msg' => 'Telefone inválido!')

Se o usuário não for encontrado no processo (cpf, fone e email)

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado nos

Processos!')
API: api-02-cadastra-usuario
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-02-
cadastra-usuario

Página referência de acesso: /api/02_cadastra_usuario_app.php

Objetivo: inserir um usuário do aplicativo, após as validações

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 cpf – (cpf criptografado)
 cpfN – (nonce do cpf criptografado)
 fone – (telefone criptografado)
 foneN – (nonce do telefone criptografado)
 email – (email criptografado)
 emailN – (nonce do email criptografado)
 senha – (senha criptografada)
 senhaN – (nonce da senha criptografada)

Retornos:

Se usuário já estiver cadastrado como usuário do app

array('retorno' => FALSE, 'msg' => 'Usuário já Cadastrado!')

Se os campos cpf, fone e email coincidirem com os campos cadastrados no processo

o usuário é inserido na tabela usuarioapp.

array('retorno' => TRUE, 'tokenUsuarioH' => “xxxxxxxxx”, 'nmUsuario'

=> “xxxxxxx”, 'nmUsuarioN' => “xxxxxxx”, 'msg' => 'Usuário cadastrado
com sucesso!')

Se os campos cpf, fone e email não coincidirem com os campos cadastrados no

processo.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado nos

Processos!')
API: api-03-faz-login-usuario
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-03-
faz-login-usuario

Página referência de acesso: /api/03_faz_login_usuario_app.php

Objetivo: validar o login do usuário no aplicativo

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 emailH – (hash do email)
 senhaH – (hash da senha)

Retornos:

Se email, senha e token coincidirem

array('retorno' => TRUE, 'idUsuarioApp' => $valor->idusuarioapp,

'nmUsuario' => $valor->nmusuario, 'nmUsuarioN' => $valor->nmusuarion,
'email' => $valor->email, 'emailN' => $valor->emailn,
'tpRepresLegal' => $valor->tprepreslegal, 'cpf' => $valor->cpf, 'cpfN'
=> $valor->cpfn, 'fone' => $valor->fone, 'foneN' => $valor->fonen,
'dadosFilhos' => $dadosFilhos, 'linkFotoFilhos' => $linkFotoFilhos,
'temas' => $dadosTemas, 'msg' => 'Login Efetuado com sucesso!')

Se os campos email e senha coincidirem e o tokenUsuarioH não coincidir, será

enviado um email com um código de segurança para o usuário inserir no app para
validar o novo dispositivo.

array('retorno' => FALSE, 'tokenEmail' => “XXXXXXXX”, 'tokenUsuarioH'

=> “XXXXXXXXXXX” ,'msg' => 'Houve uma tentativa de Login através de um
novo dispositivo, por favor, insira o código de validação enviado para
seu e-mail!')

Se os campos email e senha não coincidirem.

array('retorno' => FALSE, 'msg' => 'E-mail e/ou senha incorretos!')

API: api-04-verifica-email-troca-senha
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-04-
verifica-email-troca-senha

Página referência de acesso: /api/04_verifica_email_troca_senha_app.php

Objetivo: validar o e-mail do usuário para troca de senha

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 emailH – (hash do email)

Retornos:

Se email e token coincidirem, será enviado um e-mail com um código de segurança

para o usuário inserir no app para validar a troca de senha.

array('retorno' => TRUE, 'tokenEmail' => “XXXXXXXXX”, 'tokenUsuarioH'

=> “XXXXXXXXXXX” ,'msg' => 'Houve uma solicitação de troca de senha,
por favor, insira o código de segurança enviado para seu e-mail!')

Exemplo de Retorno

{"retorno":true,"tokenEmail":688263,"tokenUsuarioH":"$2y$10$g4JpRGnqbl
gDkFsFHvdtPeIwVHC38I1ahaa14jt2yHc67bzpCap0m","msg":"Houve uma
solicitação de troca de senha, por favor, insira o código de segurança enviado
para seu e-mail!"}

Se o campo email não coincidir.

array('retorno' => FALSE, 'msg' => 'E-mail incorreto!')

API: api-05-troca-senha
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-05-
troca-senha

Página referência de acesso: /api/05_troca_senha_app.php

Objetivo: validar alterar a senha do usuário tanto através do “esqueceu sua senha”
como logado internamente no aplicativo

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 senha – (senha criptografada)
 senhaN – (nonce da senha criptografada)

Retornos:

Se token coincidir

array('retorno' => TRUE, 'msg' => 'Troca de senha efetuada com

sucesso!')

Se o token não coincidir.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-06-lista-tema
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-06-
lista-tema

Página referência de acesso: /api/06_lista_tema_app.php

Objetivo: listar o conteúdo dos temas cadastrados

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 idTema – (id do tema a ser listado)

Retornos:

Se tokenVCh coincidir retorna os temas cadastrados

API: api-07-insere-historico
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-07-
insere-historico

Página referência de acesso: /api/07_insere_historico_app.php

Objetivo: inserir os dados dos temas no histórico

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)
 idFilho – (idFilho)
 idTema – (idTema)
 dtAcontecimento – (data do acontecimento)
 acontecimento – (dados selecionados vide abaixo)
 linkFotoPront – (imagem binária)
 linkReceitaMed – (imagem binária)
 linkBoletim – (imagem binária)

O campo acontecimento irá concentrar todos os dados selecionados pelos genitores

para compor o histórico. O campo deverá ser composto com a string, com os campos
separados por “#” conforme abaixo.

$dadosAcontecimento .= “vômito # febre # dor de cabeça # Especifique:

na escola";

Obs: as imagens binárias deverão ser enviadas no formato JSON abaixo

{
"image": {
"mime": "image/jpeg",
"data":
"/9j/4AAQSkZJRgABAQEAcQByAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB
AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/
2wBDAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBA
QEBAQEBAQEBAQEB"
}
}

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array('retorno' => TRUE, 'msg' => 'Histórico inserido com sucesso!')

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-08-lista-dados-filho
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-08-
lista-dados-filho

Página referência de acesso: /api/08_lista_dados_filho_app.php

Objetivo: listar os dados de um determinado filho no cadastro de filhos

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)
 idFilho – (idFilho)

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array($dadosFilhos)

Exemplo de Retorno Se Verdadeiro

[{"idfilho":1,"nmfilho":"aa2abf96aaa4d4fa5ffd5c0c90a61d3383a9e709838a5
1709d56f222","nmfilhon":"743b41e81cd9248e307d6dc6d3950db380ad7b72
a1225fac","dtnascimento":"6c306a1edb309725cb86d40731b0472519b45f72
7fb0f4e4bae9","dtnascimenton":"4a003f6ae50bd05adc8ee184a745d1a7852
ef1ded025a121","linkfotofilho":null,"linkfotorg":null,"linkfotoplanosaude":n
ull,"linkfotoplanosaude2":null,"linkfotocarteiravac":null,"nmescola":null,"nm
escolan":null,"contatoescola":null,"contatoescolan":null,"foneescola":null,"f
oneescolan":null,"unidmedref1":null,"unidmedref1n":null,"unidmedref2":nul
l,"unidmedref2n":null,"matriculaescola":null,"linkcalendanoletivo":null}]

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-09-atualiza-dados-filho
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-09-
atualiza-dados-filho

Página referência de acesso: /api/09_atualiza_dados_filho_app.php

Objetivo: atualizar os dados de um determinado filho no cadastro de filhos

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)
 idFilho – (idFilho)
 nmEscola – (nome da escola criptografado)
 nmEscolaN – (nonce do nome da escola)
 contatoEscola – (contado da escola criptografado)
 contatoEscolaN – (nonce do contato da escola)
 foneEscola – (fone da escola criptografado)
 foneEscolaN – (nonce do fone da escola)
 unidMedRef1 – (unidade de referência médica 1 criptografada)
 unidMedRef1N – (nonce da unidade de referência médica 1)
 unidMedRef2 – (unidade de referência médica 2 criptografada)
 unidMedRef2N – (nonce da unidade de referência médica 2)
 matriculaEscola – (matricula da escola – sem criptografar)
 linkFotoFilho – (imagem binária)
 linkFotoRgFrente – (imagem binária)
 linkFotoRgVerso – (imagem binária)
 linkFotoPlanoSaude – (imagem binária)
 linkFotoPlanoSaude2 – (imagem binária)
 linkFotoCarteiraVac – (imagem binária)
 linkCalendAnoLetivo – (imagem binária)

Obs: as imagens binárias deverão ser enviadas no formato JSON abaixo

{
"image": {
"mime": "image/jpeg",
"data":
"/9j/4AAQSkZJRgABAQEAcQByAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB
AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/
2wBDAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBA
QEBAQEBAQEBAQEB"
}
}

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array('retorno' => TRUE, 'msg' => 'Dados do Filho atualizados com
sucesso!')

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-10-lista-dados-usuario
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-10-
lista-dados-usuario

Página referência de acesso: /api/10_lista_dados_usuario_app.php

Objetivo: listar os dados do usuário no cadastro de Pai/Mãe

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array($dadosUsuarioApp)

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-11-lista-dados-historico
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-11-
lista-dados-historico

Página referência de acesso: /api/11_lista_dados_historico_app.php

Objetivo: listar os dados do histórico inseridos pelos pais

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array($dadosHistorico)

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-12-mostra-regra-convivencia
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-12-
mostra-regra-convivencia

Página referência de acesso: /api/12_mostra_regra_convivencia_app.php

Objetivo: listar os dados do histórico inseridos pelos pais

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array($regraConvivencia)

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

API: api-13-atualiza-termo-privacidade
Link: http://vidacompartilhada-env.eba-ir2pngfi.us-west-2.elasticbeanstalk.com/api-13-
atualiza-termo-privacidade

Página referência de acesso: /api/13_atualiza_termo_privac_usuario_app.php

Objetivo: setar como NULL os aceites do termo de privacidade e uso de cookies

Nome dos Campos a serem passados por “Post”:

 tokenVCh – (hash do tokenVCh – arquivo key)

 tokenUsuarioH – (tokenUsuarioH)
 idUsuarioApp – (idUsuarioApp)
 indAceitaTermoPrivac – (se o usuário aceita ou não o termo de privacidade e
uso de cookies)

Retornos:

Se tokenVCh e tokenUsuarioH coincidirem

array('retorno' => TRUE, 'indAceitaTermoPrivac' =>

$_POST['indAceitaTermoPrivac'], 'msg' => 'Termo de Privacidade do
Usuário atualizado com sucesso!')

Se não coincidirem.

array('retorno' => FALSE, 'msg' => 'Usuário não encontrado!')

array('retorno' => FALSE, 'msg' => 'TokenVCh Inválido!')