Application Programming Interface - Modelo de Dados MARIN

Visão Geral

Este guia apresenta a interface de programação de aplicativos (API) com a plataforma e modelo de dados da MARIN. Ele descreve várias operações da API, estruturas de requisições e resposta relacionadas, códigos de erro. A versão atual da API é a 1.0.

Bem-vindo à API da MARIN

Essa API é construída para permitir que você crie uma integração rápida e facilmente. O ecossistema de desenvolvedores criando integrações com a API é amplo e diversificado.

Todos os recursos da API são organizadas em torno de REST, então, se você já interagiu com uma API RESTful, muitos dos conceitos serão familiares. Todas as chamadas de API para a plataforma MARIN devem ser feitas para o domínio base https:///apiAPPDO. Usamos muitos recursos HTTP padrão, como verbos HTTP, que podem ser entendidos por muitos clients HTTP.

Um JSON será retornado em todas as respostas da API, incluindo casos de erro. As APIs são projetadas para ter URLs previsíveis, diretas e usar os códigos de resposta HTTP para indicar erros da API.

Core

API	Description
POST core/MontaRelatorioDashboardMamp?client_id={client_id}	No documentation available.
POST core/EnviarWhatsappJetSales?client_id={client_id}	No documentation available.
POST core/AceitarPoliticaPrivacidade?client_id={client_id}	No documentation available.
POST core/GravaComportamentoDiario?client_id={client_id}	No documentation available.
POST core/GravarIndicadoresSaude?client_id={client_id}	No documentation available.
POST core/ConsultarIndicadoresComportamentais?client_id={client_id}	No documentation available.
POST core/ConsultarDicaAleatoria?client_id={client_id}	No documentation available.
POST core/ConsultarAvataresApp?client_id={client_id}	No documentation available.
POST core/AceitarConviteEquipeContrato?client_id={client_id}	No documentation available.
POST core/CriarEquipeContrato?client_id={client_id}	No documentation available.
POST core/RecusarConviteEquipeContrato?client_id={client_id}	No documentation available.
POST core/RecusarSolicitacaoEntradaEquipeContrato?client_id={client_id}	No documentation available.
POST core/SelecionaAvatarApp?client_id={client_id}	No documentation available.
POST core/ConvidarEquipeContrato?client_id={client_id}	No documentation available.
POST core/SolicitarEntradaEquipeContrato?client_id={client_id}	No documentation available.
POST core/ConsultarRepresentantesContratoTurma?client_id={client_id}	No documentation available.
POST core/ConsultarEquipeContrato?client_id={client_id}	No documentation available.
POST core/ConsultarEquipesApp?client_id={client_id}	No documentation available.
POST core/ConsultarObjetivosContrato?client_id={client_id}	No documentation available.
POST core/ConsultarProdutosServicos?client_id={client_id}	No documentation available.
POST core/ConsultarMetasContrato?client_id={client_id}	No documentation available.
POST core/GravaObjetivosContrato?client_id={client_id}	No documentation available.
POST core/ConcluirDesconcluirTarefasExecutor?client_id={client_id}	No documentation available.
POST core/GravaMetaContrato?client_id={client_id}	No documentation available.
POST core/ExcluirMetaContrato?client_id={client_id}	No documentation available.
POST core/ExcluirTodasMetasContrato?client_id={client_id}	No documentation available.
POST core/GravarVisualizacaoObjetivoPercentualPremiacoes?client_id={client_id}	No documentation available.
POST core/ConsultarIndicadoresSaude?client_id={client_id}	No documentation available.
POST core/ConsultarIndicadoresSaudeAtuaisCliente?client_id={client_id}	No documentation available.
POST core/ConsultarAtividadesAgendaExecutor?client_id={client_id}	No documentation available.
POST core/ConsultarAtividadesAgrupadoresTrilha?client_id={client_id}	No documentation available.
POST core/ConsultarQuestionariosContrato?client_id={client_id}	No documentation available.
POST core/ConsultarCampanhas?client_id={client_id}	No documentation available.
POST core/ConsultarPoderes?client_id={client_id}	No documentation available.
POST core/ConsultarAlunos?client_id={client_id}	No documentation available.
POST core/ConsultarUsuarios?client_id={client_id}	No documentation available.
POST core/InserirRotasAPI?client_id={client_id}	No documentation available.
POST core/ConsultarPlataformasEcommerces?client_id={client_id}	No documentation available.
POST core/ConsultarDisciplinasEmCurso?client_id={client_id}	No documentation available.
POST core/ConsultarRequerimentosAluno?client_id={client_id}	No documentation available.
POST core/ConsultarPets?client_id={client_id}	No documentation available.
POST core/ConsultarDependentes?client_id={client_id}	No documentation available.
POST core/GravarPermissoesDependente?client_id={client_id}	No documentation available.
POST core/IncluirAlterarPets?client_id={client_id}	No documentation available.
POST core/ConsultarGEVEventosSHOP?client_id={client_id}	No documentation available.
POST core/ConsultarGEVIngressosEventosSHOP?client_id={client_id}	No documentation available.
POST core/GravarGEVVendas?client_id={client_id}	No documentation available.
POST core/ConsultarFraquezas?client_id={client_id}	No documentation available.
POST core/ConsultarVirtudes?client_id={client_id}	No documentation available.
POST core/ConsultarPercentualClientesPremiacoes?client_id={client_id}	No documentation available.
POST core/ConsultarRankingCampanha?client_id={client_id}	No documentation available.
POST core/ConsultarExecutoresContrato?client_id={client_id}	No documentation available.
POST core/ConsultarClientesDoExecutor?client_id={client_id}	No documentation available.
POST core/ConsultarClientesDoExecutorAPP?client_id={client_id}	No documentation available.
POST core/ConsultarQuestionario?client_id={client_id}	No documentation available.
POST core/ConsultarAgrupadoresTrilhaModelo?client_id={client_id}	No documentation available.
POST core/EstatisticasComportamentoDiarioPrincipaisAnoAtual?client_id={client_id}	No documentation available.
POST core/EstatisticasComportamentoDiarioPrincipaisDonuts?client_id={client_id}	No documentation available.
POST core/ConsultarDesempenhoMetaSemanalCliente?client_id={client_id}	No documentation available.
POST core/ConsultarComportamentoDiarioPrincipais?client_id={client_id}	No documentation available.
POST core/ConsultarDatasComportamentoDiario?client_id={client_id}	No documentation available.
POST core/ConsultarAchievementsCliente?client_id={client_id}	No documentation available.
POST core/ConsultarDatasAtividadeExecutor?client_id={client_id}	No documentation available.
POST core/PegaInformacoesCliente?client_id={client_id}	No documentation available.
POST core/ConsultarDatasIndicadoresSaude?client_id={client_id}	No documentation available.
POST core/ConsultarIndicadoresComportamentaisComportamentoDiario?client_id={client_id}	No documentation available.
POST core/ConsultarTurmasDesenvolvimentoEmpresarial?client_id={client_id}	No documentation available.
POST core/ConsultarEvolucaoIndicadoresSaude?client_id={client_id}	No documentation available.
POST core/BuscarDadosSaudeLancados?client_id={client_id}	No documentation available.
POST core/ConsultarChecklistsEmAlerta?client_id={client_id}	No documentation available.
POST core/ConsultarOrdensServicoPaginadas?client_id={client_id}	No documentation available.
POST core/RegistrarDISC?client_id={client_id}	No documentation available.
GET core/GetEmpresas?client_id={client_id}	No documentation available.
GET core/GetEmpresa?client_id={client_id}&cnpj={cnpj}&codigoempresa={codigoempresa}	No documentation available.
POST core/AlteraInfoPrincipaisParceiros?client_id={client_id}	No documentation available.
POST core/GravarQuestionarioResposta?client_id={client_id}	No documentation available.
POST core/GravaExecucaoTarefaContrato?client_id={client_id}	No documentation available.
POST core/AlterarApelidoAPP?client_id={client_id}	No documentation available.
POST core/AlterarVirtudes?client_id={client_id}	No documentation available.
POST core/AlterarPoderes?client_id={client_id}	No documentation available.
POST core/AlterarFraquezas?client_id={client_id}	No documentation available.

