Portal Educação API - Disponibilização de cursos V1

É considerado o cenário onde o Portal Educação adquire cursos do parceiro para disponibilização para seus clientes/usuários, via vitrine/hotsite próprio, permitindo que seja selecionado um produto – ou um conjunto de produtos – a ser adquirido.

Ambientes

Você encontrará nessa documentação as URLs de requisição com exemplos para o ambiente de testes (homologação). Para colocar sua aplicação em produção basta alterar o contexto das URLs.

Contextos

Homologação: http://api.homologacao.portaleducacao.com.br/{versão}/
Produção: http://api.portaleducacao.com.br/{versão}/

Erros

Utilizamos os status code do protocolo HTTP, disponíveis no header de cada response.

200 OK: Tudo funcionou como esperado
400 Bad Request: Geralmente, um problema com os parâmetros.
401 Unauthorized: Tentativa de acesso com token inválido.
404 Not Found: O recurso acessado não existe.
50X Server errors: Falha nossa, algum erro no servidor.

Requisitando token

Todo cliente autenticado deverá possuir um token público, que será gerado a partir da apikey e da secret key passadas pelo parceiro no cabeçalho da requisição do token (demonstrada com mais detalhes abaixo).

A requisição deve ser do tipo POST para a URL: http://{url_base}/{versão}/auth/token?requestUrl="{request_url}" contendo em seu header duas chaves:

Chaves

apikey: Obrigatório.
secret: Obrigatório.

Feito isso será retornado no corpo do response o token público, válido por 20 minutos e que poderá ser utilizado para consumir qualquer método da API.

Exemplo de Requisição


GET / HTTP/1.1
Host: api.homologacao.portaleducacao.com.br/{versão}/auth/token?requestURL={suaURL}
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
apikey: 723FD4E7ED5AE2EA23E82862873905F5
secret: JDJhJDA4JGFuSEFubmo4a1NoRmdManR2Ukk2L08xOTEzNzY0ODEzOTQ=

Exemplo de Resposta


    "QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ="

Cadastro de categorias

Permite realizar cadastro de uma lista de categorias na base de dados do Portal Educação.

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/categorias

Parâmetros

JSON: Obrigatório.
Objeto JSON com a lista de categorias

Exemplo de Objeto

{
    "categorias": [
        {
            "id": 1,
            "nome": "Categoria 1"
        },
        {
            "id": 2,
            "nome": "Categoria 2 "
        },
        {
            "id": 3,
            "nome": "Categoria 3"
        }
    ]
}

Exemplo de Requisição


POST / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/categorias
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=       

Obs: O JSON deverá ser enviado no corpo da requisição.

Exemplo de Resposta

No corpo da resposta sempre conterá um array de erros no formato JSON, conforme exemplo abaixo:

Array vazio, significa que todos as categorias foram cadastrados com sucesso.


{
    "erros": []
}

Array contendo os cursos que não passaram na validação, onde o código representa o identificador da categoria enviada.


{
"erros": [
    {
        "Codigo": "1",
        "Mensagem": "Categoria não cadastrada"
    },
    {
        "Codigo": "2",
        "Mensagem": "Categoria não cadastrada"
    },
    {
        "Codigo": "3",
        "Mensagem": "Categoria não cadastrada"
    }
]
}

Cadastro de cursos

Permite realizar cadastro de uma lista de cursos na base de dados do Portal Educação.

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/cursos

Parâmetros

JSON: Obrigatório.
Objeto JSON com a lista de cursos

Exemplo de Objeto

