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

É considerado o cenário onde o parceiro adquire cursos do Portal Educação 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="

Listando categorias

Permite acessar as informações das categorias disponíveis.

Resource URL

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

Exemplo de Requisição


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

Exemplo de Resposta

[
  "categorias":  {
        "id": 1,
        "nome": "Administração"
    },
    {
        "id": 2,
        "nome": "Bebê na Família"
    },
    {
        "id": 3,
        "nome": "Biologia"
    },
    {
        "id": 4,
        "nome": "Dia a Dia"
    },
    {
        "id": 5,
        "nome": "Direito"
    },
    {
        "id": 6,
        "nome": "Educação e Pedagogia"
    },
    {
        "id": 7,
        "nome": "Educação Física"
    },
    {
        "id": 8,
        "nome": "Enfermagem"
    },
    {
        "id": 9,
        "nome": "Esporte"
    }]

Listando tipos

Permite acessar as informações dos tipos disponíveis.

Resource URL

GET http://api.homologacao.portaleducacao.com.br/{versão}/tipos

Exemplo de Requisição


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

Exemplo de Resposta


[
  "tipos": {
        "id": 1,
        "nome": "Padrão"
    },
    {
        "id": 2,
        "nome": "Curso para Técnico"
    },
    {
        "id": 3,
        "nome": "Curso Idiomas"
    },
    {
        "id": 4,
        "nome": "Curso 130h"
    },
    {
        "id": 5,
        "nome": "Curso para Veterinário"
    }
]

Listando cursos

Permite acessar as informações dos cursos disponíveis.

Resource URL

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

Parâmetros

pageIndex: Opcional.
Página atual da lista de resultados paginada
pageSize: Opcional.
Total de páginas da lista de resultados paginada

Exemplo de Requisição

GET / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/cursos?pageIndex=1&pageSize=10
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Filtrar cursos por categoria

Parâmetros

categoriaId: Obrigatório.
O identicador da categoria
pageIndex: Opcional.
Página atual da lista de resultados paginada
pageSize: Opcional.
Total de páginas da lista de resultados paginada

Exemplo de Requisição

GET / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/cursos?categoriaId=6&pageIndex=1&pageSize=10
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Filtrar cursos por carga horária

Parâmetros

cargaHoraria: Obrigatório.
Valor inteiro da carga horária
pageIndex: Opcional.
Página atual da lista de resultados paginada
pageSize: Opcional.
Total de páginas da lista de resultados paginada

Exemplo de Requisição

GET / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/cursos?cargaHoraria=60&pageIndex=1&pageSize=10
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Filtrar cursos por categoria e carga horária

Parâmetros

categoriaId: Obrigatório.
O identicador da categoria
cargaHoraria: Obrigatório.
Valor inteiro da carga horária
pageIndex: Opcional.
Página atual da lista de resultados paginada
pageSize: Opcional.
Total de páginas da lista de resultados paginada

Exemplo de Requisição

GET / HTTP/1.1
Host: http://api.homologacao.portaleducacao.com.br/{versão}/cursos?categoriaId=6&cargaHoraria=60&pageIndex=1&pageSize=10
Content-Type: application/json                                        
Accept-Encoding: application/json                                        
token: QUY1QURCRTFDNTZBMDdCNDNCRTZGMEIyN0NCRDI0QzQ=

Exemplo de Resposta

