wiki:RESTDraft

Version 4 (modified by adir, 12 years ago) (diff)

--

Expresso Web Service

Este Draft é destinado à especificação dos requisitos referentes à implementação do Web Service do Expresso. Todas as informações contidas neste documento poderão sofrer alterações sem aviso prévio, até o fechamento do escopo deste subprojeto do Expresso.


1. Objetivo

Implementação de uma camada RESTful no Expresso.


2. Compatibilidade

API: Versões > 2.4

ExpressoMail?: Versões > 2.4

ContactCenter?: Versões > 2.4


3. Arquitetura


4. Protocolo de Comunicação

HTTP 1.1


5. Recursos disponíveis



URI:/rest/token/Autentica consumidor através do protocolo OAuth2 ( http://tools.ietf.org/html/draft-ietf-oauth-v2-25)
Método:POST
Parâmetros: grant_type:(authorization_code/password/token/refresh_token)
Retorno: {

"access_token":"2YotnFZFEjr1zCsicMWpAA",
"token_type":"example",
"expires_in":3600,
"refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
"example_parameter":"example_value"

}

Retorno de Exemplo (JSON): {}


URI:/rest/maillast/Retorna as últimas 20 mesagens não lidas.
Método:GET
Parâmetros: Sem Parametros
Retorno:
Retorno de Exemplo (JSON): {}



URI:/rest/calendarlast/Retona os últimos 10 eventos do usuário.
Método:GET
Parâmetros: Sem Parametros
Retorno:
Retorno de Exemplo (JSON): {}



URI:/rest/newslast/Retonar os últimos 10 boletins internos do usuário.
Método:GET
Parâmetros: Sem Parametros
Retorno:
Retorno de Exemplo (JSON): {}



6. Recursos a serem implementados