= 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 == === 3.1 Hypermedia Design Elements === * Base Format: JSON * State Transfer: Predefined * Domain Style: General * Application Flow: Intrisic ---- == 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) \\ client_id: <> \\ client_secret: <> \\ username: <> \\ password: <>|| || ||'''Retorno:'''|| access_token \\ token_type \\ expires_in \\ refresh_token \\ scope || ||Retorno de Exemplo (JSON):|||| {"access_token":"f706cf62c913163498b8258eb88b164392a4bc4e","expires_in":3600,"token_type":"bearer","scope":"all","refresh_token":"6ba7d0d7cd4e7ff315f4fbf26a5585a4ca56cceb"} \\ \\ ||'''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 == \\ \\