{
    "total_registros": 469,
    "cursos": [
        {
            "id": "1",
            "nome": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "ativo": true,
            "preco": 100,
            "imagem": "http://{url-base}/imagem.jpg",
            "objetivos": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "metodologia": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "publico_alvo": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "carga_horaria": 100,
            "link_video": "",
            "resumo": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "tecnologia": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "diferencial": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",         
            "conteudo": [
                "Introdução",
                "Poliúria e polidipsia",
                "Fisiologia do balanço hídrico",
                "Principais causas de poliúria/polidipsia"
            ],
            "tipo": {
                "id": 1
            },
            "cenas": [
                {
                    "id": 1465,
                    "imagem": "http://{url-base}/imagem.jpg",
                    "ordem": 1
                },
                {
                    "id": 1466,
                    "imagem": "http://{url-base}/imagem.jpg",
                    "ordem": 2
                }
            ]
        },
                        {
            "id": "2",
            "nome": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "ativo": true,
            "preco": 100,
            "imagem": "http://{url-base}/imagem.jpg",
            "objetivos": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "metodologia": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "publico_alvo": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "carga_horaria": 100,
            "link_video": "",
            "resumo": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "tecnologia": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",
            "diferencial": "In sem justo, commodo ut, suscipit at, pharetra vitae, orci.",         
            "conteudo": [
                "Introdução",
                "Poliúria e polidipsia",
                "Fisiologia do balanço hídrico",
                "Principais causas de poliúria/polidipsia"
            ],
            "tipo": {
                "id": 1
            },
            "cenas": [
                {
                    "id": 1465,
                    "imagem": "http://{url-base}/imagem.jpg",
                    "ordem": 1
                },
                {
                    "id": 1466,
                    "imagem": "http://{url-base}/imagem.jpg",
                    "ordem": 2
                }
            ]
        }
    ]
}

Criar matrícula

Permite criar uma matrícula na base de dados do Portal Educação.

Os dados da matrícula 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 da matrícula

{
  "id": "1505",
  "aluno": {
    "codigo": "1",
    "nome_completo": "Aluno da Silva",
    "email": "aluno@email.com.br",
    "cpf": "",
    "endereco": {
      "rua": "",
      "bairro": "",
      "cep": "",
      "numero": "",
      "complemento": "",
      "cidade": {
        "nome": "",
        "estado": {
          "nome": "",
          "sigla": "",
          "pais": {
            "nome": "",
            "sigla": ""
          }
        }
      }
    }
  },
  "cursos": [{
    "id": "1195",
    "preco": 0
  }],
  "ativa": true,
  "hash": ""
}

JSON assinado com o hash(SHA256)

    
    {
  "id": "1505",
  "aluno": {
    "codigo": "1",
    "nome_completo": "Aluno da Silva",
    "email": "aluno@email.com.br",
    "cpf": "",
    "endereco": {
      "rua": "",
      "bairro": "",
      "cep": "",
      "numero": "",
      "complemento": "",
      "cidade": {
        "nome": "",
        "estado": {
          "nome": "",
          "sigla": "",
          "pais": {
            "nome": "",
            "sigla": ""
          }
        }
      }
    }
  },
  "cursos": [{
    "id": "1195",
    "preco": 0
  }],
  "ativa": true,
  "hash": "b68f4fca79e74db7de89c3c2fbce316127397e00aef9d128e436ff24e2ae0424"
}

JSON criptografado no padrão BASE64

                    ew0KICAiaWQiOiAiMTUwNSIsDQogICJhbHVubyI6IHsNCiAgICAiY29kaWdvIjogIjEiLA0KICAgICJub21lX2NvbXBsZXRvIjogIkFsdW5vIGRhIFNpbHZhIiwNCiAgICAiZW1haWwiOiAiYWx1bm9AZW1haWwuY29tLmJyIiwNCiAgICAiY3BmIjogIiIsDQogICAgImVuZGVyZWNvIjogew0KICAgICAgInJ1YSI6ICIiLA0KICAgICAgImJhaXJybyI6ICIiLA0KICAgICAgImNlcCI6ICIiLA0KICAgICAgIm51bWVybyI6ICIiLA0KICAgICAgImNvbXBsZW1lbnRvIjogIiIsDQogICAgICAiY2lkYWRlIjogew0KICAgICAgICAibm9tZSI6ICIiLA0KICAgICAgICAiZXN0YWRvIjogew0KICAgICAgICAgICJub21lIjogIiIsDQogICAgICAgICAgInNpZ2xhIjogIiIsDQogICAgICAgICAgInBhaXMiOiB7DQogICAgICAgICAgICAibm9tZSI6ICIiLA0KICAgICAgICAgICAgInNpZ2xhIjogIiINCiAgICAgICAgICB9DQogICAgICAgIH0NCiAgICAgIH0NCiAgICB9DQogIH0sDQogICJjdXJzb3MiOiBbew0KICAgICJpZCI6ICIxMTk1IiwNCiAgICAicHJlY28iOiAwDQogIH1dLA0KICAiYXRpdmEiOiB0cnVlLA0KICAiaGFzaCI6ICJiNjhmNGZjYTc5ZTc0ZGI3ZGU4OWMzYzJmYmNlMzE2MTI3Mzk3ZTAwYWVmOWQxMjhlNDM2ZmYyNGUyYWUwNDI0Ig0KfQ==

