URLs de Acesso

Version 22 (Fernando Brito, 24/04/2012 16:14) → Version 23/24 (Fernando Brito, 18/05/2012 11:22)

h1. URLs de Acesso

h1. 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.

h2. 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.

h2. 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.

h1. Parâmetros

h2. 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.

h2. 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

h1. Recursos

h2. Aplicativos

<pre>
{
"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)
"file_available": true (true se tiver arquivo para download)

}
}
</pre>

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

h2. Categorias (Aplicativos e Templates)

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

h2. Comentários

<pre>
{
"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"
}
}
</pre>