Importante: vamos descontinuar o suporte à API JSON v2.0 em 30 de setembro de 2024. Para continuar funcionando, atualize os aplicativos que usam a API JSON v2.0 para a versão mais recente. Para usar a versão mais recente, use os links na barra de navegação à esquerda.
Este documento explica como começar a usar a API JSON do Blogger.
Conteúdo
Introdução
Este documento é destinado a desenvolvedores que querem criar apps que podem interagir com a API JSON do Blogger.
A API JSON do Blogger estende a versão 2.0 da API Data do Blogger. Se você quiser recuperar dados do Blogger no formato JSON em vez de XML, use a API JSON do Blogger. Se você quiser recuperar dados no formato XML, use a API Blogger Data.
No momento, essa versão da API JSON do Blogger é somente leitura. No entanto, planejamos adicionar recursos de leitura/gravação e outros. Sinta-se à vontade para solicitar outros recursos no fórum de ajuda do Blogger.
Antes de começar
Criar uma Conta do Google
Verifique se você tem uma Conta do Google configurada. Recomendamos que você use uma Conta do Google separada para fins de desenvolvimento e teste para se proteger contra a perda acidental de dados. Se você já tem uma conta de teste, tudo está pronto. Acesse a interface do usuário do Blogger para configurar, editar ou visualizar os dados de teste.
Conheça 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 codificar. Este documento pressupõe que você conheça o Blogger, os conceitos de programação da Web e os formatos de dados da Web.
Saiba como autorizar solicitações e identificar seu aplicativo
Quando seu aplicativo solicita dados particulares, a solicitação precisa ser autorizada por um usuário autenticado com acesso a esses dados.
No caso dos dados públicos, a solicitação não precisa ser autorizada, mas precisa ser acompanhada por um identificador, como uma chave de API.
Para saber 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 gerais sobre a API JSON do Blogger
Conceitos do Blogger
O Blogger foi criado com base em cinco conceitos básicos:
- Blogs: o conceito raiz da API. Um blog tem postagens e páginas. Esse é o contêiner de metainformações do blog, como nome e descrição.
- Postagens: uma postagem de blog é o item publicável que o autor do blog criou. Essas informações são atuais e refletem o que os autores querem publicar para o mundo agora. É sabido que, com o passar do tempo, o conteúdo das postagens do blog fica desatualizado e menos relevante.
- Comentários: é o lugar onde pessoas que não são o autor da postagem do blog reagem ao que ele escreveu. De tijolos a buquês.
- Páginas: é um lugar para conteúdo estático, como informações biográficas ou maneiras de entrar em contato com o usuário. Geralmente, são informações atemporais que não mudam com muita frequência.
- Usuários: são pessoas que interagem com o Blogger, seja como autores, administradores ou apenas leitores. Em blogs públicos, os leitores podem ser anônimos, mas, em blogs privados, o leitor precisa ser identificado pelo Blogger.
Modelo de dados da API JSON do Blogger
Um recurso é uma entidade individual de dados com um identificador exclusivo. A API JSON do Blogger opera em cinco tipos de recursos:
- Recurso de blogs: representa um blog.
- Recurso de postagens: representa uma postagem. Cada recurso de postagens é uma criança 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 "users": representa um usuário não anônimo. Ele é usado para identificar o autor de uma página, postagem ou comentário.
O modelo de dados da API JSON do Blogger é baseado em grupos de recursos, chamados de coleções:
- Coleção de blogs
- A <span="apicollection">Coleção de blogs consiste em todos os blogs a que um usuário tem direitos de acesso. É possível listar blogs por usuário ou recuperar um único blog por ID.</span="apicollection">
- Coleção de postagens
- Uma coleção de posts consiste em todos os recursos de posts em um recurso de blogs específico.
- Coleção de 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 de páginas
- Uma coleção de páginas consiste em todos os recursos de páginas em um recurso de blogs específico.
- Coleção de usuários
- Uma coleção de usuários consiste em todos os
Recursos para usuários no Blogger e, portanto, não pode
ser listada. Um usuário pode recuperar o próprio recurso de usuários
(mas não o de ninguém mais) pelo ID ou usando o identificador
self.
Operações da API JSON do Blogger
É possível invocar dois métodos diferentes em coleções e recursos na API JSON do Blogger, conforme descrito na tabela a seguir.
| Operação | Descrição | Mapeamentos HTTP REST |
|---|---|---|
| list | Lista todos os recursos de uma coleção. | GET em um URI de coletânea. |
| get | Consegue um recurso específico. | GET em um URI de recurso. |
A tabela abaixo mostra quais métodos são 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 |
|
|---|---|---|
| list | get | |
| Blogs | sim | sim |
| Postagens | sim | sim |
| Comentários | sim | sim |
| Páginas | sim | sim |
| Usuários | não | sim |
Como chamar estilos
Há diversas maneiras de chamar a API:
- Usar o REST diretamente ou do JavaScript (nenhum código do lado do servidor é necessário)
- 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 abreviação de "Representational State Transfer (Transferência de Estado Representacional)". 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, uma ação é especificada no cliente usando um verbo HTTP como POST, GET, PUT ou DELETE. Um recurso é definido por meio de um URI global 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 JSON do Blogger
As operações compatíveis do Blogger são mapeadas diretamente para verbos HTTP REST, conforme descrito em Operações da API JSON do Blogger.
O formato específico dos URIs da API JSON do Blogger é:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
A explicação completa dos URIs usados e os resultados de cada operação compatível na API estão resumidos no documento de referência da API JSON do Blogger.
Confira alguns exemplos de como isso funciona na API JSON do Blogger.
Liste os blogs a que o usuário autenticado tem direitos de acesso:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Receber as postagens do blog code.blogger.com (com o ID 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST a partir de JavaScript
É possível invocar a API JSON do Blogger usando REST do JavaScript, com o parâmetro de consulta callback e uma função de callback. Isso permite
criar aplicativos avançados que mostram dados do Blogger sem precisar escrever código do lado do servidor.
O exemplo a seguir recupera uma postagem do blog code.blogger.com (depois de substituir YOUR-API-KEY pela sua chave de API).
<html>
<head>
<title>Blogger JSON 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/v2/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).