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.
Este documento explica como começar a usar a API Blogger JSON.
Conteúdo
Introdução
Este documento é para desenvolvedores que querem criar aplicativos que possam interagir com a API JSON do Blogger.
A API Blogger JSON estende a versão 2.0 da API Blogger Data. 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 de dados do Blogger.
Esta versão da API JSON do Blogger atualmente é somente leitura, mas pretendemos adicionar recursos de leitura/gravação, além de outras funcionalidades. Fique à vontade para solicitar outros recursos no Fórum de Ajuda do Blogger.
Antes de começar
Criar uma Conta do Google
Confira 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 perda de dados acidental. Se você já tem uma conta de teste, então está tudo pronto. Você pode visitar a interface do usuário do Blogger para configurar, editar ou visualizar seus dados de teste.
Conhecer o Blogger
Se você não conhece os conceitos do Blogger, leia este documento e faça testes com a interface do usuário antes de começar a programar. Este documento pressupõe que você esteja familiarizado com o Blogger, com conceitos de programação da Web e 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.
Quando o aplicativo solicita dados públicos, a solicitação não precisa ser autorizada, mas precisa estar acompanhada por 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".
Plano de fundo da API JSON do Blogger
Conceitos do Blogger
O Blogger se baseia em cinco conceitos básicos:
- Blogs: o conceito raiz da API. Um blog tem postagens e páginas. Esse é o contêiner das metainformações do blog, como nome e descrição do blog.
- Postagens: uma postagem do blog é o item publicável criado pelo autor do blog. Essas informações precisam ser atualizadas e refletir o que os autores querem publicar para o mundo agora. Entende-se 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, exceto o autor da postagem do blog, reagem ao que ele escreveu. De 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. Em geral, essas informações são atemporais e não mudam com muita frequência.
- Usuários: um usuário é alguém que interage com o Blogger, seja atuando como autor, administrador ou apenas leitor. Em blogs públicos, os leitores podem ser anônimos, mas em blogs privados, um 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 Blogs: representa um blog.
- Recurso de postagens: representa uma postagem. Cada recurso de postagens é filho de um recurso de blogs.
- Recurso "Comentários": representa um comentário em uma postagem específica. Cada recurso "Comentários" é um filho de um recurso "Postagens".
- Recurso "páginas": representa uma página estática. Cada recurso "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 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 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 Pages
- 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 do Blogger e, portanto, não pode ser listada. Um usuário pode recuperar o próprio Recurso de usuários (mas o de outra pessoa) por 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 Blogger JSON, 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 coleção. |
| get | Recebe 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 |
|
|---|---|---|
| lista | acessar | |
| 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:
- Usando REST diretamente ou usando 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 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 JSON do Blogger
As operações aceitas 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á resumido no documento Referência da API JSON do Blogger.
Confira alguns exemplos de como isso funciona na API JSON do Blogger.
Liste os blogs para os quais o usuário autenticado tem direitos de acesso:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
Veja as postagens no blog code.blogger.com (com ID de blog 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST a partir de JavaScript
Chame a API JSON do Blogger usando o REST a partir de JavaScript, o parâmetro de consulta callback e uma função de callback. Assim, você pode criar aplicativos avançados que exibem dados do Blogger sem precisar escrever códigos do lado do servidor.
O exemplo a seguir recupera uma postagem do blog code.blogger.com (depois de substituir YOUR-API-KEY pela 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).