Resource URL

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

Parâmetros - Sem emissão de Nota Fiscal pelo Portal Educação

id: Obrigatório.
Código identificador do matrícula do lado do parceiro.
aluno: Obrigatório.
Objeto aluno preenchido, sendo obrigatório o código, nome e email.
cursos: Obrigatório
Lista de cursos, sendo obrigatório em cada objeto o id. NÃO enviar o parâmetro "preço" nesse modelo de integração.

Parâmetros - Com emissão de Nota Fiscal pelo Portal Educação

id: Obrigatório.
Código identificador do matrícula do lado do parceiro.
aluno: Obrigatório.
Objeto aluno totalmente preenchido. CPF e Endereço são obrigatórios para emissão de Nota Fiscal. Os dados devem ser válidos e existentes para sincronização com emissores de NFs.
cursos: Obrigatório
Lista de cursos, sendo obrigatório em cada objeto o id e o preço. O valor do atributo "preço" DEVE ser enviado e será utilizado para geração da Nota Fiscal. Esse valor deve ser o valor de venda para o usuário em questão.

Exemplo de Requisição


    POST / HTTP/1.1
    Host: http://api.homologacao.portaleducacao.com.br/{versão}/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 descriptogrado com a secret key como chave simétrica para acesso ao JSON de retorno.

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

Parceiros que utilizem o chackout do Portal Educação, no objeto retornado terá a propriedade url-checkout, que será utilizada para redirecionar o aluno para realizar o pagamento da matrícula.

Ourtos dados referentes a matrículas serão retornados e serão utilizados sob demanda.

JSON criptografado no padrão BASE64