{
    "cursos": [
        {
            "id": "1",
            "nome": "Nome do curso",
            "imagem": "http://url-base/caminho-da-imagem.extensão",
            "carga_horaria": 100,
            "objetivos": "Objetivosdocurso",
            "preco": 100,
            "preco_minimo": 0,
            "publico_alvo": "ProfissionaisdaArea",
            "resumo": "Resumodocurso",
            "metodologia": "Metodologiadocurso",
            "categoria": {
                "id": 123,
                "nome": "Categoriadocurso"
            },
            "conteudo": [
                "topico1",
                "topico2",
                "topico3",
                "topico4",
                "topico5",
                "topico6"
            ],
             "cenas": [
                    {
                        "id": 1465,
                        "imagem": "http://{url-base}/imagem.jpg",
                        "ordem": 1
                    },
                    {
                        "id": 1466,
                        "imagem": "http://{url-base}/imagem.jpg",
                        "ordem": 2
                    }               
                ]
        },
        {
            "id": "2",
            "nome": "Nome do curso",
            "imagem": "http://url-base/caminho-da-imagem.extensão",
            "carga_horaria": 100,
            "objetivos": "Objetivosdocurso",
            "preco": 100,
            "preco_minimo": 0,
            "publico_alvo": "ProfissionaisdaArea",
            "resumo": "Resumodocurso",
            "metodologia": "Metodologiadocurso",
            "categoria": {
                "id": 123,
                "nome": "Categoriadocurso"
            },
            "conteudo": [
                "topico1",
                "topico2",
                "topico3",
                "topico4",
                "topico5",
                "topico6"
            ],
            "cenas": [
            {
                "id": 1465,
                "imagem": "http://{url-base}/imagem.jpg",
                "ordem": 1
            },
            {
                "id": 1466,
                "imagem": "http://{url-base}/imagem.jpg",
                "ordem": 2
            }               
        ]
        }
    ]
}

Exemplo de Requisição


POST / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/cursos
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=       

Obs: O JSON deverá ser enviado no corpo da requisição.

Exemplo de Resposta

No corpo da resposta sempre conterá um array de erros no formato JSON, conforme exemplo abaixo:

Array vazio, significa que todos os cursos foram cadastrados com sucesso.


{
    "erros": []
}

Array contendo os cursos que não passaram na validação, onde o código representa o identificador do curso enviado.


{
"erros": [
    {
        "Codigo": "1451",
        "Mensagem": "Curso não cadastrado"
    },
    {
        "Codigo": "659",
        "Mensagem": "Curso não cadastrado"
    },
    {
        "Codigo": "4659",
        "Mensagem": "Curso não cadastrado"
    }
]
}

Cadastro de provas

Permite realizar cadastro de uma lista de provas na base de dados do Portal Educação.

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/provas

Parâmetros

JSON: Obrigatório.
Objeto JSON com a lista de provas

Exemplo de Objeto

{
  "provas":  {
        "id": 1,
        "titulo": "P1",                 
        "peso": 1,
        "curso": {
            "id": 1
        },
        "questoes": [
            {
                "id": 1,
                "titulo": "Pergunta 1",
                "alternativas": [
                    {
                        "id": 1,
                        "titulo": "Alternativa 1"
                    },
                    {
                        "id": 2,
                        "titulo": "Alternativa 2"
                    },
                    {
                        "id": 3,
                        "titulo": "Alternativa 3"
                    },
                    {
                        "id": 4,
                        "titulo": "Alternativa 4"
                    },
                    {
                        "id": 5,
                        "titulo": "Alternativa 5"
                    }
                ],
                "reposta": {
                    "id": 2,
                     "titulo": "Alternativa 2"
                }
            },
            {
                "id": 2,
                "titulo": "Pergunta 2",
                  "alternativas": [
                    {
                        "id": 1,
                        "titulo": "Alternativa 1"
                    },
                    {
                        "id": 2,
                        "titulo": "Alternativa 2"
                    },
                    {
                        "id": 3,
                        "titulo": "Alternativa 3"
                    },
                    {
                        "id": 4,
                        "titulo": "Alternativa 4"
                    },
                    {
                        "id": 5,
                        "titulo": "Alternativa 5"
                    }
                ],
                "reposta": {
                    "id": 1,
                     "titulo": "Alternativa 1"
                }
            }           
        ]
    }
  }

Exemplo de Requisição


POST / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/provas
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=       

