Esta página foi traduzida pela API Cloud Translation.

API do Blogger: primeiros passos

Este documento explica como começar a usar a API do Blogger.

Antes de começar

Criar uma Conta do Google

Confira se você tem uma Conta do Google configurada. Recomendamos usar uma Conta do Google separada para fins de desenvolvimento e teste, a fim de se proteger contra perda acidental de dados. Se você já tiver uma conta de teste, não precisa fazer mais nada. Acesse a interface do usuário do Blogger para configurar, editar ou visualizar os dados de teste.

Conhecer o Blogger

Se você não conhece os conceitos do Blogger, leia este documento e teste a interface do usuário antes de começar a programar. Para seguir este documento, é necessário ter familiaridade com o Blogger, conceitos de programação da Web e formatos de dados da Web.

Saiba mais sobre como autorizar solicitações e identificar seu aplicativo

Quando seu aplicativo solicita dados privados, a solicitação precisa ser autorizada por um usuário autenticado com acesso a esses dados.

Quando o aplicativo solicita dados públicos, a solicitação não precisa ser autorizada, mas precisa ser acompanhada de um identificador, como uma chave de API.

Para informações sobre como autorizar solicitações e usar chaves de API, consulte Como autorizar solicitações e identificar seu aplicativo no documento Como usar a API.

Informações sobre a API do Blogger

Conceitos do Blogger

O Blogger tem cinco conceitos básicos:

Blogs: o conceito raiz da API. Um blog tem postagens e páginas. Esse é o contêiner para as metainformações do blog, como o nome do blog e a descrição.
Postagens: uma postagem de blog é o item publicável que o autor do blog criou. Essas informações precisam ser oportunas, refletindo o que os autores querem publicar para o mundo agora. Entendemos que, com o passar do tempo, o conteúdo das postagens do blog envelhece e se torna menos relevante.
Comentários: um comentário é onde pessoas que não são o autor da postagem do blog reagem ao que ele escreveu. Tudo, de tijolos a buquês.
Páginas: uma página é um lugar para conteúdo estático, como informações biográficas ou maneiras de entrar em contato com o usuário. Essas informações geralmente são atemporais e não mudam com muita frequência.
Usuários: um usuário é alguém que interage com o Blogger, seja ele o autor, o administrador ou apenas um leitor. Em blogs públicos, os leitores podem ser anônimos, mas em blogs particulares um leitor precisa ser identificado pelo Blogger.

Modelo de dados da API Blogger

Um recurso é uma entidade individual de dados com um identificador exclusivo. A API JSON do Blogger opera em cinco tipos de recursos:

Recurso "Blogs": representa um blog.
Recurso de postagens: representa uma postagem. Cada recurso de postagens é filho de um recurso de blogs.
Recurso de comentários: representa um comentário em uma postagem específica. Cada recurso de comentários é filho de um recurso de postagens.
Recurso de páginas: representa uma página estática. Cada recurso de páginas é filho de um recurso de blogs.
Recurso "Usuários": representa um usuário não anônimo. É usado para identificar o autor de uma página, postagem ou comentário.

O recurso de blogs tem dois tipos de recursos filhos: páginas e postagens.
Um recurso de postagens pode ter comentários como filhos. — Visão geral das relações entre os recursos

O modelo de dados da API do Blogger é baseado em grupos de recursos, chamados coleções:

Coleção "Blogs": Uma <span="apicollection">coleção de blogs consiste em todos os blogs aos quais um usuário tem direitos de acesso. Você pode listar os blogs por usuário ou recuperar um único blog por ID.</span="apicollection">
Coleção de postagens: Uma coleção de postagens consiste em todos os recursos de postagens em um recurso de blogs específico.
Coleção "Comentários": Uma coleção de comentários consiste em todos os recursos de comentários em um recurso de postagens específico.
Coleção Páginas: Um conjunto de páginas consiste em todos os recursos de páginas em um recurso de blogs específico.
Coleção "Users": Uma coleção de usuários consiste em todos os recursos de usuários no Blogger e, portanto, não pode ser listada. Um usuário pode recuperar o próprio recurso de usuários (mas de ninguém mais) por ID ou usando o identificador self.

Operações da API do Blogger

Você pode invocar vários métodos diferentes em coleções e recursos na API do Blogger, conforme descrito na tabela a seguir.