ew0KICAgICJ0b3RhbF9yZWdpc3Ryb3MiOiA0NjksDQogICAgImN1cnNvcyI6IFsNCiAgICAgICAgew0KICAgICAgICAgICAgImlkIjogIjEiLA0KICAgICAgICAgICAgIm5vbWUiOiAiSW4gc2VtIGp1c3RvLCBjb21tb2RvIHV0LCBzdXNjaXBpdCBhdCwgcGhhcmV0cmEgdml0YWUsIG9yY2kuIiwNCiAgICAgICAgICAgICJhdGl2byI6IHRydWUsDQogICAgICAgICAgICAicHJlY28iOiAxMDAsDQogICAgICAgICAgICAiaW1hZ2VtIjogImh0dHA6Ly97dXJsLWJhc2V9L2ltYWdlbS5qcGciLA0KICAgICAgICAgICAgIm9iamV0aXZvcyI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLA0KICAgICAgICAgICAgIm1ldG9kb2xvZ2lhIjogIkluIHNlbSBqdXN0bywgY29tbW9kbyB1dCwgc3VzY2lwaXQgYXQsIHBoYXJldHJhIHZpdGFlLCBvcmNpLiIsDQogICAgICAgICAgICAicHVibGljb19hbHZvIjogIkluIHNlbSBqdXN0bywgY29tbW9kbyB1dCwgc3VzY2lwaXQgYXQsIHBoYXJldHJhIHZpdGFlLCBvcmNpLiIsDQogICAgICAgICAgICAiY2FyZ2FfaG9yYXJpYSI6IDEwMCwNCiAgICAgICAgICAgICJsaW5rX3ZpZGVvIjogIiIsDQogICAgICAgICAgICAicmVzdW1vIjogIkluIHNlbSBqdXN0bywgY29tbW9kbyB1dCwgc3VzY2lwaXQgYXQsIHBoYXJldHJhIHZpdGFlLCBvcmNpLiIsDQogICAgICAgICAgICAidGVjbm9sb2dpYSI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLA0KICAgICAgICAgICAgImRpZmVyZW5jaWFsIjogIkluIHNlbSBqdXN0bywgY29tbW9kbyB1dCwgc3VzY2lwaXQgYXQsIHBoYXJldHJhIHZpdGFlLCBvcmNpLiIsICAgICAgICAgDQogICAgICAgICAgICAiY29udGV1ZG8iOiBbDQogICAgICAgICAgICAgICAgIkludHJvZHXDp8OjbyIsDQogICAgICAgICAgICAgICAgIlBvbGnDunJpYSBlIHBvbGlkaXBzaWEiLA0KICAgICAgICAgICAgICAgICJGaXNpb2xvZ2lhIGRvIGJhbGFuw6dvIGjDrWRyaWNvIiwNCiAgICAgICAgICAgICAgICAiUHJpbmNpcGFpcyBjYXVzYXMgZGUgcG9sacO6cmlhL3BvbGlkaXBzaWEiDQogICAgICAgICAgICBdLA0KICAgICAgICAgICAgInRpcG8iOiB7DQogICAgICAgICAgICAgICAgImlkIjogMQ0KICAgICAgICAgICAgfSwNCiAgICAgICAgICAgICJjZW5hcyI6IFsNCiAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICJpZCI6IDE0NjUsDQogICAgICAgICAgICAgICAgICAgICJpbWFnZW0iOiAiaHR0cDovL3t1cmwtYmFzZX0vaW1hZ2VtLmpwZyIsDQogICAgICAgICAgICAgICAgICAgICJvcmRlbSI6IDENCiAgICAgICAgICAgICAgICB9LA0KICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICAgICAgICAgImlkIjogMTQ2NiwNCiAgICAgICAgICAgICAgICAgICAgImltYWdlbSI6ICJodHRwOi8ve3VybC1iYXNlfS9pbWFnZW0uanBnIiwNCiAgICAgICAgICAgICAgICAgICAgIm9yZGVtIjogMg0KICAgICAgICAgICAgICAgIH0NCiAgICAgICAgICAgIF0NCiAgICAgICAgfSwNCiAgICAgICAgICAgICAgICAgICAgICAgIHsNCiAgICAgICAgICAgICJpZCI6ICIyIiwNCiAgICAgICAgICAgICJub21lIjogIkluIHNlbSBqdXN0bywgY29tbW9kbyB1dCwgc3VzY2lwaXQgYXQsIHBoYXJldHJhIHZpdGFlLCBvcmNpLiIsDQogICAgICAgICAgICAiYXRpdm8iOiB0cnVlLA0KICAgICAgICAgICAgInByZWNvIjogMTAwLA0KICAgICAgICAgICAgImltYWdlbSI6ICJodHRwOi8ve3VybC1iYXNlfS9pbWFnZW0uanBnIiwNCiAgICAgICAgICAgICJvYmpldGl2b3MiOiAiSW4gc2VtIGp1c3RvLCBjb21tb2RvIHV0LCBzdXNjaXBpdCBhdCwgcGhhcmV0cmEgdml0YWUsIG9yY2kuIiwNCiAgICAgICAgICAgICJtZXRvZG9sb2dpYSI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLA0KICAgICAgICAgICAgInB1YmxpY29fYWx2byI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLA0KICAgICAgICAgICAgImNhcmdhX2hvcmFyaWEiOiAxMDAsDQogICAgICAgICAgICAibGlua192aWRlbyI6ICIiLA0KICAgICAgICAgICAgInJlc3VtbyI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLA0KICAgICAgICAgICAgInRlY25vbG9naWEiOiAiSW4gc2VtIGp1c3RvLCBjb21tb2RvIHV0LCBzdXNjaXBpdCBhdCwgcGhhcmV0cmEgdml0YWUsIG9yY2kuIiwNCiAgICAgICAgICAgICJkaWZlcmVuY2lhbCI6ICJJbiBzZW0ganVzdG8sIGNvbW1vZG8gdXQsIHN1c2NpcGl0IGF0LCBwaGFyZXRyYSB2aXRhZSwgb3JjaS4iLCAgICAgICAgIA0KICAgICAgICAgICAgImNvbnRldWRvIjogWw0KICAgICAgICAgICAgICAgICJJbnRyb2R1w6fDo28iLA0KICAgICAgICAgICAgICAgICJQb2xpw7pyaWEgZSBwb2xpZGlwc2lhIiwNCiAgICAgICAgICAgICAgICAiRmlzaW9sb2dpYSBkbyBiYWxhbsOnbyBow61kcmljbyIsDQogICAgICAgICAgICAgICAgIlByaW5jaXBhaXMgY2F1c2FzIGRlIHBvbGnDunJpYS9wb2xpZGlwc2lhIg0KICAgICAgICAgICAgXSwNCiAgICAgICAgICAgICJ0aXBvIjogew0KICAgICAgICAgICAgICAgICJpZCI6IDENCiAgICAgICAgICAgIH0sDQogICAgICAgICAgICAiY2VuYXMiOiBbDQogICAgICAgICAgICAgICAgew0KICAgICAgICAgICAgICAgICAgICAiaWQiOiAxNDY1LA0KICAgICAgICAgICAgICAgICAgICAiaW1hZ2VtIjogImh0dHA6Ly97dXJsLWJhc2V9L2ltYWdlbS5qcGciLA0KICAgICAgICAgICAgICAgICAgICAib3JkZW0iOiAxDQogICAgICAgICAgICAgICAgfSwNCiAgICAgICAgICAgICAgICB7DQogICAgICAgICAgICAgICAgICAgICJpZCI6IDE0NjYsDQogICAgICAgICAgICAgICAgICAgICJpbWFnZW0iOiAiaHR0cDovL3t1cmwtYmFzZX0vaW1hZ2VtLmpwZyIsDQogICAgICAgICAgICAgICAgICAgICJvcmRlbSI6IDINCiAgICAgICAgICAgICAgICB9DQogICAgICAgICAgICBdDQogICAgICAgIH0NCiAgICBdDQp9