Obs: O JSON deverá ser enviado no corpo da requisição.

Exemplo de Resposta

No corpo da resposta sempre conterá um array de erros no formato JSON, conforme exemplo abaixo:

Array vazio, significa que todas as provas foram cadastradas com sucesso.


{
    "erros": []
}

Array contendo as provas que não passaram na validação, onde o código representa o identificador da prova enviada.


{
"erros": [
    {
        "Codigo": "1451",
        "Mensagem": "Prova não cadastrada"
    },
    {
        "Codigo": "659",
        "Mensagem": "Prova não cadastrada"
    },
    {
        "Codigo": "4659",
        "Mensagem": "Prova não cadastrada"
    }
]
}

Cadastro de provas

Permite realizar alteração de uma lista de provas na base de dados do Portal Educação.

Resource URL

PUT http://api.homologacao.portaleducacao.com.br/{versão}/provas

Parâmetros

JSON: Obrigatório.
Objeto JSON com a lista de provas

Exemplo de Objeto

[
  "provas":  {
        "id": 1,
        "titulo": "P1",
        "curso": {
            "id": 1
        },
        "questoes": [
            {
                "id": 1,
                "titulo": "Pergunta 1",
                "alternativas": [
                    {
                        "id": 1,
                        "titulo": "Alternativa 1"
                    },
                    {
                        "id": 2,
                        "titulo": "Alternativa 2"
                    },
                    {
                        "id": 3,
                        "titulo": "Alternativa 3"
                    },
                    {
                        "id": 4,
                        "titulo": "Alternativa 4"
                    },
                    {
                        "id": 5,
                        "titulo": "Alternativa 5"
                    }
                ],
                "reposta": {
                    "id": 2,
                     "titulo": "Alternativa 2"
                }
            },
            {
                "id": 2,
                "titulo": "Pergunta 2",
                  "alternativas": [
                    {
                        "id": 1,
                        "titulo": "Alternativa 1"
                    },
                    {
                        "id": 2,
                        "titulo": "Alternativa 2"
                    },
                    {
                        "id": 3,
                        "titulo": "Alternativa 3"
                    },
                    {
                        "id": 4,
                        "titulo": "Alternativa 4"
                    },
                    {
                        "id": 5,
                        "titulo": "Alternativa 5"
                    }
                ],
                "reposta": {
                    "id": 1,
                     "titulo": "Alternativa 1"
                }
            }           
        ],
        "peso": 1
    }
  ]

Exemplo de Requisição


PUT / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/provas
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=       

Obs: O JSON deverá ser enviado no corpo da requisição.

Exemplo de Resposta

No corpo da resposta sempre conterá um array de erros no formato JSON, conforme exemplo abaixo:

Array vazio, significa que todas as provas foram alteradas com sucesso.


{
    "erros": []
}

Array contendo as provas que não passaram na validação, onde o código representa o identificador da prova enviada.


{
"erros": [
    {
        "Codigo": "1451",
        "Mensagem": "Prova não foi alterada"
    },
    {
        "Codigo": "659",
        "Mensagem": "Prova não foi alterada"
    },
    {
        "Codigo": "4659",
        "Mensagem": "Prova não foi alterada"
    }
]
}

Criar matrícula

Após realizarmos uma venda com o curso do parceiro, o Portal Educação realizará uma chamada HTTP POST para uma URL do parceiro. O parceiro deve disponibilizar uma URL base, respeitando as definições abaixo. Com a requisição, o parceiro deve criar uma matrícula para utilização do produto pelo cliente.

Será enviado um objeto no formato JSON. Logo após, deve ser gerado um hash SHA256, utilizando a secret key mencionada, que valida autenticidade do pedido. Essas informações devem colocadas num envelope JSON, que deve ser codificado em BASE64, antes de realizar a requisição para a url do parceiro.

JSON contendo os dados da matrícula

