Você não está logado • ( Entrar ou Cadastrar ) • Ajuda • Contato • Feeds

Blog Blogs - A maior comunidade de Blogs do Brasil!

Ranking • Blogs • Posts • Tags • Bookmarks novo • Pessoas • Weblog

BlogBlogs FAQs - Perguntas & Respostas Mais Freqüêntes

Introdução à API do BlogBlogs

1. Introdução

Este documento apresenta a documentação da API Pública do BlogBlogs (BBAPI). Em linhas gerais a BBAPI permite que outros sistemas façam consultas ou disparem eventos no BlogBlogs. Com poucas exceções todas as funções da API serão disponibilizadas através da abordagem REST. Assim, as chamadas serão realizadas através de simples chamadas HTTP com URLs especialmente formatados e as respostas serão sempre na forma de documentos XML (podendo também ser RSS e outros formatos).

2. Funcionamento da API

2.1. Autenticação

Com raras exceções, todas as chamadas exigiram a utilização de uma chave de acesso (BBAPI KEY) para autenticar o usuário que está realizando a chamada. Este mecanismo também será utilizado para controlar o uso da API e evitar abusos.

A BBAPI KEY será disponibilizada através do site do BlogBlogs e estará sempre associada a um usuário cadastrado e ativo do sistema.

2.2. Chamada

As chamadas poderão ser feitas através de requisições HTTP-POST ou HTTP-GET. Abaixo temos um exemplo de URL para o método userinfo da API.

http://api.blogblogs.com.br/api/rest/userinfo?key=XXXXXX&username=YYYYYY

Observe que o host deverá ser sempre o api.blogblogs.com.br, pois num futuro próximo poderemos ter hosts dedicados somente a servir os serviços da API.

2.3. Resposta

As respostas serão sempre na forma de documentos XML. As respostas com erros seguiram um único formato (apresentado abaixo) e as respostas com sucesso serão definidas em cada método da API.

Resposta com Erro:

<?xml version="1.0" encoding="utf-8"?>
<!-- generator="BlogBlogs API version 1.0" -->
<bbapi version='1.0'>
  <document>
    <result>
      <error>[mensagem de erro]</error>
    </result>
  </document>
</bbapi>