Academico

API	Description
POST academico/ApurarDesempenho?client_id={client_id}	No documentation available.
POST academico/SIGA2ImportarFinanceiroAlunoParcela?client_id={client_id}	No documentation available.
POST academico/SIGA2ExportarMatricula?client_id={client_id}	No documentation available.

Cadastro

API	Description
GET cadastro/GetCadastros?client_id={client_id}&CPF={CPF}&ParceiroID={ParceiroID}&MatriculaID={MatriculaID}	No documentation available.

B2B

API	Description
GET b2b/GetCanais?client_id={client_id}	No documentation available.
GET b2b/GetProdutos?client_id={client_id}&CanalID={CanalID}	No documentation available.
POST b2b/Venda?client_id={client_id}	No documentation available.
POST b2b/VendaRubeus?client_id={client_id}	No documentation available.
POST b2b/CancelarVenda?client_id={client_id}	No documentation available.

Auth

API	Description
POST token	No documentation available.
POST VerificaLoginEmail?client_id={client_id}	No documentation available.
POST VerificaLoginAPP?client_id={client_id}	No documentation available.
POST VerificaLoginAluno?client_id={client_id}	No documentation available.
POST ConsultarVersaoMobile?client_id={client_id}	No documentation available.
POST AlterarSenhaParceiro?client_id={client_id}	No documentation available.
POST VincularFacebook?client_id={client_id}	No documentation available.
POST DesvincularFacebook?client_id={client_id}	No documentation available.
POST VincularApple?client_id={client_id}	No documentation available.
POST DesvincularApple?client_id={client_id}	No documentation available.