Operação	Descrição	Mapeamentos HTTP REST
list	Lista todos os recursos em uma coleção.	`GET` em um URI de coleta.
get	Recebe um recurso específico.	`GET` em um URI de recurso.
getByUrl	Recebe um recurso pesquisando por URL.	`GET` pelo URL transmitido como um parâmetro.
getByPath	Recebe um recurso pesquisando-o pelo caminho.	`GET` pelo caminho transmitido como um parâmetro.
listByUser	Lista os recursos de propriedade de um usuário.	`GET` em uma coleção que pertence ao usuário.
search	Pesquisa recursos com base em um parâmetro de consulta.	`GET` em um URL de pesquisa, com a consulta transmitida como um parâmetro.
inserir	Criar um recurso em uma coleção.	`POST` em um URI de coleta.
excluir	Exclui um recurso.	`DELETE` em um URI de recurso.
patch	Atualizar um recurso usando a semântica de patch.	`PATCH` em um URI de recurso.
update	Atualizar um recurso.	`PUT` em um URI de recurso.

A tabela abaixo mostra os métodos compatíveis com cada tipo de recurso. Todas as operações list e get em blogs particulares exigem autenticação.

Tipo de recurso	Métodos suportados
	lista	obter	getByUrl	getByPath	listByUser	pesquisar	inserir	excluir	patch	atualizar
Blogs	não	sim	sim	não	sim	não	não	não	não	não
Postagens	sim	sim	não	sim	não	sim	sim	sim	sim	sim
Comentários	sim	sim	não	não	não	não	não	não	não	não
Páginas	sim	sim	não	não	não	não	não	não	não	não
Usuários	não	sim	não	não	não	não	não	não	não	não

Como chamar estilos

Há diversas maneiras de chamar a API:

Usar REST diretamente ou JavaScript (sem necessidade de código do lado do servidor)
Usar as bibliotecas de cliente.

REST

REST é um estilo de arquitetura de software que fornece uma abordagem conveniente e consistente para solicitar e modificar dados.

O termo REST é a sigla de "Representational State Transfer". No contexto das APIs do Google, ele se refere ao uso de verbos HTTP para recuperar e modificar representações de dados armazenados pelo Google.

Em um sistema RESTful, os recursos são mantidos em um armazenamento de dados. Um cliente envia uma solicitação para que uma ação específica seja executada no servidor, como a criação, recuperação, atualização ou exclusão de um recurso. Essa ação é executada e uma resposta é enviada, geralmente no formato de uma representação do recurso especificado.

Nas APIs RESTful do Google, o cliente especifica uma ação usando um verbo HTTP, como POST, GET, PUT ou DELETE. Ele especifica um recurso por um URI globalmente exclusivo no seguinte formato:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Como todos os recursos da API têm URIs exclusivos acessíveis por HTTP, a REST permite o armazenamento em cache dos dados e é otimizada para funcionar na infraestrutura distribuída da Web.

As definições de método (em inglês) encontradas na documentação dos padrões HTTP 1.1 podem ser úteis. Nelas estão incluídas as especificações GET, POST, PUT e DELETE.

REST na API do Blogger

As operações compatíveis do Blogger são mapeadas diretamente para verbos HTTP REST, conforme descrito em Operações da API do Blogger.

O formato específico dos URIs da API do Blogger é:

https://www.googleapis.com/blogger/v3/users/userId
https://www.googleapis.com/blogger/v3/users/self
https://www.googleapis.com/blogger/v3/users/userId/blogs
https://www.googleapis.com/blogger/v3/users/self/blogs
https://www.googleapis.com/blogger/v3/blogs/blogId
https://www.googleapis.com/blogger/v3/blogs/byurl
https://www.googleapis.com/blogger/v3/blogs/blogId/posts
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments
https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId
https://www.googleapis.com/blogger/v3/blogs/blogId/pages
https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId

A explicação completa dos URIs usados e os resultados de cada operação compatível na API está resumida no documento de Referência da API do Blogger.

Exemplos

Liste os blogs em que o usuário autenticado tem direitos de acesso:

GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY

Consulte as postagens no blog code.blogger.com, que tem o ID de blog 3213900:

GET https://www.googleapis.com/blogger/v3/blogs/3213900?key=YOUR-API-KEY

REST a partir de JavaScript

Você pode invocar a API do Blogger a partir do JavaScript, usando o parâmetro de consulta callback e fornecendo uma função de callback. Quando o navegador carrega o script, a função de callback é executada, e a resposta é fornecida à função de callback. Com essa abordagem, é possível desenvolver aplicativos avançados que exibem dados do Blogger sem precisar do código do lado do servidor.

O exemplo a seguir recupera uma postagem do blog code.blogger.com depois que você substitui YOUR-API-KEY pela chave de API.

<html>
  <head>
    <title>Blogger API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function handleResponse(response) {
        document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
      }
    </script>
    <script
    src="https://www.googleapis.com/blogger/v3/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
  </body>
</html>

Formato de dados

JSON

JSON (JavaScript Object Notation) é um formato de dados comum e independente de linguagem que oferece uma representação de texto simples das estruturas de dados arbitrárias. Para mais informações, acesse json.org (em inglês).