Seja bem-vindo à documentação da MA&A DATAWARE!
Aqui você encontrará as informações necessárias para fazer a integração com nossa infraestrutura.

 

API é um conjunto de definições e protocolos usado no desenvolvimento e na integração entre sistemas e aplicações. API é um acrônimo em inglês que significa interface de programação de aplicações.

Para utilização da API, é necessário ter o ID da unidade e o token de autenticação.

O conceito de "ID da unidade" serve para que você possa separar as informações, como, por exemplo, se você tiver duas ou mais unidades.

Para ter um gerenciamento completo de seus dados, primeiramente, faça o login pelo sistema MA&A, acesse o menu superior Opções e depois clique em A Empresa.

Endpoint e respostas

Todas as respostas da API são em JSON e as requisições são feitas no endpoint:

https://api.maa.com.br/

Toda chamada para a API tem, no retorno, em caso de erro, o atributo erro, conforme os exemplos abaixo:

      
          {
              "sucesso": false,
              "erro": "*Nao foi possivel responder a sua requisicao*"
          }

Exemplos

Os exemplos da documentação utilizam ID 148446 e token 800440511285a9b0808ea85a94f3dd62, portanto, lembre-se de substituir pelo ID e token da sua unidade.

Dúvidas ou sugestões

Mande um e-mail para suporte@maa.com em caso de dúvidas ou sugestões de melhorias e integrações da API.

Consultando alunos

URL
https://api.maa.com.br/alunos/
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim Número ID da unidade a ser consultada.
busca Sim String String de dados a ser consultada. Pode ser Nome, Prontuário, e-mail ou CPF.
ATRIBUTOS DE RETORNO
Atributo Descrição
alunos Lista com os dados cadastrais de alunos.
Exemplo 1
Efetuando a consulta de alunos
    curl \
    -X POST 'https://api.maa.com.br/alunos/' \
    -Auth 'bearer 148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=148446'
    -d 'busca=britney'

Retorno de um exemplo consultando nome="Britney":

    

[
    {
        "id": 1420691,
        "prontuario": "10929",
        "nome": "Britney Spears",
        "apelido": "Britney Spears",
        "cor": "",
        "nascimento": "2005-01-31T00:00:00",
        "local_nascimento": "MOGI DAS CRUZES",
        "estado_nascimento": "SP",
        "NACIONALIDADE": "Brasileira",
        "estado_civil": "Solteiro",
        "sexo": "F",
        "endereco": "RUA: SANTA MATILDE,",
        "bairro": "CONJUNTO RESIDENCIAL JARDIM CANAÃ",
        "cidade": "SÃO PAULO",
        "estado": "SP",
        "cep": "04382160",
        "telefone1": "",
        "telefone2": "(11) 4301-2274",
        "celular": "",
        "rg": "37.625.477-9",
        "cpf": "15168092896",
        "email": "britney@email.com.br",
        "login": "britney",
        "senha": "123456",
        "alterado_por": "MA&A_DATAWARE -> Willian Gates",
        "ALTERACAO": "2021-04-23T11:37:00"
    }
]

 

Consultando matrículas

URL
https://api.maa.com.br/matriculas/
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim Número ID da unidade a ser consultada.
busca Sim Número ID do aluno.
exercicio não Número Número do ano a ser consultado. Retorna todas as matriculas do exercício especificado
ATRIBUTOS DE RETORNO
Atributo Descrição
Boletos Lista com a ficha de matrícula do aluno.
Exemplo 1
Efetuando a consulta de matrículas
    curl \
    -X POST 'https://api.maa.com.br/matriculas/' \
    -Auth 'bearer 148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=148446'
    -d 'busca=1420691'

Retorno de um exemplo consultando a ficha de matrículas do aluno id="1420691":

    

