URLs de Acesso¶

Endereços¶

Atualmente temos um repositório de teste cuja URI raiz é: http://divx.lavid.ufpb.br/oauth/.
Ao se configurar o cliente oAuth2, será necessário informar o authorization_endpoint (.../oauth2/authorize/) e o token_endpoint (.../oauth2/token/). Para obter suas chaves de cliente, mande um email para fernando@lavid.ufpb.br.

URL de teste¶

Dentre as URLs disponíveis abaixo, apenas a /apps/<aplicativo>/download necessita de autenticação. Para facilitar os testes, também disponibilizamos a URL http://divx.lavid.ufpb.br/oauth/apps/secret, cujo conteúdo só pode ser visto mediante autenticação. Esta página também exibe quaisquer parâmetros POST ou GET passados na requisição.

URLs¶

Os seguintes endereços estão disponíveis:

• GET /apps
• GET /apps/<nome_aplicativo>
• GET /apps/<nome_aplicativo>/comments
• GET /apps/<nome_aplicativo>/download

• GET /templates
• GET /templates/<nome_template>
• GET /templates/<nome_template>/comments
• GET /templates/<nome_template>/download

• GET /categories
• GET /categories/<nome_categoria>
• GET /categories/<nome_categoria>/apps

• GET /app/categories
• GET /app/categories/<nome_categoria>
• GET /app/categories/<nome_categoria>/apps

• GET /template/categories
• GET /template/categories/<nome_categoria>
• GET /template/categories/<nome_categoria>/templates

Adicione .json ao final das URI para se obter os dados em JSON.

Parâmetros¶

Paginação (a ser implementado)¶

• page: número da página
• per_page: quantidade de aplicativos por página

Disponível em:

• /apps
• /apps/.../comments
• /categories
• /categories/.../apps

Ao se usar esses parâmetros, também será retornado a quantidade de páginas disponíveis.

Ordenação (a ser implementado)¶

• sort_by: pode ser ordenado por rating, downloads e (mais o que?)
• order: pode ser asc ou desc

Disponível em:

• /apps
• /apps/.../comments
• /categories
• /categories/.../apps

Recursos¶

Aplicativos¶

{
  "app": {
    "name":"Velha" 
    "slug":"velha",
    "description":"Jogo da Velha",
    "license": (BY | BY-NC | BY-NC-ND | BY-NC-SA | livre para usuário digitar)*
    "developer":"Fernando Brito",
    "developer_redmine_id": "275" 
    "plataform":"NCL-Lua",
    "rating":4.0,
    "size":null,   
    "category_slug":"jogos",
    "ncl_id":"nclClicks",
    "ncl_main":"JogoVelha_Peta5/main.ncl", 
    "url_icon":"http://divx.lavid.ufpb.br/oauth/icon/1.png", (57x57 - ainda não é certeza)
    "url_screenshot":"http://divx.lavid.ufpb.br/oauth/screenshot/1.png" (800x600 - ainda não é certeza) (opcional)
  }
}

• Mais informações sobre as licenças no Ticket #636

Categorias (Aplicativos e Templates)¶

{
  "category": {
    "description":"Transforme a sua TV em um vídeo-game.",
    "name":"Jogos",
    "slug":"jogos" 
  }
}

Comentários¶

{
  "comment": {
    "title":"Massa!",
    "author":"Fernando Brito",
    "body":"Muito bom esse jogo! Pena que eu sempre perco.",
    "created_at":"2011-07-28T14:41:43Z",
    "app_slug":"velha" 
  }
}