API Blogger JSON: como usar a API

Importante: Vamos descontinuar o suporte para a 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 da API. Para a versão mais recente, use os links na barra de navegação do lado esquerdo.

Este documento descreve como usar os recursos comuns da API JSON do Blogger usando o estilo de chamada RESTful.

Conteúdo

Introdução

Este documento se destina aos desenvolvedores que desejam criar aplicativos que podem interagir com a API JSON do Blogger. O Blogger é uma ferramenta para criar sites que permitem que as pessoas publiquem seus pensamentos sobre um base.

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

Como autorizar solicitações e identificar seu aplicativo

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

  • Se a solicitação exige autorização, como uma solicitação de dados particulares de um indivíduo, o aplicativo precisa fornecer um token OAuth 2.0 com a solicitação. O aplicativo também pode fornecer 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 precisa fornecer a chave de API, um token OAuth 2.0 ou ambos, dependendo do que for mais conveniente para você.

Sobre os protocolos de autorização

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

Observação: no momento, a API JSON do Blogger não permite o registro em log. ao mesmo tempo que a solicitação de acesso aos dados (híbrido) ou em todo o domínio delegação de autoridade (2LO).

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

As solicitações para a API JSON do Blogger referentes 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 seguinte O processo geral se aplica a todos os tipos de aplicativos:

  1. Ao criar seu aplicativo, você o registra no Google. Google e fornece informações que serão necessárias mais tarde, como um ID de cliente e um ID segredo.
  2. Ative a API JSON do Blogger no painel "Serviços" das APIs do Google do Cloud. 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 uma escopo específico de acesso.
  4. O Google exibe uma caixa de diálogo do OAuth para o usuário, pedindo que ele autorize o aplicativo a solicitar alguns dos dados dele.
  5. Se o usuário aprovar, o Google concederá ao aplicativo uma vida curta token de acesso.
  6. Seu aplicativo solicita dados do usuário, anexando o token de acesso ao solicitação.
  7. Se o Google determinar que a solicitação e o token são válidos, ele vai retornar os dados solicitados.

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

Confira as informações de escopo do OAuth 2.0 para a API JSON do Blogger:

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

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

Dica: as bibliotecas de cliente das APIs do Google podem processar 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 de bibliotecas e exemplos para mais detalhes.

Como adquirir 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, acesse o Console de APIs. Nos Serviços ative a API [api_name]; se os Termos de Serviço aparecerem, leia e aceite para resolvê-los com rapidez.

Em seguida, acesse a API Acesso. A chave de API está na parte inferior do painel, na seção intitulado "Acesso simples à API".

Quando você tem uma chave de API, seu aplicativo pode anexar o parâmetro de consulta key=yourAPIKey para todas as solicitações URLs.

É seguro incorporar a chave de API a URLs. Não é necessário codificá-la.

Como trabalhar com blogs

Recuperar um blog

É possível recuperar informações de um determinado recurso de blogs enviando uma solicitação GET HTTP para o URI do blog. O URI de um recurso Blogs tem o seguinte formato:

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

Solicitação

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, você não precisa fornecer o cabeçalho HTTP Authorization com essa solicitação GET. No entanto, 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 vai 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

É possível recuperar uma lista de blogs de um usuário enviando uma solicitação HTTP GET para o URI da coleção de blogs:

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

Solicitação

Aqui está um exemplo de uma solicitação GET que lista um blogs de usuários:

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

Observação: o usuário precisa estar autenticado no listar os próprios blogs, portanto, você deve fornecer o parâmetro HTTP Authorization com a solicitação GET.

Resposta

Se a solicitação for bem-sucedida, o servidor responde com uma solicitação O código de status 200 OK e a representação completa da lista do blogs:

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": ""
      }
    }
  ]
}

Trabalhar com postagens

Como recuperar postagens de um blog

Você pode recuperar uma lista de postagens de um determinado blog enviando um 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

Exemplo:

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

Como um usuário não precisa estar autenticado para recuperar as postagens de um blog público, você não precisam fornecer o cabeçalho HTTP Authorization com isso Solicitação GET; mas se você não fornecer esse cabeçalho, precisará 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 responde com uma solicitação O código de status 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
    }
  ]
}

Como recuperar uma postagem específica

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

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

Solicitação

Exemplo:

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

Como um usuário não precisa estar autenticado para recuperar as postagens de um blog público, você não precisam fornecer o cabeçalho HTTP Authorization com isso Solicitação GET; mas se você não fornecer esse cabeçalho, precisará 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 vai 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 para o URI da coleção 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

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. No entanto, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem Blogs privados, o que exige autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor vai 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
    }
  ]
}

Como recuperar um comentário específico

Para recuperar um comentário específico de uma postagem, envie uma solicitação GET para o 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

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. No entanto, se você não fornecer esse cabeçalho, será necessário fornecer uma chave de API.

O Blogger também tem Blogs privados, o que exige autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor vai 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

Como recuperar páginas de um blog

Para recuperar uma lista de páginas de um blog, envie uma solicitação GET para o URI da coleção de páginas. O URI de uma página A coleção tem o seguinte formato:

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

Solicitação

Exemplo:

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

Como um usuário não precisa estar autenticado para recuperar as Páginas de um blog público, você não precisam fornecer o cabeçalho HTTP Authorization com isso Solicitação GET; mas se você não fornecer esse cabeçalho, precisará fornecer uma chave de API.

O Blogger também tem Blogs privados, o que exige autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor vai 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"
        }
      }
    }
  ]
}

Como recuperar uma página específica

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

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

Solicitação

Exemplo:

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

Como um usuário não precisa estar autenticado para recuperar as Páginas de um blog público, você não precisam fornecer o cabeçalho HTTP Authorization com isso Solicitação GET; mas se você não fornecer esse cabeçalho, precisará fornecer uma chave de API.

O Blogger também tem Blogs privados, o que exige autenticação.

Resposta

Se a solicitação for bem-sucedida, o servidor responde com um Código de status 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"
    }
  }
}

Como trabalhar com usuários

Como recuperar um usuário

É possível recuperar as informações de um usuário enviando uma solicitação GET HTTP. para o URI do recurso Usuários:

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

Solicitação

Confira um exemplo de 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: o usuário precisa estar autenticado no listar as próprias informações. Portanto, é necessário fornecer o parâmetro HTTP Authorization com a solicitação GET.

Resposta

Se a solicitação for bem-sucedida, o servidor responde com um Código de status 200 OK e um link para uma lista dos blogs:

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.