Skip to content

API Data

Com a API Data, é possível que a edtech tenha acesso aos dados do ensalamento de uma escola, de maneira antecipada. Essa antecipação é importante para aplicativos que necessitam ter os dados da escola, de maneira atencipada, para poder integrar com o HUB.

GET

  • URL: https://apihub.educacional.com.br/hubDataExt/{codigo_da_instituicao}
  • Response:
    • Código: 200 OK
       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      {
          "mensagem": [],
          "dados": {
              "nome_escola": "Colégio Master",
              "dat": {
                  "usuario": [
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 1,
                              "codigo_usuario": "20170026",
                              "nome_usuario": "ALAN DE ALMEIDA VALENÇA CUNHA BARROSO",
                              "data_nascimento": "04/02/2014",
                              "sexo": "N",
                              "cpf": "",
                              "telefone": "",
                              "papel": "aluno",
                              "email_usuario": ""
                          }
                      }
                  ],
                  "turma": [
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 3851,
                              "codigo_turma": "004A",
                              "nome_turma": "Infantil II A",
                              "nome_serie": "Grupo 4"
                          }
                      }
                  ],
                  "disciplinaProfessor": [
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 3905,
                              "codigo_turma": "004A",
                              "codigo_professor": "0424",
                              "nome_disciplina": "Outras Áreas",
                              "inicio_periodo": "01/01/2020",
                              "fim_periodo": "31/12/2020"
                          }
                      }
                  ],
                  "turmaAluno": [
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 4529,
                              "codigo_turma": "006A",
                              "codigo_aluno": "20170026",
                              "inicio_periodo": "01/01/2020",
                              "fim_periodo": "31/12/2020"
                          }
                      }
                  ],
                  "responsavelAluno": [
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 6149,
                              "codigo_responsavel": "81286767504",
                              "codigo_aluno": "20170473"
                          }
                      },
                      {
                          "operacao": "query",
                          "obj": {
                              "chave_registro": 7644,
                              "codigo_responsavel": "94081077568",
                              "codigo_aluno": "20140654"
                          }
                      }
                  ]
              }
          }
      }
      
    • Código 400: Bad Request, quando não for informado o código
    • Código 401: Not Authorized, quando o código passado for de uma instuição sem vínculo com a Edtech
    • Código 404: Not Found, quando o código informado não estiver no HUB.