API Blogger JSON: como usar a API

Importante: vamos descontinuar o suporte à API JSON v2.0 em 30 de setembro de 2024. Para garantir a funcionalidade contínua, atualize os aplicativos que dependem da API JSON v2.0 para a versão mais recente. Para a versão mais recente, use os links na barra de navegação à esquerda.

Neste documento, descrevemos como usar os recursos comuns da API Blogger JSON usando o estilo de chamada RESTful.

Conteúdo

Introdução

Este documento é para desenvolvedores que querem criar aplicativos que possam interagir com a API JSON do Blogger. O Blogger é uma ferramenta para criar sites que permitem que as pessoas publiquem suas ideias de maneira contínua.

Se você não é familiarizado com os conceitos do Blogger, leia os Primeiros passos antes de começar a programar.

Autorizar solicitações e identificar seu aplicativo

Todas as solicitações que seu aplicativo envia para a API JSON do Blogger precisam identificar o aplicativo para o Google. Há duas maneiras de identificar o aplicativo: usando o token OAuth 2.0, que também autoriza a solicitação, e/ou a chave de API do aplicativo. Veja como determinar qual dessas opções usar:

  • Se a solicitação exigir autorização, como a solicitação de dados particulares de um indivíduo, será necessário fornecer um token OAuth 2.0 com ela. O aplicativo também pode informar a chave de API, mas isso não é obrigatório.
  • Se a solicitação não exigir autorização, como uma solicitação de dados públicos, o aplicativo precisará fornecer a chave de API, um token OAuth 2.0 ou ambos, a opção mais conveniente para você.

Sobre os protocolos de autorização

O aplicativo precisa usar o OAuth 2.0 para autorizar solicitações. Não há outros protocolos de autorização compatíveis.

Observação: atualmente, a API JSON do Blogger não oferece suporte para fazer login e solicitar acesso aos dados (híbrido) ou delegação de autoridade em todo o domínio (2LO).

Autorização de solicitações com o OAuth 2.0

As solicitações para a API JSON do Blogger relacionadas a dados do usuário não públicos precisam ser autorizadas por um usuário autenticado.

Os detalhes do processo de autorização, ou "fluxo", para o OAuth 2.0 variam um pouco, dependendo do tipo de aplicativo que você está criando. O processo geral a seguir se aplica a todos os tipos de aplicativo:

  1. Ao criar seu aplicativo, você o registra no Google. Em seguida, o Google fornece as informações que serão necessárias mais tarde, como um ID e uma chave secreta do cliente.
  2. Ative a API Blogger JSON no painel de serviços do Console de APIs do Google. Se ela não estiver listada no Console, pule esta etapa.
  3. Quando seu aplicativo precisa de acesso aos dados do usuário, ele pede ao Google um escopo específico de acesso.
  4. O Google exibe uma caixa de diálogo OAuth para o usuário, pedindo que ele autorize seu aplicativo a solicitar alguns dos dados dele.
  5. Se o usuário aprovar, o Google fornecerá ao aplicativo um token de acesso de curta duração.
  6. Seu aplicativo solicita dados do usuário, anexando o token de acesso à solicitação.
  7. Se o Google determinar que sua solicitação e o token são válidos, ele retornará os dados solicitados.

Alguns fluxos incluem outras etapas, como usar tokens de atualização para adquirir novos tokens de acesso. Para informações detalhadas sobre fluxos para vários tipos de aplicativos, consulte a documentação do OAuth 2.0 do Google.

Veja a informação de escopo do OAuth 2.0 para a API Blogger JSON:

https://www.googleapis.com/auth/blogger

Para solicitar acesso usando o OAuth 2.0, seu aplicativo precisa das informações do escopo, bem como das informações fornecidas pelo Google durante o registro do aplicativo (como o ID e/ou a chave secreta do cliente).

Dica: as bibliotecas de cliente das APIs do Google cuidam de parte do processo de autorização para você. Elas estão disponíveis para uma série de linguagens de programação. Acesse a página Bibliotecas e exemplos para mais detalhes.

Como receber e usar uma chave de API

As solicitações de dados públicos à API JSON do Blogger precisam incluir um identificador, que pode ser uma chave de API ou um token de autenticação.

Para adquirir uma chave de API, visite o Console de APIs. No painel Serviços, ative [api_name]. Se os Termos de Serviço aparecerem, leia e aceite eles.

Em seguida, vá para o painel Acesso à API. A chave de API fica na parte de baixo do painel, na seção "Simple API Access".

Quando você está com uma chave de API, seu aplicativo pode anexar o parâmetro de consulta key=yourAPIKey a todos os URLs das solicitações.

