Método Login de usuário (Login)
Objetivo
Este método tem o objetivo de efetua a autenticação do usuário no sistema. Caso os dados de login sejam válidos será fornecido um token de acesso que deverá ser utilizado para futuras autenticações durante a navegação. Caso os dados de login sejam inválidos o web service irá retornar o código de erro 401.
Login de usuário
O acesso ao serviço é feito pelo método: Login.
É necessário informar o User e o Password válidos.
As seguintes informações deverão ser informadas na requisição JSON:
Resquest
Response
Método Logout de usuário (Logout)
Objetivo
Este método tem o objetivo de invalidar o token de acesso que estava sendo utilizado pelo usuário, forçando que um novo login seja feito.
Logout de usuário
O acesso ao serviço é feito pelo método: Logout.
É necessário informar o Token.
As seguintes informações deverão ser informadas na requisição JSON:
Request
Response
Método Keep alive (KeepAlive)
Objetivo
Este método por objetivo renovar a validade do token de acesso, evitando que este expire enquanto o usuário ainda está utilizando a página.
Os tokens expiram automaticamente 20 minutos após sua criação, portanto esta web service deve ser chamado em um intervalo de tempo inferior a 20 minutos, sendo sugerido chamar esta web service a cada 15 minutos enquanto a página estiver aberta.
A validade máxima de um token é de 10 horas, após este período o token não poderá mais ser renovado, sendo necessário efetuar um novo login.
Keep Alive
O acesso ao serviço é feito pelo método: KeepAlive.
É necessário informar o token de acesso.
As seguintes informações deverão ser informadas na requisição JSON:
Request
Response
Método Links disponíveis (GetLinks)
Objetivo
Este método tem o objetivo retornar os links aos quais o usuário tem acesso. Este web service pode ser chamado sem informar nenhum token de acesso, neste caso serão retornados os links padrões que estão disponíveis para qualquer usuário que não esteja logado.
Links disponíveis
O acesso ao serviço é feito pelo método: GetLinks.
O token de acesso é opcional.
As seguintes informações deverão ser informadas na requisição JSON:
Request
Response
Método Salvar ordem de links (SetOrder)
Objetivo
Este método tem por objetivo salvar a ordenação de links customizada pelo usuário, devendo ser enviada uma lista com os códigos dos links na ordem em que o usuário definiu.
Salvar ordem de links
O acesso ao serviço é feito pelo método: SetOrder.
É necessário informar o token de acesso.
As seguintes informações deverão ser informadas na requisição JSON:
Request
Response
Método Receber notícias (GetNews)
Objetivo
Este método tem por objetivo retornar a lista de notícias correspondentes a cada usuário.
Receber notícias
O acesso ao serviço é feito pelo método: GetNews.
As seguintes informações deverão ser informadas na requisição JSON:
Request
Response
Erros
Erros no acesso ao Web Service
Os códigos de retorno seguem o padrão definido pela W3, disponível em http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html .
Tabela de Erros Retornados