Moodle

API	Description
GET moodle/GetInadimplenteSSOMicrosoft?client_id={client_id}&emailSSOMicrosoft={emailSSOMicrosoft}	No documentation available.

Boleto

API	Description
POST boleto/AddBoleto?client_id={client_id}&codigoBanco={codigoBanco}&ambienteproducao={ambienteproducao}	No documentation available.
GET boleto/GetBoletos?codigoBanco={codigoBanco}&codigoAgencia={codigoAgencia}&codigoConta={codigoConta}&client_id={client_id}&ambienteproducao={ambienteproducao}	No documentation available.
GET boleto/GetBoleto?codigoBanco={codigoBanco}&codigoAgencia={codigoAgencia}&codigoConta={codigoConta}&numeroConvenio={numeroConvenio}&nossoNumero={nossoNumero}&client_id={client_id}&ambienteproducao={ambienteproducao}	No documentation available.
PATCH boleto/PatchBoleto?codigoBanco={codigoBanco}&nossoNumero={nossoNumero}&client_id={client_id}&ambienteproducao={ambienteproducao}	No documentation available.
POST boleto/CancelBoleto?codigoBanco={codigoBanco}&nossoNumero={nossoNumero}&client_id={client_id}&ambienteproducao={ambienteproducao}	No documentation available.

Educacional

