Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEP.
Orientações gerais, autenticação e exemplos de consumo das API's.
Ao executar a chamada da API, serão realizadas as seguintes operações:
Criação/Atualização do Responsavel Financeiro do Aluno;
Criação/Atualização do Aluno
Criação da Matricula do Aluno (Habilitacao, Periodo Letivo e Disicplinas)
Criação do Pré Contrato CRM no SGE.
Efetivação do contrato no ERP.
Tabelas Afetadas: FCFO, PPESSOA, SALUNO, SHABILITACAOALUNO, SMATRICPL, SMATRICULA
Interfaces RM:
TOTVS BackOffice | Gestão Financeira | Cadastros | Cliente/Fornecedor
TOTVS Educacional | Educacional | Currículo e Oferta | Alunos
TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Anexo | Matricula no Período Letivo | Anexo | Matriculas em disciplinas
TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Aluno | Anexo | Matriculas em disciplinas
Username <username>
Password <password>
Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.
Exemplo de utilização - Sucesso:
• username
• password
A requisição deve parecer com a abaixo
O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.
Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:
Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:
• Authorization: Bearer {token}
Inclusão do token no cabeçalho da requisição:
Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.
Requisição realizada na API de Usuário utilizando o token gerado:
Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.
{ "respFinanceiro":{ "codColigada":3, "classificacao":1, "categoria":"F", "nome":"Braian Veloz De Mais", "dataNascimento":"2000-08-20", "email":"[email protected]", "estadoCivil":null, "nacionalidade":0, "cgcCfo":"30780320000", "cI_Orgao":null, "cI_UF":"PR", "cI_numero":null, "telefone":"41985742365", "celular":"000000", "telefoneComercial":"000000", "tipoBairro":1, "tipoRua":1, "bairro":"Conjunto Habitacional Boa Vista", "logradouro":"Rua Mário Cardoso Júnior", "numero":"12", "complemento":null, "cep":"38180733", "estado":"PR", "codMunicipio":"02109", "idPais":1 }, "aluno":{ "codColigada":3, "codTipoAluno":1, "codFilial":3016, "codTipoCurso":1, "nome":"Vei Do Rio", "nomeSocial":"Veio", "sexo":"F", "dataNascimento":"1988-05-23T00:00:00", "corRaca":"2", "nacionalidade":"10", "email":"[email protected]", "estadoCivil":"S", "estadoNatal":"PR", "naturalidade":"01903", "telefone1":"42999377381", "telefone2":"31993424866", "telefone3":null, "ci_numero":"13.379.055-1", "ci_uf":null, "ci_dtemissao":null, "ci_emissor":"SSP", "cpf":"50784804044", "tipoBairro":1, "tipoRua":1, "bairro":"Birim Birim", "logradouro":"Rua Ze Cardoso Júnior", "numero":"1158", "complemento":null, "cep":"38180733", "codMunicipio":"01903", "estado":"PR", "idPais":1, "codProfissao":1, "grauInstrucao":"5", "situacaoOcupacional":"1", "tipoEscolaOrigem":"1", "pai":{ "nome":"TESTE PAI", "nomeSocial":"PAPA", "sexo":"M", "dataNascimento":"1988-05-19T00:00:00", "corRaca":null, "nacionalidade":"10", "email":null, "estadoCivil":null, "estadoNatal":"PR", "naturalidade":"4120705", "telefone1":"42999377381", "telefone2":null, "cI_numero":"13.379.055-1", "cI_UF":null, "cI_dtEmissao":null, "cI_Orgao":"SSP", "cpf":"455.351.820-10", "tipoBairro":1, "tipoRua":1, "bairro":"Conjunto Habitacional Boa Vista", "logradouro":"Rua Mário Cardoso Júnior", "numero":1158, "complemento":null, "cep":"38180733", "codMunicipio":"4120705", "estado":"PR", "idPais":55, "codProfissao":null, "grauInstrucao":null }, "mae":{ "nome":"MAE TESTE", "nomeSocial":"MAMA", "sexo":"F", "dataNascimento":"1988-05-19T00:00:00", "corRaca":null, "nacionalidade":"10", "email":null, "estadoCivil":null, "estadoNatal":"PR", "naturalidade":"4120705", "telefone1":"42999377381", "telefone2":null, "cI_numero":"13.379.055-1", "cI_UF":null, "cI_dtEmissao":null, "cI_Orgao":"SSP", "cpf":"455.351.820-10", "tipoBairro":1, "tipoRua":1, "bairro":"Conjunto Habitacional Boa Vista", "logradouro":"Rua Mário Cardoso Júnior", "numero":1158, "complemento":null, "cep":"38180733", "codMunicipio":"4120705", "estado":"PR", "idPais":55, "codProfissao":null, "grauInstrucao":null, "situacaoOcupacional":"1", "tipoEscolaOrigem":"1" } }, "matricula":{ "codcoligada":3, "codFilial":3016, "codTipoCurso":1, "idHabilitacaoFilial":66620, "codTurma":"APP-I-G00455/2022", "idPerlet":3658, "periodo":"1", "campusPolo":"1", "tipoMatricula":1, "dataMatricula":"2022-08-08", "camposComplementares":{ "dataPrevistaSaida":"2022-12-20", "tipoGrat":"0", "codFinanc":"1", "categoria":"5", "viraVida":"0", "seloOds":"0", "ebep":"0", "tempoIntegral":"0", "gratuidade":"0", "baixaRenda":"0", "portalTransp":"0" }, "preContratoCrm":{ "tipoContrato":"7", "modContrato":"002", "desContrato":"Descrição Modelo Contrato", "valorTotal":1150.00, "qtDeParcelas":1, "valorDesconto":234.00, "tipoDesconto":"V", "obsDesconto":"Obs. Desconto", "workload":"180", "valorAplicadoCurso":0, "dtInicioContrato":"2022-05-30T00:00:00", "dtFimContrato":"2022-11-30T00:00:00", "adesaoOdonto":true, "itemVendaodonto":"Item Venda Odonto", "valorItemOdonto":150, "itemVendaOfertada":"Item Venda Ofertada", "numPreContrato":"9876543999" } } }
Content
Responsável Financeiro
Aluno
Matricula
Campos Complementares
Pré Contrato CRM
{ "Status": "Sucesso", "Mensagem": "Responsável Financeiro Criado/Atualizado com Sucesso !\r\nAluno Criado/Atualizado com Sucesso !\r\nMatricula Criada/Atualizada com Sucesso !", "DadosCriados": { "CodColigada": 3, "Ra": "00878180", "CPF": 123131331, "Nome": Rafael da Silva Sauro, "CodCFO": "01737437", "IdPreContrato": null }, "DetalheErros": { "IdErro": null, "ExceptionType": null, "InnerException": null } }
Content
Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:
Atualizar os dados do aluno no SGE, identificado através do CPF enviado.
Tabela Afetada: PPESSOA, SALUNO
Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos
Username <username>
Password <password>
Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.
Exemplo de utilização - Sucesso:
• username
• password
A requisição deve parecer com a abaixo
O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.
Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:
Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:
• Authorization: Bearer {token}
Inclusão do token no cabeçalho da requisição:
Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.
Requisição realizada na API de Usuário utilizando o token gerado:
Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.
{ "codColigada": 3, "codTipoAluno": 1, "codFilial": 3016, "codTipoCurso": 1, "nome":"Vei Do Rio", "nomeSocial": "Veio", "sexo":"F", "dataNascimento":"1988-05-23T00:00:00", "corRaca": "2", "nacionalidade":"10", "email": "[email protected]", "estadoCivil": "S", "estadoNatal":"PR", "naturalidade":"01903", "telefone1":"42999377381", "telefone2": "31993424866", "telefone3": null, "ci_numero":"13.379.055-1", "ci_uf":null, "ci_dtemissao":null, "ci_emissor":"SSP", "cpf": "50784804044", "tipoBairro":1, "tipoRua":1, "bairro":"Birim Birim", "logradouro":"Rua Ze Cardoso Júnior", "numero": "1158", "complemento": null, "cep": "38180733", "codMunicipio": "01903", "estado": "PR", "idPais": 1, "codProfissao": 1, "grauInstrucao": "5", "situacaoOcupacional": "1", "tipoEscolaOrigem": "1" }
Content
Aluno
{ "Status": "Sucesso", "Mensagem": "Aluno Criado/Atualizado com Sucesso !", "DadosCriados": { "CodColigada": null, "Ra": "00878180", "Nome": Rafael da Silva Sauro, "CPF": 123131331, "CodCFO": null, "CodFilial": 3015, "IdHabilitacaoFilial: 7111, "IdPerlet": 3800, "CodTurma": "TEC-M-000152/2023", "IdPreContrato": 266262, "IdUnico": 10 }, "DetalheErros": { "IdErro": null, "ExceptionType": null, "InnerException": null } }
Content