Documentação da API do OpenSocial
A API do OpenSocial é um conjunto de APIs comuns para desenvolver aplicativos sociais que irão funcionar em diversos sites. Há duas maneiras de acessar a API do OpenSocial: usando a API JavaScript no lado do cliente e usando APIs de dados RESTful no lado do servidor.
API JavaScript
A API JavaScript reside sob o namespace opensocial.* e fornece acesso às três áreas principais de funcionalidade:
- Pessoas -- informações sobre indivíduos e seus relacionamentos entre si
- Atividades -- capacidade de postar e exibir atualizações sobre as ações das pessoas
- Persistência -- uma armazenagem simples de dados de valor essencial para permitir aplicativos livres de servidor
Veja o que você pode fazer com a API JavaScript:
- Criar aplicativos sem manter seu próprio servidor
- Criar aplicativos que incluam um componente do lado do servidor (para processamento off-line e/ou acesso de outros sites)
- Criar aplicativos totalmente novos
- Expor aplicativos de web existentes no contexto dos sites sociais existentes
- Adicionar recursos sociais aos gadgets existentes
- Criar um aplicativo que possa ser executado no contexto de muitos sites sociais diferentes
A API JavaScript foi criada para usar tecnologias padrão da web:
- É fornecida como um conjunto de métodos do namespace opensocial.*.
- Permite usar qualquer técnica padrão de programação JavaScript e bibliotecas de terceiros.
- Inclui um sistema completo de retorno de chamada assíncrono para suportar interatividade AJAX rica.
Para criar um aplicativo usando a API JavaScript do OpenSocial, leia o Guia Primeiros passos ou assista ao Tutorial do OpenSocial.
API de dados RESTful
A API de dados RESTful fornece funcionalidade complementar à API JavaScript, para que você possa ter acesso às pessoas, atividades e dados de seu servidor.
A API de dados RESTful também foi criada para usar tecnologias padrão da web:
- As interações entre servidores são baseadas no protocolo RESTful AtomPub.
- A autenticação é tratada pelo OAuth.