{
    "id": "1",    
    "aluno": {
        "codigo": "5he8nsjy3rSfsvbbnd",                
    },
   "cursos": [
        {
            "id": "1"
            
        },
        {
            "id": "2"            
        }
    ],
    "ativa": false,    
    "hash": ""
}

JSON assinado com o hash(SHA256)

{
    "id": "1",    
    "aluno": {
        "codigo": "5he8nsjy3rSfsvbbnd",                
    },
    "cursos": [
        {
            "id": "1"
            
        },
        {
            "id": "2"            
        }
    ],
    "ativa": false,    
    "hash": "534de1fa379ac770cc6da896cacc39ba7fecb1198d7cafe9a137bc2c37f649f4"
}

JSON criptografado no padrão BASE64

    
eyJjb2RpZ28iOiJ0ZXN0ZUNvZGlnbyIsIm5vbWVfY29tcGxldG8iOiJ0ZXN0ZU5vbWUiLCJlbWFpbCI6InRlc3RlRW1haWwiLCJlbmRlcmVjbyI6eyJjb2RpZ28iOjEsInJ1YSI6InRlc3RlUnVhIiwiYmFpcnJvIjoidGVzdGVCYWlycm8iLCJjZXAiOjg4ODg4ODg4LCJudW1lcm8iOiJ0ZXN0ZU51bWVybyIsImNvbXBsZW1lbnRvIjoidGVzdGVDb21wbGVtZW50byIsImNpZGFkZSI6eyJub21lIjoidGVzdGVDaWRhZGUiLCJlc3RhZG8iOnsibm9tZSI6Im5vbWVFc3RhZG8iLCJzaWdsYSI6Ik1TIiwicGFpcyI6eyJub21lIjoiQnJhc2lsIiwic2lnbGEiOiJCUiJ9fX19LCJoYXNoIjoiNGMwYTVhZTQxOWMxMzBlOGZkYzRlYmNhYzAwN2FmMGRmYzI3YTFmYWEwYmI4YzgzN2MwOGM4NWYxYTUyMzhhZCJ9

Resource URL

POST http://{url-base}/matriculas/criar

Parâmetros

id: Obrigatório.
Código identificador do matrícula do lado do Portal Educação.
aluno: Obrigatório.
Objeto aluno preenchido, apenas com código, indentificador do aluno no Portal Educação.
cursos: Obrigatório
Lista de cursos, sendo obrigatório em cada objeto o id.

Exemplo de Requisição


POST / HTTP/1.1
Host: http://{url-base}/matriculas/criar
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=   


Obs: O JSON criptografado no padrão BASE64 deverá ser enviado no corpo da requisição.

Exemplo de Resposta

No corpo da resposta conterá um JSON criptografado no padrão BASE64, o mesmo deve ser criptogrado com a secret key como chave simétrica para acesso ao JSON de retorno.

JSON contendo os dados da matrícula

{
    "id": "1",
    "aluno": {
        "codigo": "5he8nsjy3rSfsvbbnd",                
    },
    "cursos": [
        {
            "id": "1",
            "url_acesso": "http://url-base/sala-de-aula"
        },
        {
            "id": "2",
            "url_acesso": "http://url-base/sala-de-aula"
        }
    ],
    "ativa": false,
    "codigo": "DASH456",
    "hash": ""
}

O objeto será retornado com as propriedades codigo que representa a matrícula criada na base de dados do parceiro e no objeto cursos a url_acesso, que será utilizada para redirecionar o aluno para acesso a sala de aula do parceiro.

Ativar matrícula

Permite realizar a ativação de uma matrícula.

O parceiro deve disponibilizar uma URL base, respeitando as definições abaixo. Com a requisição, o parceiro deve ativar uma matrícula para utilização do produto pelo cliente.

Resource URL

POST http://{url-base}/matriculas/ativar/{id_matricula}

Parâmetros

matricula.id: Obrigatório.
Identificador de uma determinada matrícula.

Exemplo de Requisição


POST / HTTP/1.1
Host: http://{url-base}/matriculas/ativar/{id_matricula}
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Exemplo de Resposta