JSON contendo os dados da matrícula

   {
    "id": "1505",
    "aluno": {
        "codigo": "1",
        "cpf": ""
    },
    "cursos": [{
        "id": "1195",
        "url_acesso": https://pedu.portaleducacao.com.br/sistema/saladeaula/Default.aspx?d=8303D75500D26F7DD5C302781EC8E231EEC68F3FB7E926881571D0E07E21EC868D2152DFE6A55ACD4F89B5A9ADA43CC10237579B1CC7A38985E317549611BB17F4A25ED4D3DE5FDA1EC9999C48EB99690CD0209D986906B1AFB60360019B23A595659C6FC93AEC9459F6B498534B,
        "duracao_curso": 30,
        "recursos_curso": [{
            "id": 28,
            "ava_modulo": null,
            "nome": "Livro Digital",
            "descricao": "Livro Digital",
            "tipo": 0,
            "imagem": null,
            "status": true,
            "badge": false,
            "badge_fonte_color": null,
            "tipo_produto": null
        }, {
            "id": 26,
            "ava_modulo": null,
            "nome": "Conteúdo Interativo",
            "descricao": "",
            "tipo": 3,
            "imagem": "conteudo_interativo.gif",
            "status": true,
            "badge": true,
            "badge_fonte_color": "#383a8f",
            "tipo_produto": null
        }, {
            "id": 12,
            "ava_modulo": null,
            "nome": "Certificado Digital",
            "descricao": "",
            "tipo": 1,
            "imagem": "certificado_impresso.gif",
            "status": true,
            "badge": true,
            "badge_fonte_color": "#3b7ec1",
            "tipo_produto": null
        }],
        "preco_de": 102.5200,
        "preco_por": 102.5200,
        "parcelamento": 12
    }],
    "id-afiliado": null,
    "id-matricula": 2565560,
    "ativa": true,
    "hash": "396ecc6c12af5bdda39a5ae36ba69dae10dc5a4417d981086c4674a4ef12db2e",
    "url-checkout":"http://checkout.portaleducacao.com.br/pagamento/d/8713891441963276DCC700394A9CCB"
 }