A chave de API é segura para ser incorporada a URLs sem precisar de codificação.

Como trabalhar com blogs

Como recuperar um blog

Você pode recuperar informações de um recurso de blogs específico enviando uma solicitação GET HTTP para o URI do blog. O URI de um recurso de blogs tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar um blog público, não é necessário fornecer o cabeçalho HTTP Authorization com a solicitação GET. Porém, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e os dados do blog:

200 OK

{
  "kind": "blogger#blog",
  "id": "2399953",
  "name": "Blogger Buzz",
  "description": "The Official Buzz from Blogger at Google",
  "published": "2007-04-23T22:17:29.261Z",
  "updated": "2011-08-02T06:01:15.941Z",
  "url": "http://buzz.blogger.com/",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953",
  "posts": {
    "totalItems": 494,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts"
  },
  "pages": {
    "totalItems": 2,
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages"
  },
  "locale": {
    "language": "en",
    "country": "",
    "variant": ""
  }
}

Como recuperar os blogs de um usuário

Você pode recuperar uma lista dos blogs de um usuário enviando uma solicitação GET HTTP ao URI de coleta de blogs:

https://www.googleapis.com/blogger/v2/users/userId/blogs

Solicitação

Confira um exemplo de uma solicitação GET que lista os blogs de um usuário:

GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */

Observação: como o usuário precisa estar autenticado para listar os próprios blogs, você precisa fornecer o cabeçalho HTTP Authorization com a solicitação GET.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e toda a representação da lista de blogs do usuário:

200 OK

{
  "kind": "blogger#blogList",
  "items": [
    {
      "kind": "blogger#blog",
      "id": "4967929378133675647",
      "name": "Brett's Test Blawg",
      "description": "",
      "published": "2010-10-06T23:33:31.662Z",
      "updated": "2011-08-08T06:50:02.005Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647",
      "posts": {
        "totalItems": 13,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts"
      },
      "pages": {
        "totalItems": 1,
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages"
      },
      "locale": {
        "language": "en",
        "country": "",
        "variant": ""
      }
    }
  ]
}

Como trabalhar com publicações

Recuperar postagens de um blog

Para recuperar uma lista de postagens de um determinado blog, envie uma solicitação GET ao URI da coleção de postagens. O URI de uma coleção de postagens tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar as postagens de um blog público, não é necessário fornecer o cabeçalho HTTP Authorization com a solicitação GET. Porém, se você não fornecer o cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e a lista de postagens:

200 OK

{
  "kind": "blogger#postList",
  "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ",
  "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ",
  "items": [
    {
      "kind": "blogger#post",
      "id": "7706273476706534553",
      "blog": {
        "id": "2399953"
      },
      "published": "2011-08-01T19:58:00.000Z",
      "updated": "2011-08-01T19:58:51.947Z",
      "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
      "title": "Latest updates, August 1st",
      "content": "elided for readability",
      "author": {
        "id": "401465483996",
        "displayName": "Brett Wiltshire",
        "url": "http://www.blogger.com/profile/01430672582309320414",
        "image": {
          "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
         }
      },
      "replies": {
        "totalItems": "0",
        "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
      }
    },
    {
      "kind": "blogger#post",
      "id": "6069922188027612413",
      elided for readability
    }
  ]
}

Recuperar uma postagem específica

Para recuperar uma postagem específica de um blog, envie uma solicitação GET ao URI do recurso de postagens. O URI de um recurso de postagens tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar as postagens de um blog público, não é necessário fornecer o cabeçalho HTTP Authorization com a solicitação GET. Porém, se você não fornecer o cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e o conteúdo da postagem:

200 OK

{
  "kind": "blogger#post",
  "id": "7706273476706534553",
  "blog": {
    "id": "2399953"
  },
  "published": "2011-08-01T19:58:00.000Z",
  "updated": "2011-08-01T19:58:51.947Z",
  "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553",
  "title": "Latest updates, August 1st",
  "content": "elided for readability",
  "author": {
    "id": "401465483996",
    "displayName": "Brett Wiltshire",
    "url": "http://www.blogger.com/profile/01430672582309320414",
    "image": {
      "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png"
    }
  },
  "replies": {
    "totalItems": "0",
    "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments"
  }
}

Como trabalhar com comentários

Recuperar comentários de uma postagem

Para recuperar uma lista de comentários de uma postagem, envie uma solicitação GET ao URI da coleta de comentários. O URI de uma Coleção de comentários tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar os comentários de um blog público, você não precisa fornecer o cabeçalho HTTP Authorization com essa solicitação GET. Porém, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e a lista de comentários:

200 OK