[
    {
        "ID": 1420691,
        "prontuario": 1010,
        "exercicio": 2015,
        "nivel": "Pré escola I",
        "curso": "Educação Infantil",
        "turno": "Manhã",
        "classe": "A",
        "status": "APROVADO",
        "bolsa": 12.0000,
        "motivo_bolsa": " irmão",
        "data_matricula": "2014-12-16T00:00:00",
        "situacao": "Concluido",
        "data_situacao": "2015-12-31T00:00:00",
        "observacao": "A partir de setembro desc. c/ autorização da Debora."
    },
    {
        "ID": 1420691,
        "prontuario": 1010,
        "exercicio": 2016,
        "nivel": "Pré escola II",
        "curso": "Educação Infantil",
        "turno": "Manhã",
        "classe": "A",
        "status": "APROVADO",
        "bolsa": 12.0000,
        "motivo_bolsa": " irmão",
        "data_matricula": "2015-09-24T00:00:00",
        "situacao": "Concluido",
        "data_situacao": "2015-12-31T00:00:00",
        "observacao": "Pessoas autorizadas a retirar: Fernanda (mãe), Alexandre (pai), Marilene (avó), Osvaldo (avô), André (tio) e Renata (tia)."
    },
    {
        "ID": 1420691,
        "prontuario": 1010,
        "exercicio": 2017,
        "nivel": "Ensino Fundamental I",
        "curso": "1º ANO",
        "turno": "Manhã",
        "classe": "A",
        "status": "APROVADO",
        "bolsa": 15.0000,
        "motivo_bolsa": " irmão",
        "data_matricula": "2016-09-08T00:00:00",
        "situacao": "Concluido",
        "data_situacao": "2015-12-31T00:00:00",
        "observacao": "Pessoas autorizadas a retirar: Fernanda (mãe), Alexandre (pai), Marilene (avó), Osvaldo (avô), André (tio) e Renata (tia)."
    },
    {
        "ID": 1420691,
        "prontuario": 1010,
        "exercicio": 2018,
        "nivel": "Ensino Fundamental I",
        "curso": "2º ANO",
        "turno": "Manhã",
        "classe": "A",
        "status": "APROVADO",
        "bolsa": 30.0000,
        "motivo_bolsa": "irmão + mérito",
        "data_matricula": "2017-09-15T00:00:00",
        "situacao": "Concluido",
        "data_situacao": "2015-12-31T00:00:00",
        "observacao": "Pessoas autorizadas a retirar: Fernanda (mãe), Alexandre (pai), Marilene (avó), Osvaldo (avô), André (tio) e Renata (tia)."
    },
    {
        "ID": 1420691,
        "prontuario": 1010,
        "exercicio": 2019,
        "nivel": "Ensino Fundamental I",
        "curso": "3º ANO",
        "turno": "Tarde",
        "classe": "B",
        "status": "Em curso",
        "bolsa": 0.0000,
        "motivo_bolsa": "",
        "data_matricula": "2021-03-22T00:00:00",
        "situacao": "Ativo",
        "data_situacao": "2021-12-31T00:00:00",
        "observacao": "O aluno foi remanejado para a tarde, após solicitação da mãe."
    }
]

 

Consultando cobranças

URL
https://api.maa.com.br/cobrancas/
ATRIBUTOS DE ENVIO
Atributo Obrigatório Tipo Descrição
id Sim Número ID da unidade a ser consultada.
busca Sim Número ID do aluno.
ATRIBUTOS DE RETORNO
Atributo Descrição
Boletos Lista com a ficha financeira do aluno.
Exemplo 1
Efetuando a consulta de cobrança
    curl \
    -X POST 'https://api.maa.com.br/cobrancas/' \
    -Auth 'bearer 148446:800440511285a9b0808ea85a94f3dd62' \
    -d 'id=148446'
    -d 'busca=1420691'

Retorno de um exemplo consultando a ficha financeira do aluno id="1420691":

    

[
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "41000183",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Jan.",
        "vencimento": "2006-01-06T00:00:00",
        "pagamento": "2006-01-02T00:00:00",
        "previsto": 547.0000,
        "realizado": 464.9500,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "41000409",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Fev.",
        "vencimento": "2006-02-06T00:00:00",
        "pagamento": "2006-01-31T00:00:00",
        "previsto": 547.0000,
        "realizado": 467.6800,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "8100688",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Mar.",
        "vencimento": "2006-03-06T00:00:00",
        "pagamento": "2006-03-01T00:00:00",
        "previsto": 547.0000,
        "realizado": 467.6800,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "8101106",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Abr.",
        "vencimento": "2006-04-06T00:00:00",
        "pagamento": "2006-03-31T00:00:00",
        "previsto": 547.0000,
        "realizado": 464.9500,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "8101518",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Mai.",
        "vencimento": "2006-05-06T00:00:00",
        "pagamento": "2006-05-02T00:00:00",
        "previsto": 547.0000,
        "realizado": 464.9500,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "8101891",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Jun.",
        "vencimento": "2006-06-06T00:00:00",
        "pagamento": "2006-05-31T00:00:00",
        "previsto": 547.0000,
        "realizado": 464.9500,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 356,
        "agencia_banco": "88",
        "conta_banco": "2719228",
        "documento": "8102265",
        "conta": "Créditos",
        "sub_conta": "Geral",
        "DESCRICAO": "Mensalidades",
        "complemento": "Mensalidade Jul.",
        "vencimento": "2006-07-06T00:00:00",
        "pagamento": "2006-06-30T00:00:00",
        "previsto": 547.0000,
        "realizado": 464.9500,
        "outros_acrescimos": 0.0000,
        "desconto": 54.7000,
        "multa": 0.0000,
        "juros": 0.0000
    },
    {
        "numero_banco": 341,
        "agencia_banco": "000",
        "conta_banco": "0000",
        "documento": "1354390",
        "conta": "Créditos",
        "sub_conta": "Material",
        "DESCRICAO": "Livro material didático",
        "complemento": "Apostilas Ensino Médio",
        "vencimento": "2006-01-30T00:00:00",
        "pagamento": "2006-08-02T15:08:00",
        "previsto": 405.0000,
        "realizado": 0.0000,
        "outros_acrescimos": 0.0000,
        "desconto": 0.0000,
        "multa": 2.0000,
        "juros": 0.0333
    }
]