Ativar matrícula

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

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/matriculas/ativar/?matriculaParceiro={parâmetro}

Parâmetros

matriculaParceiro: Obrigatório.
Identificador de uma determinada matrícula do parceiro, código enviado no momento da criação da matrícula.

Exemplo de Requisição


    POST / HTTP/1.1
    Host: http://api.homologacao.portaleducacao.com.br/{versão}//matriculas/ativar/?matriculaParceiro=1
    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.

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/matriculas/cancelar/?matriculaParceiro={parâmetro}

Parâmetros

matriculaParceiro: Obrigatório.
Identificador de uma determinada matrícula do parceiro, mesmo codigo enviado no momento da criação da matrícula.

Exemplo de Requisição


    GET / HTTP/1.1
    Host: http://api.homologacao.portaleducacao.com.br/{versão}//matriculas/cancelar/?matriculaParceiro=1
    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.

Status matrícula

Permite consultar o status de pagamento de uma matrícula.

Resource URL

POST http://api.homologacao.portaleducacao.com.br/{versão}/matriculas/status/{parâmetro}

Parâmetros

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

Exemplo de Requisição


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

Exemplo de Resposta

O objeto será retornado com as propriedades idMatricula que representa a matrícula criada na base de dados do Portal Educação, statusPagamento, onde virá o status atual da matrícula e dataConfirmacaoPagamento, caso a matricula tenha sido paga, retornará com a data que foi confirmado o pagamento.

Retornos possiveis no statusPagamento:
Aguardando_Pagamento: Matricula criada, aguardando o cliente efetuar o pagamento.
Cursando: Matrícula teve o pagamento confirmado.
Ja_Cursou: Matrícula paga, o cliente ja estudou, ou expirou o tempo para realização do curso.
Nao_Pago: Matrícula não foi paga pelo cliente.
Cancelado: Matrícula cancelada fora do período de cancelamento.
Cancelado_Com_Estorno: Matrícula cancelada dentro do período de cancelamento e foi realizado o estorno do valor pago.

{
    "idMatricula":4372685,
    "statusPagamento":"Aguardando_Pagamento",
    "dataConfirmacaoPagamento":"0001-01-01T00:00:00"
}

Obter Acesso

Este método tem por finalidade disponibilizar o acesso do curso ao aluno.

O controle de acesso ao curso será de responsabilidade do Parceiro que deverá enviar os dados ao Portal Educação somente quando o aluno estiver apto acessar o curso.

Se acesso for válido o Parceiro enviará ao Portal Educação uma requisição com dados criptografados no padrão Base 64.

Esse método retorna o acesso ao AVA – Ambiente Virtual de Aprendizagem do Portal Educação.

Resource URL

POST http://api.portaleducacao.com.br/{versão}/ava/obterlinkacesso/{parâmetro}

Parâmetros

MatriculaId: Opcional – Identificador da matrícula.
MatriculaParceiroId: Obrigatório – Identificador da matrícula no Parceiro.
CursoId: Identificador do curso.

Retorno

URL: Url para acesso ao curso.

Exemplo de Requisição


POST /v1/Ava/ObterLinkAcesso HTTP/1.1
Host: api.homologacao.portaleducacao.com.br
Content-Type: application/json
Accept: application/json
token: RDRCNTJENTQ0NzAxRDAyMDA2NzQ0NDkyMzRFQUQzQzI=
Cache-Control: no-cache
JSON criptografado no padrão BASE64:
eyJNYXRyaWN1bGFJZCI6bnVsbCwiTWF0cmljdWxhUGFyY2Vpcm9JZCI6IjE5ODUyODgiLCJDdXJzb0lkIjpudWxsLCJMaW5rVXJsQWNlc3NvIjpudWxsLCJIYXNoIjoiYzg2YTAxMDIzODUyMjhkZDRkN2Q0MmUxYmNkYTZkN2ZhM2ZhODlkOGU3ZjFhODUyYmZkOWJkYjBiNWU4OTUxNyJ9

Exemplo de Resposta

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

JSON criptografado no padrão BASE64