200 OK: OK
400 Bad Request: Descrição do erro.
401 Unauthorized: Descrição do erro.
50X Server errors: Descrição do erro.

Cancelar matrícula

Permite realizar o cancelamento de uma matrícula.

O parceiro deve disponibilizar uma URL base, respeitando as definições abaixo. Com a requisição, o parceiro deve cancelar uma matrícula.

Resource URL

POST http://{url-base}/matriculas/cancelar/{id_matricula}

Parâmetros

matricula.id: Obrigatório.
Identificador de uma determinada matrícula.

Exemplo de Requisição


POST / HTTP/1.1
Host: http://{url-base}/matriculas/cancelar/{id_matricula}/{id_curso}
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Exemplo de Resposta

200 OK: OK
400 Bad Request: Descrição do erro.
401 Unauthorized: Descrição do erro.
50X Server errors: Descrição do erro.

Enviar nota do aluno

Permite atualizar a nota do aluno na base de dados do Portal Educação.

A nota do aluno deve ser gerada no formato JSON. Logo após, deve ser gerado um hash SHA256, utilizando a secret key como chave simétrica para assinatura do JSON, que valida autenticidade dos dados gerados pelo parceiro. Essas informações devem ser colocadas num envelope JSON, que deve ser codificado em BASE64, antes de realizar a requisição para a API.

JSON contendo a nota do aluno

{
    "nota": {
        "id_matricula": 1,
        "id_Curso": 2,
        "media": 99
        },
        "hash": ""
}

JSON assinado com o hash(SHA256)

{
    "nota": {
        "id_matricula": 1,
        "id_Curso": 2,
        "media": 99        
        },
    "hash": "534de1fa379ac770cc6da896cacc39ba7fecb1198d7cafe9a137bc2c37f649f4"
}

JSON criptografado no padrão BASE64

    
eyJjb2RpZ28iOiJ0ZXN0ZUNvZGlnbyIsIm5vbWVfY29tcGxldG8iOiJ0ZXN0ZU5vbWUiLCJlbWFpbCCJlbmRlcmVjbyI6eyJjb2RpZ28iOjEsInJ1YSI6InRlc3RlUnVhIiwiYmFpcnJvIjoidGVzdGVCYWlycm8iLCJjZXAiOjg4ODg4ODg4LCJudW1lcm8iOiJ0ZXN0ZU51bWVybyIsImNvbXBsZW1lbnRvIjoidGVzdGVDb21wbGVtZW50byIsImNpZGFkZSI6eyJub21lIjoidGVzdGVDaWRhZGUiLCJlc3RhZG8iOnsibm9tZSI6Im5vbWVFc3RhZG8iLCJzaWdsYSI6Ik1TIiwicGFpcyI6eyJub21lIjoiQnJhc2lsIiwic2lnbGEiOiJCUiJ9fX19LCJoYXNoIjoiNGMwYTVhZTQxOWMxMzBlOGZkYzRlYmNhYzAwN2FmMGRmYzI3YTFmYWEwYmI4YzgzN2MwOGM4NWYxYTUyMzhhZCJ9

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/notas

Parâmetros

nota: Obrigatório.
Objeto JSON com a propriedades id_matricula, id_curso e média preenchidos

Exemplo de Requisição


POST / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/notas
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=   


Obs: O JSON criptografado no padrão BASE64 deverá ser enviado no corpo da requisição.

Exemplo de Resposta

200 OK: OK
400 Bad Request: Descrição do erro.
401 Unauthorized: Descrição do erro.
50X Server errors: Descrição do erro.

Downloads

Permite o envio de histórico de downloads de e-books realizados pelo aluno do lado do Parceiro.

O download do e-book deve ser gerado no formato JSON. Logo após, deve ser gerado um hash SHA256, utilizando a secret key como chave simétrica para assinatura do JSON, que valida autenticidade dos dados gerados pelo parceiro. Essas informações devem ser colocadas num envelope JSON, que deve ser codificado em BASE64, antes de realizar a requisição para a API.