{
  "kind": "blogger#commentList",
  "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ",
  "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ",
  "items": [
    {
       "kind": "blogger#comment",
       "id": "9200761938824362519",
       "post": {
         "id": "6069922188027612413"
       },
       "blog": {
         "id": "2399953"
       },
       "published": "2011-07-28T19:19:57.740Z",
       "updated": "2011-07-28T21:29:42.015Z",
       "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
       "content": "elided",
       "author": {
         "id": "530579030283",
         "displayName": "elided",
         "url": "elided",
         "image": {
           "url": "elided"
         }
       }
    },
    {
      "kind": "blogger#comment",
      "id": "400101178920857170",
      elided for readability
    }
  ]
}

Recuperar um comentário específico

Para recuperar um comentário específico de uma postagem, envie uma solicitação GET ao URI do recurso de comentários. O URI de um recurso de comentários tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar os comentários de um blog público, você não precisa fornecer o cabeçalho HTTP Authorization com essa solicitação GET. Porém, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e os dados do comentário:

200 OK

{
  "kind": "blogger#comment",
  "id": "9200761938824362519",
  "post": {
    "id": "6069922188027612413"
  },
  "blog": {
    "id": "2399953"
  },
  "published": "2011-07-28T19:19:57.740Z",
  "updated": "2011-07-28T21:29:42.015Z",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519",
  "content": "elided",
  "author": {
    "id": "530579030283",
    "displayName": "elided",
    "url": "elided",
    "image": {
      "url": "elided"
    }
  }
}

Como trabalhar com páginas

Recuperar páginas de um blog

Para recuperar uma lista das páginas de um blog, envie uma solicitação GET ao URI do conjunto de páginas. O URI de uma coleção de páginas tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar as páginas de um blog público, não é necessário fornecer o cabeçalho HTTP Authorization com a solicitação GET. Porém, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e a lista de páginas:

200 OK

{
  "kind": "blogger#pageList",
  "items": [
    {
      "kind": "blogger#page",
      "id": "273541696466681878",
      "blog": {
        "id": "4967929378133675647"
      },
      "published": "2011-07-14T16:16:00.000Z",
      "updated": "2011-07-14T16:16:23.602Z",
      "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
      "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
      "title": "Static Content",
      "content": "elided for readability",
      "author": {
        "id": "901569848744",
        "displayName": "brett",
        "url": "http://www.blogger.com/profile/16258312240222542576",
        "image": {
          "url": "https://resources.blogblog.com/img/b16-rounded.gif"
        }
      }
    }
  ]
}

Recuperar uma página específica

Para recuperar uma página específica de um blog, envie uma solicitação GET ao URI do recurso de páginas. O URI de um recurso de páginas tem o seguinte formato:

https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId

Solicitação

Confira um exemplo:

GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY

Como um usuário não precisa ser autenticado para recuperar as páginas de um blog público, não é necessário fornecer o cabeçalho HTTP Authorization com a solicitação GET. Porém, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem blogs privados, que exigem autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e os dados da página:

200 OK

{
  "kind": "blogger#page",
  "id": "273541696466681878",
  "blog": {
    "id": "4967929378133675647"
  },
  "published": "2011-07-14T16:16:00.000Z",
  "updated": "2011-07-14T16:16:23.602Z",
  "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html",
  "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878",
  "title": "Static Content",
  "content": "elided for readability",
  "author": {
    "id": "901569848744",
    "displayName": "brett",
    "url": "http://www.blogger.com/profile/16258312240222542576",
    "image": {
      "url": "https://resources.blogblog.com/img/b16-rounded.gif"
    }
  }
}

Trabalhar com usuários

Como recuperar um usuário

Para recuperar as informações de um usuário, envie uma solicitação HTTP GET ao URI do recurso "Users":

https://www.googleapis.com/blogger/v2/users/userId

Solicitação

Confira um exemplo de uma solicitação GET que lista os blogs de um usuário:

GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */

Observação: como o usuário precisa ser autenticado para listar as próprias informações, você precisa fornecer o cabeçalho HTTP Authorization com a solicitação GET.

Resposta

Se a solicitação for bem-sucedida, o servidor responderá com um código de status HTTP 200 OK e um link para uma lista dos blogs do usuário:

200 OK

{
  "kind": "blogger#user",
  "id": "901569848744",
  "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744",
  "blogs": {
    "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs"
  }
}

Parâmetros de consulta padrão

Os parâmetros de consulta a seguir podem ser usados com todos os métodos e recursos nas APIs do Blogger.

Os parâmetros de consulta que se aplicam a todas as operações das APIs do Blogger estão documentados em Parâmetros do sistema.