eyJNYXRyaWN1bGFJZCI6bnVsbCwiTWF0cmljdWxhUGFyY2Vpcm9JZCI6IjE5ODUyODgiLCJDdXJzb0lkIjpudWxsLCJMaW5rVXJsQWNlc3NvIjoiaHR0cDovL2hvbW9sb2dhY2FvLnBvcnRhbGVkdWNhY2FvLmNvbS5ici9zaXN0ZW1hL3NhbGFkZWF1bGEvRGVmYXVsdC5hc3B4P2Q9ODMwM0Q3NTUwMEQyNkY3REQ3QzUwQzc4MUVDOEUyMzFFRUM2OEYzQ0JCRTcyNjhGMUI3OUQwRTA3RTIxRUM4NjhEMjE1MkRGRTZBNTVBQ0Y0Rjg5QjVBOUFEQTQzQ0MxMDIzNzU3OUIxQ0M2QTY4QzgwRTMxMzUyOTYxMUJCMTdGNEEyNURENERBREMwOEQ5MTZDNzlFQ0Y0N0U5OTk2MzBGRDYyNTkyQzY2NDI3OTZCNUE3MDE3NTEyOTkyMUFCQUE1NDhGN0VDRjM2Rjc4OTBCOUY5MjlGNDMiLCJIYXNoIjoiZDI0OTVmYTUwZmY5ZTllMWQ5YWJmYjg5NzRhMzFhN2JmODU1YTIxYmVjZGY0ODQ3Y2RjNGE3Zjg2NzY3MjY3YiJ9

Emitir Certificado

Este método tem por finalidade validar se o certificado pode ser emitido, ou seja, se o aluno foi aprovado no fim do curso.

O sistema irá validar se certificado pode ser emitido e caso positivo retornará a url do certificado.

Resource URL

POST http://api.portaleducacao.com.br/{versão}/certificado/PermiteEmitirCertificado/{parâmetro}

Parâmetros

MatriculaId: Opcional – Identificador da matrícula.
MatriculaParceiroId: Obrigatório – Identificador da matrícula no Parceiro.
CursoId: Identificador do curso.

Retorno

PodeEmitir: Booleano (true/false)
URL: Url para acesso ao curso.

Exemplo de Requisição


                                        POST /v1/certificado/PermiteEmitirCertificado HTTP/1.1
Host: api.homologacao.portaleducacao.com.br
Content-Type: application/json
Accept-Encoding: application/json
token: OTM0NDFBNUQzMURFNkU3QzFCNzcwNzY1NzczMDI4NTE=

Exemplo de Resposta

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

JSON criptografado no padrão BASE64

fd418de46edcecee53734c31b90b077ad87cf39e54fffcd7739c439c428b00e8

{ "PodeEmitir": true, "url": "http: //url.portaleducacao.com.br/sistema/codigo/certificadoDigital.aspx?matrtur=2452135", "hash": "7668db265b415069360361a528103277a6d27a405608483f36cb79f04a79ef16" }

Introdução

Ambientes

Contextos

Erros

Autenticação

Requisitando token

Chaves

Exemplo de Requisição

Exemplo de Resposta

Cursos

Listando categorias

Resource URL

Exemplo de Requisição

Exemplo de Resposta

Cursos

Listando tipos

Resource URL

Exemplo de Requisição

Exemplo de Resposta

Listando cursos

Resource URL

Parâmetros

Exemplo de Requisição

Filtrar cursos por categoria

Parâmetros

Exemplo de Requisição

Filtrar cursos por carga horária

Parâmetros

Exemplo de Requisição

Filtrar cursos por categoria e carga horária

Parâmetros

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 - Sem emissão de Nota Fiscal pelo Portal Educação

Parâmetros - Com emissão de Nota Fiscal pelo Portal Educação

Exemplo de Requisição

Exemplo de Resposta

JSON criptografado no padrão BASE64

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

Status matrícula

Resource URL

Parâmetros

Exemplo de Requisição

Exemplo de Resposta

Obter Acesso

Resource URL

Parâmetros

Retorno

Exemplo de Requisição

Exemplo de Resposta

Emitir Certificado

Resource URL

Parâmetros

Retorno

Exemplo de Requisição

Exemplo de Resposta