JSON contendo o e-book

{
    "ebook": {
        "matricula": "7898931",
        "data_download": "2013-08-20",
        "titulo": "teste",
        "url_arquivo": "http://www.beephoto.com.br/arquivosdicas/apostila.pdf"
    },
    "hash": ""
}

JSON assinado com o hash(SHA256)


{
    "ebook": {
        "matricula": "7898931",
        "data_download": "2013-08-20",
        "titulo": "teste",
        "url_arquivo": "http://www.beephoto.com.br/arquivosdicas/apostila.pdf"
    },
    "hash": "b1b990176a9caa011391f985f14d8ca5e85a5c249fbf14a5a54b6e14f4e8fd1a"
}

JSON criptografado no padrão BASE64

    
eyJjb2RpZ28iOiJ0ZXN0ZUNvZGlnbyIsIm5vbWVfY29tcGxldG8iOiJ0ZXN0ZU5vbWUiLCJlbWFpbCCJlbmRlcmVjbyI6eyJjb2RpZ28iOjEsInJ1YSI6InRlc3RlUnVhIiwiYmFpcnJvIjoidGVzdGVCYWlycm8iLCJjZXAiOjg4ODg4ODg4LCJudW1lcm8iOiJ0ZXN0ZU51bWVybyIsImNvbXBsZW1lbnRvIjoidGVzdGVDb21wbGVtZW50byIsImNpZGFkZSI6eyJub21lIjoidGVzdGVDaWRhZGUiLCJlc3RhZG8iOnsibm9tZSI6Im5vbWVFc3RhZG8iLCJzaWdsYSI6Ik1TIiwicGFpcyI6eyJub21lIjoiQnJhc2lsIiwic2lnbGEiOiJCUiJ9fX19LCJoYXNoIjoiNGMwYTVhZTQxOWMxMzBlOGZkYzRlYmNhYzAwN2FmMGRmYzI3YTFmYWEwYmI4YzgzN2MwOGM4NWYxYTUyMzhhZCJ9

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/materiais

Parâmetros

ebook: Obrigatório.
Objeto JSON com a propriedades matricula, data_download, titulo e url_arquivo preenchidos

Exemplo de Requisição


POST / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/materiais
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=   


Obs: O JSON criptografado no padrão BASE64 deverá ser enviado no corpo da requisição.

Exemplo de Resposta

200 OK: OK
400 Bad Request: Descrição do erro.
401 Unauthorized: Descrição do erro.
50X Server errors: Descrição do erro.

Dados do Aluno

Permite realizar a atualização do dados do aluno na base de dados do Portal Educação.

Os dados do aluno devem ser gerados no formato JSON. Logo após, deve ser gerado um hash SHA256, utilizando a secret key como chave simétrica para assinatura do JSON, que valida autenticidade dos dados gerados pelo parceiro. Essas informações devem ser colocadas num envelope JSON, que deve ser codificado em BASE64, antes de realizar a requisição para a API.

JSON contendo os dados do aluno

{
    "aluno": [
        {
            "codigo": "Codigo",
            "nome_completo": "Nome",
            "email": "Email",
            "endereco": {
                "codigo": "",
                "rua": "Rua",
                "bairro": "Bairro",
                "cep": 99999999,
                "numero": "9999",
                "complemento": "Complemento",
                "cidade": {
                    "nome": "Cidade",
                    "estado": {
                        "nome": "Estado",
                        "sigla": "MS",
                        "pais": {
                            "nome": "Brasil",
                            "sigla": "BR"
                        }
                    }
                }
            },
            "hash": ""
        }
    ]
}

JSON assinado com o hash(SHA256)

