Utilização

O suporte REST criado oferece um conjunto de funcionalidades:

Autenticação

Login.

Para permitir que o usuário se autentique no portal por uma aplicação externa, foi provida uma chamada de autenticação REST conforme o formato a seguir.

{protocolo}://{domínio}[:porta]/lumis/api/rest/lumlogin?username={user-name}[&password=password][&locale=locale]

Os exemplos a seguir são chamadas válidas para autenticação no Lumis Portal:

Logout.

Esta chamada deve encerrar a sessão do usuário no portal.

{protocolo}://{domínio}[:porta]/lumis/api/rest/logout

Mudança de Locale

Foi criada uma chamada capaz de alterar o idioma da sessão atual (guest ou autenticada). O formato básico é mostrado a seguir.

{protocolo}://{domínio}[:porta]/lumis/api/rest/lumsetlocale/[locale]

Exemplos:

Caso o ‘locale’ mencionado não seja suportado pelo portal, o idioma atual será mantido.

Se o parâmetro não for especificado, o portal será retornado para o ‘locale’ padrão.

Leitura de Interface REST

Foi criada uma chamada capaz de consultar as informações contidas nos sources definidos nas interfaces REST. O formato básico é mostrado a seguir.

{protocolo}://{domínio}[:porta]/lumis/api/rest/{nome-rest}/lumgetdata/{restinterface-name}[.returnType][parameters]

Exemplos:

Os parâmetros podem ser:
 

Esse parâmetro é opcional e é utilizado como no exemplo a seguir, que traz as cinco primeiras notícias publicadas na instância de serviço chamada ‘noticias’.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json?lumMaxRows=5

Esse parâmetro é opcional e é utilizado como no exemplo a seguir, que traz a segunda página de notícias publicadas na instância de serviço chamada ‘noticias’, considerando cinco notícias por página.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json?lumMaxRows=5&lumStartAt=6

Esse parâmetro é opcional e é utilizado para definir uma ordenação por um determinado campo em ordem crescente ou decrescente (ASC ou DESC respectivamente).

O exemplo a seguir ordena as notícias adquiridas pelo seu titulo, de forma ascendente.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json?lumMaxRows=5&lumStartAt=6&lumOrderBy=Title ASC

         Este parâmetro define quais campos deverão ser retornados. Por padrão, quando este parâmetro não for informado serão retornados todos os campos definidos explicitamente no source da interface REST juntamente com os campos "Chave primária do source" e o "Identificador de Conteúdo" (caso seja um serviço de conteúdo). Quando este parâmetro for informado os campos que serão retornados serão os definidos na lista de campos que devem ser separados por vírgula (","). Caso seja desejado o retorno de todos os campos basta informar "*" como valor do parâmetro lumReturnFields.

O exemplo a seguir retorna os campos chave, identificador do conteúdo juntamente com os campos explícitos da interface REST.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json

O exemplo a seguir retorna os campos descrição e quem criou o conteúdo.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json?lumReturnFields=createdBy,description

O exemplo a seguir retorna todos campos do source.

         http://www.lumis.com.br/lumis/api/rest/noticias/lumgetdata/lista.json?lumReturnFields=*