Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração CRM
Orientações gerais, autenticação e exemplos de consumo das API's.
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.
Ao executar a chamada da API, serão realizadas as seguintes operações:
Criação/Atualização do Pai do Aluno;
Criação/Atualização da Mãe do Aluno;
Criação/Atualização do Responsável Acadêmico do Aluno;
Criação/Atualização do Responsável Financeiro do Aluno;
Criação/Atualização do Aluno;
Criação da Matricula do Aluno (Habilitação, Período Letivo e Disciplinas);
Criação do Pré Contrato CRM no SGE;
Tabelas Afetadas: FCFO, PPESSOA, SALUNO, SHABILITACAOALUNO, SMATRICPL, SMATRICULA, ZPRECONTRATOCRM
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 | Aba | Responsáveis
TOTVS Educacional | Educacional | Currículo e Oferta | Alunos | Anexo | Cursos / Habilitações
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 | Anexo | Matriculas em disciplinas
TOTVS Educacional | Educacional | Matricula e Avaliação | Matricula no Período Letivo | Anexo | Pré Contratos CRM
{ "Pai": { "Bairro": "Centro", "CartIdentidade": "7849", "Cep": "83840000", "Cidade": "QUITANDINHA", "CodNaturalidade": "4106902", "CodProfissao": 49, "CodTipoBairro": 1, "CodTipoRua": 1, "Complemento": "Mansão", "CorRaca": 8, "Cpf": "49704304382", "CpfMotivo": null, "DeficienteAuditivo": false, "DeficienteFala": false, "DeficienteFisico": false, "DeficienteMental": false, "DeficienteVisual": false, "DtEmissaoIdent": "2020-07-14T00:00:00-03:00", "DtNascimento": "1959-07-14T00:00:00-03:00", "Email": "[email protected]", "Estado": "PR", "EstadoCivil": "S", "EstadoNatal": "PR", "GrauInstrucao": "7", "IdPais": 10, "Nacionalidade": "10", "Nome": "PAI TOTVS YCEHZUD FUAIEVS", "Numero": "1", "OrgEmissorIdent": "SSP", "Rua": "Horácio Gonsalves do Vale", "Sexo": "M", "Telefone1": "41196734000", "Telefone2": "41196734001", "UfCartIdent": "PR" }, "Mae": { "Bairro": "Centro", "CartIdentidade": "4553", "Cep": "83840000", "Cidade": "QUITANDINHA", "CodNaturalidade": "4106902", "CodProfissao": 49, "CodTipoBairro": 1, "CodTipoRua": 1, "Complemento": "Mansão", "CorRaca": 8, "Cpf": "65492227963", "CpfMotivo": null, "DeficienteAuditivo": false, "DeficienteFala": false, "DeficienteFisico": false, "DeficienteMental": false, "DeficienteVisual": false, "DtEmissaoIdent": "2020-07-14T00:00:00-03:00", "DtNascimento": "1952-02-22T00:00:00-03:00", "Email": "[email protected]", "Estado": "PR", "EstadoCivil": "S", "EstadoNatal": "PR", "GrauInstrucao": "7", "IdPais": 10, "Nacionalidade": "10", "Nome": "MAE TOTVS GCYSJZH QHKXEEJ", "Numero": "1", "OrgEmissorIdent": "SSP", "Rua": "Horácio Gonsalves do Vale", "Sexo": "F", "Telefone1": "41196734000", "Telefone2": "41196734001", "UfCartIdent": "PR" }, "RespAcademico": { "Bairro": "Centro", "CartIdentidade": "4553", "Cep": "83840000", "Cidade": "QUITANDINHA", "CodNaturalidade": "4106902", "CodProfissao": 49, "CodTipoBairro": 1, "CodTipoRua": 1, "Complemento": "Mansão", "CorRaca": 8, "Cpf": "65492227963", "CpfMotivo": null, "DeficienteAuditivo": false, "DeficienteFala": false, "DeficienteFisico": false, "DeficienteMental": false, "DeficienteVisual": false, "DtEmissaoIdent": "2020-07-14T00:00:00-03:00", "DtNascimento": "1952-02-22T00:00:00-03:00", "Email": "[email protected]", "Estado": "PR", "EstadoCivil": "S", "EstadoNatal": "PR", "GrauInstrucao": "7", "IdPais": 10, "Nacionalidade": "10", "Nome": "MAE TOTVS GCYSJZH QHKXEEJ", "Numero": "1", "OrgEmissorIdent": "SSP", "Rua": "Horácio Gonsalves do Vale", "Sexo": "F", "Telefone1": "41196734000", "Telefone2": "41196734001", "UfCartIdent": "PR" }, "RespFinanceiro": { "Bairro": "Centro", "Cep": "83840000", "CgcCfo": "65492227963", "CI_Orgao": "SSP", "CI_UF": "PR", "CIdentidade": "4553", "CodColigada": 2, "CodEtd": "PR", "CodMunicipio": "4106902", "Complemento": "Mansão", "DtNascimento": "1952-02-22T00:00:00-03:00", "Email": "[email protected]", "EstadoCivil": "S", "IdPais": 1, "Nacionalidade": 0, "Nome": "MAE TOTVS GCYSJZH QHKXEEJ", "Numero": "1", "PagRec": 1, "PessoaFisOuJur": "F", "Rua": "Horácio Gonsalves do Vale", "Telefone": "41196734000", "Telex": null, "CodTipoBairro": 1, "CodTipoRua": 1 }, "Aluno": { "Bairro": "Centro", "CartIdentidade": "6874", "Cep": "83840000", "Cidade": "QUITANDINHA", "CodNaturalidade": "4106902", "CodProfissao": 49, "CodTipoBairro": 1, "CodTipoRua": 1, "Complemento": "Mansão", "CorRaca": 8, "Cpf": "52856401805", "CpfMotivo": null, "DeficienteAuditivo": false, "DeficienteFala": false, "DeficienteFisico": false, "DeficienteMental": false, "DeficienteVisual": false, "DtEmissaoIdent": "2020-07-14T00:00:00-03:00", "DtNascimento": "2012-08-20T00:00:00-03:00", "Email": "[email protected]", "Estado": "PR", "EstadoCivil": "S", "EstadoNatal": "PR", "GrauInstrucao": "7", "IdPais": 10, "Nacionalidade": "10", "Nome": "ALUNO TOTVS BILIEFW ALWNBVA", "Numero": "1", "OrgEmissorIdent": "SSP", "Rua": "Horácio Gonsalves do Vale", "Sexo": "M", "Telefone1": "41196734000", "Telefone2": "41196734001", "UfCartIdent": "PR" }, "Turma": { "Codcoligada": 2, "CodFilial": 2013, "CodTurma": "FSW_SESI_0001", "IdPerlet": 893, "CodTipoMatricula": 1, "Periodo": 1 }, "PreContratoCRM": { "NumPreContrato": "NWXCCWS", "TipoContrato": "7", "ModContrato": "543", "DesContrato": "Contrato teste TOTVS", "ValorTotal": 1200.0, "QtdeParcelas": 3, "ValorDesconto": 300.0, "TipoDesconto": "V", "ObsDesconto": "Observação teste", "Workload": null, "DtInicioContrato": "2023-07-14T00:00:00-03:00", "DtFimContrato": "2024-01-30T00:00:00-03:00", "ValorAplicadoCurso": 900.0, "AdesaoOdonto": false, "ItemVendaOdonto": null, "ValorItemOdonto": 0.0, "ItemVendaOfertada": "SS000687" } }
Content
Pai
Mãe
Responsável Acadêmico
Responsável Financeiro
Aluno
Turma
PreContratoCRM
{ "Retorno": "Integração com CRM realizada com sucesso.", "Status": true, "Pessoa": { "Codigo": 2048034 }, "Aluno": { "Codcoligada": 3, "RA": "00959015" }, "Fcfo": { "Codcoligada": 2, "CodCfo": "01786265", "CGCCFO": "67115983003" }, "Turma": { "Codcoligada": 3, "CodFilial": 3057, "CodTurma": "APP-V-000337/2023", "IdPerlet": 3887, "IdPreMatricula": null }, "PreContrato": { "Codcoligada": 3, "CodFilial": 3057, "CodTurma": "APP-V-000337/2023", "IdPerlet": 3887, "IdPreMatricula": null, "IdPreContrato": 18549 } }
Content
Pessoa
Aluno
Fcfo
Turma
PreContrato