{
    "aluno": [
        {
            "codigo": "Codigo",
            "nome_completo": "Nome",
            "email": "Email",
            "endereco": {
                "codigo": "",
                "rua": "Rua",
                "bairro": "Bairro",
                "cep": 99999999,
                "numero": "9999",
                "complemento": "Complemento",
                "cidade": {
                    "nome": "Cidade",
                    "estado": {
                        "nome": "Estado",
                        "sigla": "MS",
                        "pais": {
                            "nome": "Brasil",
                            "sigla": "BR"
                        }
                    }
                }
            },
            "hash": "4c0a5ae419c130e8fdc4ebcac007af0dfc27a1faa0bb8c837c08c85f1a5238ad"
        }
    ]
}

JSON criptografado no padrão BASE64

    
eyJjb2RpZ28iOiJ0ZXN0ZUNvZGlnbyIsIm5vbWVfY29tcGxldG8iOiJ0ZXN0ZU5vbWUiLCJlbWFpbCI6InRlc3RlRW1haWwiLCJlbmRlcmVjbyI6eyJjb2RpZ28iOjEsInJ1YSI6InRlc3RlUnVhIiwiYmFpcnJvIjoidGVzdGVCYWlycm8iLCJjZXAiOjg4ODg4ODg4LCJudW1lcm8iOiJ0ZXN0ZU51bWVybyIsImNvbXBsZW1lbnRvIjoidGVzdGVDb21wbGVtZW50byIsImNpZGFkZSI6eyJub21lIjoidGVzdGVDaWRhZGUiLCJlc3RhZG8iOnsibm9tZSI6Im5vbWVFc3RhZG8iLCJzaWdsYSI6Ik1TIiwicGFpcyI6eyJub21lIjoiQnJhc2lsIiwic2lnbGEiOiJCUiJ9fX19LCJoYXNoIjoiNGMwYTVhZTQxOWMxMzBlOGZkYzRlYmNhYzAwN2FmMGRmYzI3YTFmYWEwYmI4YzgzN2MwOGM4NWYxYTUyMzhhZCJ9

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/alunos

Parâmetros

codigo: Obrigatório.
Código identificador do aluno.
nome_completo: Opcional.
Nome do aluno.
Endereco: Opcional
Ao informar um dos campos de endereço, os demais exceto o código se tornarão obrigatórios para cadastro do endereço na API, caso contrário serão ignorados.

Exemplo de Requisição


GET / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/alunos
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=   


Obs: O JSON criptografado no padrão BASE64 deverá ser enviado no corpo da requisição.

Exemplo de Resposta

200 OK: OK
400 Bad Request: Descrição do erro.
401 Unauthorized: Descrição do erro.
50X Server errors: Descrição do erro.

Introdução

Ambientes

Contextos

Erros

Autenticação

Requisitando token

Chaves

Exemplo de Requisição

Exemplo de Resposta

Cursos

Cadastro de categorias

Resource URL

Parâmetros

Exemplo de Objeto

Exemplo de Requisição

Exemplo de Resposta

Cadastro de cursos

Resource URL

Parâmetros

Exemplo de Objeto

Exemplo de Requisição

Exemplo de Resposta

Provas

Cadastro de provas

Resource URL

Parâmetros

Exemplo de Objeto

Exemplo de Requisição

Exemplo de Resposta

Cadastro de provas

Resource URL

Parâmetros

Exemplo de Objeto

Exemplo de Requisição

Exemplo de Resposta

Matrículas

Criar matrícula

JSON contendo os dados da matrícula

JSON assinado com o hash(SHA256)

JSON criptografado no padrão BASE64

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

JSON contendo os dados da matrícula

Ativar matrícula

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

Cancelar matrícula

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

Nota do Aluno

Enviar nota do aluno

JSON contendo a nota do aluno

JSON assinado com o hash(SHA256)

JSON criptografado no padrão BASE64

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

E-books

Downloads

JSON contendo o e-book

JSON assinado com o hash(SHA256)

JSON criptografado no padrão BASE64

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

Aluno

Dados do Aluno

JSON contendo os dados do aluno

JSON assinado com o hash(SHA256)

JSON criptografado no padrão BASE64

Resource URL

Parâmetros