API	Description
POST educacional/MontaRelatorioMatriculasTurmas?client_id={client_id}	No documentation available.
GET educacional/getTurmasVendas?client_id={client_id}	No documentation available.
GET educacional/getConsultores?client_id={client_id}	No documentation available.
GET educacional/ConsultarAreaSaber?client_id={client_id}	No documentation available.
POST educacional/InserirAreaSaber?client_id={client_id}	No documentation available.
GET educacional/ExcluirAreaSaber?client_id={client_id}&AreaID={AreaID}	No documentation available.
POST educacional/MontaTabelaArea?client_id={client_id}	No documentation available.
GET educacional/DesativarAreaSaber?client_id={client_id}&AreaID={AreaID}	No documentation available.
POST educacional/ConsultarClassCurso?client_id={client_id}	No documentation available.
POST educacional/GravarClassCurso?client_id={client_id}	No documentation available.
GET educacional/ExcluirClassCurso?client_id={client_id}&CLASSCURSOID={CLASSCURSOID}	No documentation available.
POST educacional/MontaTabelaClassCurso?client_id={client_id}	No documentation available.
GET educacional/ConsultarDocumentacoes?client_id={client_id}	No documentation available.
POST educacional/GravarDocumentacoes?client_id={client_id}	No documentation available.
GET educacional/ExcluirDocumentacoes?client_id={client_id}&DOCUMENTACAOID={DOCUMENTACAOID}	No documentation available.
POST educacional/MontaTabelaDocumentacoes?client_id={client_id}	No documentation available.
GET educacional/DesativarDocumentacoes?client_id={client_id}&DOCUMENTACAOID={DOCUMENTACAOID}	No documentation available.
GET educacional/ConsultarEixoAprendizagem?client_id={client_id}	No documentation available.
POST educacional/GravarEixoAprendizagem?client_id={client_id}	No documentation available.
GET educacional/ExcluirEixoAprendizagem?client_id={client_id}&EixoID={EixoID}	No documentation available.
POST educacional/MontaTabelaEixoAprendizagem?client_id={client_id}	No documentation available.
GET educacional/DesativarEixoAprendizagem?client_id={client_id}&EixoID={EixoID}	No documentation available.
GET educacional/SIGA2Pais?client_id={client_id}	No documentation available.
GET educacional/SIGA2UF?client_id={client_id}	No documentation available.
GET educacional/SIGA2CID?client_id={client_id}	No documentation available.
GET educacional/SIGA2Cargo?client_id={client_id}&userid={userid}	No documentation available.
GET educacional/SIGA2Instituicao?client_id={client_id}	No documentation available.
GET educacional/SIGA2AreaDeConhecimento?client_id={client_id}	No documentation available.
GET educacional/SIGA2Titulacao?client_id={client_id}	No documentation available.
GET educacional/SIGA2NivelCurso?client_id={client_id}	No documentation available.
GET educacional/SIGA2OrgaoEmissor?client_id={client_id}	No documentation available.
GET educacional/SIGA2EstadoCivil?client_id={client_id}	No documentation available.
GET educacional/ConsultarCrmProtocolo?client_id={client_id}	No documentation available.
POST educacional/GravarCrmProtocolo?client_id={client_id}	No documentation available.
GET educacional/ExcluirCrmProtocolo?client_id={client_id}&ProtocoloID={ProtocoloID}	No documentation available.
POST educacional/MontaTabelaCrmProtocolo?client_id={client_id}	No documentation available.
GET educacional/ConsultarCrmAtendimentos?client_id={client_id}	No documentation available.
POST educacional/GravarCrmAtendimento?client_id={client_id}	No documentation available.
GET educacional/ConsultarCrmAssuntos?client_id={client_id}	No documentation available.
POST educacional/GravarCrmAssuntos?client_id={client_id}	No documentation available.
GET educacional/ExcluirCrmAssuntos?client_id={client_id}&AssuntoID={AssuntoID}	No documentation available.
GET educacional/ConsultarCrmTipoAtendimento?client_id={client_id}	No documentation available.
GET educacional/MontaTabelaCrmAtendimentos?client_id={client_id}	No documentation available.
GET educacional/ConsultarCrmPerfis?client_id={client_id}	No documentation available.
GET educacional/ConsultarCrmFormaContato?client_id={client_id}	No documentation available.
GET educacional/ConsultarProximoAtendimento?client_id={client_id}	No documentation available.
GET educacional/ConsultarProximoAtendente?client_id={client_id}	No documentation available.
GET educacional/ConsultarAnexosCrmAtendimento?client_id={client_id}	No documentation available.
GET educacional/ConsultarAnexosCrmPerfis?client_id={client_id}	No documentation available.
POST educacional/ConlcuirCrmProtocolo?client_id={client_id}	No documentation available.
POST educacional/ProcessaDiario?client_id={client_id}	No documentation available.

Financeiro

