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="

                

Lista de artigos

Permite realizar uma consulta de artigos na base de dados do Portal Educação.

Resource URL

GET http://api.homologacao.portaleducacao.com.br/{versão}/colunista/artigos/{idArea}/{quantidade}/{indiceInicial}/{somenteAprovados}

Parâmetros

idArea

Opcional.

O identicador da area. Valor padrão = 0

quantidade

Opcional.

Quantidade máxima de registros retornados (paginação). Valor padrão = 12

indiceInicial

Opcional.

Valor do indice inicial da busca (paginação). Valor padrão = 0

destaque

Opcional.

Indica se trará apenas artigos em destaque Portal Educação

somenteAprovados

Opcional.

Indica se trará apenas artigos aprovados pelo Portal Educação

Exemplo de Resposta

{
  "total_registros": 2,
    [
      {
        "id": 69328,
        "url": "~/farmacia/artigos/69328/acordo-entre-brasil-e-africa-permite-abertura-de-fabrica-de-medicamentos-contra-aids",
        "titulo": "Acordo entre Brasil e África permite abertura de fábrica de medicamentos contra AIDS",
        "data_cadastro": "2010-01-11T14:56:00",
        "imagem": "http://static.portaleducacao.com.br/arquivos/imagens_artigos/29062016121340420171840213691625.jpg",
        "autor": "Colunista Portal - Educação",
        "aprovado": true
      },
      {
        "id": 69287,
        "url": "~/farmacia/artigos/69287/portal-educacao-oferece-curso-de-biosseguranca-em-laboratorio-clinico",
        "titulo": "Portal Educação oferece curso de Biossegurança em Laboratório Clínico",
        "data_cadastro": "2009-12-31T09:40:00",
        "imagem": "http://static.portaleducacao.com.br/arquivos/imagens_artigos/2706201616113998938523036995950.jpg",
        "autor": "Colunista Portal - Educação",
        "aprovado": true
      }
    ]
}

Obter artigo

Permite obter detalhes de um artigo na base do Portal Educação.

Resource URL

GET http://api.homologacao.portaleducacao.com.br/{versão}/colunista/artigo/{id}

Parâmetros

id

Obrigatório.

O identicador do artigo.

Exemplo de Resposta

{
    "id": 72829,
    "titulo": "Guerras e guerras",
    "diretorio": "administracao",
    "imagem": "http://static.portaleducacao.com.br/arquivos/imagens_artigos/03072016200637Artigo_012_-_Guerras_e_guerras.jpg",
    "data_insercao": "03/07/2016",
    "paginas": [
        "Conteúdo em html página 1",
        "Conteúdo em html página 2",
        "Conteúdo em html página 3"
    ],
    "colunista": {
        "foto": "http://static.portaleducacao.com.br/arquivos/imagens_foto_colunista/1893576_63568698.jpg",
        "nome": "Tom Coelho",
        "mini_curriculo": "Formação em Publicidade pela ESPM e Economia pela USP."
    }
}