API	Description
POST financeiro/AlterarSituacaoCobrancaTitulos?client_id={client_id}	No documentation available.
POST financeiro/ConsultarNotasLivrosJsonDataTable?client_id={client_id}	No documentation available.
POST financeiro/AtualizaProtocolNfeLivros?client_id={client_id}	No documentation available.
POST financeiro/FaturarLivros?client_id={client_id}	No documentation available.
POST financeiro/CancelarNFE?client_id={client_id}	No documentation available.
POST financeiro/BaixaAsaasWebHook?client_id={client_id}	No documentation available.
POST financeiro/VencimentoAsaasWebHook?client_id={client_id}	No documentation available.
POST financeiro/ProcessarBaixasBanco?client_id={client_id}	No documentation available.
POST financeiro/MontaRelatorioFinanceiro?client_id={client_id}	No documentation available.
POST financeiro/ProcessarRetornoBancarioPlugBank?client_id={client_id}	No documentation available.
GET financeiro/ImprimirBoletoBancarioFrame?client_id={client_id}&NUFIN={NUFIN}&O={O}	No documentation available.
POST financeiro/FaturarAluno?client_id={client_id}	No documentation available.
POST financeiro/GerarTaxasServicosAluno?client_id={client_id}	No documentation available.
POST financeiro/ConsultarFinanceiro?client_id={client_id}	No documentation available.
POST financeiro/ConsultarFinanceiro2?client_id={client_id}	No documentation available.
POST financeiro/ProcessarWHPlugBank?client_id={client_id}&cnpj_cedente={cnpj_cedente}	No documentation available.
GET financeiro/GetFormaRecebimento?client_id={client_id}	No documentation available.
GET financeiro/GetRecebimentoById?client_id={client_id}&CodigoLancto={CodigoLancto}	No documentation available.
GET financeiro/GetContas?client_id={client_id}&codigoconta={codigoconta}	No documentation available.
GET financeiro/GetTipoCobrancas?client_id={client_id}&tipocobrancaid={tipocobrancaid}	No documentation available.
GET financeiro/GetPagamentoById?client_id={client_id}&CodigoLancto={CodigoLancto}	No documentation available.
GET financeiro/GetFinanceiro?client_id={client_id}&ChaveIntegracao={ChaveIntegracao}&Condominio={Condominio}&Empreendimento={Empreendimento}&Quadra={Quadra}&Lote={Lote}&Seq={Seq}&ParceiroID={ParceiroID}&MatriculaID={MatriculaID}&Tipo={Tipo}&DataVenctoInicial={DataVenctoInicial}&DataVenctoFinal={DataVenctoFinal}&Situacao={Situacao}&DataPagtoInicial={DataPagtoInicial}&DataPagtoFinal={DataPagtoFinal}&DataAtualizacaoInicial={DataAtualizacaoInicial}&DataAtualizacaoFinal={DataAtualizacaoFinal}&CodigoLancto={CodigoLancto}&CA_EmpreendimentoID={CA_EmpreendimentoID}&CA_CondominioID={CA_CondominioID}&CA_LoteID={CA_LoteID}	No documentation available.
POST financeiro/SetBaixaFinanceiroCartao?client_id={client_id}	No documentation available.
POST financeiro/SetBaixaFinanceiro?client_id={client_id}	No documentation available.
POST financeiro/RenegociarFinanceiro?client_id={client_id}	No documentation available.
POST financeiro/DesfazerRenegociacaoFinanceiro?client_id={client_id}	No documentation available.

FileSystem

API	Description
POST fs/uploadFileByteArray?client_id={client_id}&token={token}&tipo={tipo}&filename={filename}&parceiroid={parceiroid}&matriculaid={matriculaid}	No documentation available.
POST fs/uploadFileBase64?client_id={client_id}&token={token}&tipo={tipo}&filename={filename}&parceiroid={parceiroid}&matriculaid={matriculaid}&protocoloid={protocoloid}	No documentation available.

Contrato

API	Description
GET contrato/getContratos?client_id={client_id}&CPF={CPF}&ParceiroID={ParceiroID}&MatriculaID={MatriculaID}&AnoLetivo={AnoLetivo}&PeriodoLetivo={PeriodoLetivo}&DataInicio={DataInicio}&DataFim={DataFim}	No documentation available.
GET contrato/getMatriculasPorPeriodo?client_id={client_id}&DataInicio={DataInicio}&DataFim={DataFim}&AnoLetivo={AnoLetivo}&PeriodoLetivo={PeriodoLetivo}	No documentation available.

Email

API	Description
POST email/enviarEmail?client_id={client_id}	No documentation available.