mms rest api developers guide

Download MMS REST API Developers Guide

Post on 24-Jun-2015

166 views

Category:

Documents

2 download

Embed Size (px)

TRANSCRIPT

Gua del API MMS REST

Pgina 1 de 32 movistar 2009 Reservados todos los derechos.

Contenido1 INTRODUCCIN ................................................................................................................... 4 1.1 ALCANCE ...................................................................................................................... 4 1.2 GLOSARIO .................................................................................................................... 4 2 CONVENCIONES GENERALES ........................................................................................... 5 2.1 PAUTAS GENERALES DE UNA INTERFAZ REST ..................................................... 5 2.2 CONSIDERACIONES ESPECFICAS PARA LA API REST DE MMS ......................... 5 2.2.1 Consideraciones de Seguridad ................................................................................. 7 2.3 CODIFICACIN Y DETALLES DE SERIALIZACIN ................................................... 8 2.3.1 Codificacin para el envo de un MMS: Uso de Formularios .................................... 8 3 DEFINICIN DE LAS OPERACIONES ............................................................................... 11 3.1 ENVO DE MMS .......................................................................................................... 11 3.1.1 Peticin .................................................................................................................... 11 3.1.2 RESPUESTA ........................................................................................................... 14 3.2 CONSULTA DEL ESTADO DE ENVO ....................................................................... 15 3.2.1 PETICIN ................................................................................................................ 15 3.2.2 4 5 Respuesta ............................................................................................................... 16 NAMESPACES .................................................................................................................... 18 DEFINICIN DE TIPOS DE DATOS ................................................................................... 19 5.1 ESTRUCTURA DEL MessageType ............................................................................ 19 5.2 ESTRUCTURA DEL MessageResultType .................................................................. 19 5.3 ESTRUCTURA DEL MessageDeliveryStatusPollType ............................................... 19 5.4 ESTRUCTURA DEL MessageDeliveryStatusType ..................................................... 20 5.5 ENUMERACIN DEL MessagePriorityType .............................................................. 20 5.6 ESTRUCTURA DEL DeliveryInformationType ............................................................ 20 5.7 ENUMERACIN DEL DeliveryStatusType ................................................................. 20 5.8 ENUMERACIN DEL AltType .................................................................................... 21 5.9 OPCIN UserIdType ................................................................................................... 21 6 LIBRERAS CLIENTE DE USO DE LAS APIS .................................................................... 22 6.1 CLIENTE JAVA ........................................................................................................... 22 6.1.1 Directrices de Programacin ................................................................................... 22 6.1.2 6.1.3 6.1.4 Ejemplo para el envo con el cliente MMS .............................................................. 22 Paquetes del Cliente ............................................................................................... 24 Prerrequisitos .......................................................................................................... 24

6.2 CLIENTE C# ................................................................................................................ 24 6.2.1 Directrices de Programacin ................................................................................... 24 6.2.2 6.2.3 6.2.4 Ejemplo para el envo con el cliente MMS .............................................................. 25 Paquetes del Cliente ............................................................................................... 26 Prerrequisitos .......................................................................................................... 26

6.3 CLIENTE PHP ............................................................................................................. 26 6.3.1 Dependencias .......................................................................................................... 26 6.3.2 Directrices de Programacin ................................................................................... 27 6.3.3 Esta librera se ha probado en los siguientes sistemas operativos: CentOs 5, Fedora 11, Ubuntu Jaunty, Ubuntu Karmic, Debian Lenny, Windows 7 y Windows XP.Ejemplo para el envo con el cliente MMS ..................................................................... 27Pgina 2 de 32 movistar 2009 Reservados todos los derechos.

6.3.4 7 A

Paquetes del Cliente ............................................................................................... 27

DETALLE DE LAS DESCRIPCIONES DE ERROR ............................................................ 29 CONSIDERACIONES GENERALES ................................................................................... 30 A.1 Mtodos HTTP ............................................................................................................ 30 A.1.1 POST ....................................................................................................................... 30 A.1.2 A.1.3 A.1.4 GET ......................................................................................................................... 30 PUT.......................................................................................................................... 30 DELETE ................................................................................................................... 31

A.2 REPRESENTACIONES COMUNES ........................................................................... 31 A.2.1 JSON ....................................................................................................................... 31 A.2.2 B XML ......................................................................................................................... 31 REFERENCIAS .................................................................................................................... 32

Pgina 3 de 32 movistar 2009 Reservados todos los derechos.

1 INTRODUCCINEste documento sirve como gua para el uso de la API REST de envo de MMS que proporciona Movistar Developers PlatformBETA. Las funcionalidades que se exponen son el envo de MMS y la consulta del estado de envo de un MMS. Estas funcionalidades se exponen a travs de una interfaz REST (REpresentational State Transfer) que expone el servicio simplificando las peticiones a travs de sencillas peticiones HTTP. 1.1 ALCANCE

El API MMS de Movistar Developers PlatformBETA permite el envo de mensajes MMS a los siguientes pases. MXICO

1.2

GLOSARIO API: Application Programming Interface ID: Identifier HTTPS: HyperText Transfer Protocol Secure JSON: JavaScript Object Notation REST: Representational State Transfer MMS: Multimedia Messaging Service URI: Uniform Resource Identifier URL: Uniform Resource Locator WSDL: Web Services Description Language XML: eXtended Markup Language

Pgina 4 de 32 movistar 2009 Reservados todos los derechos.

2 CONVENCIONES GENERALES2.1 PAUTAS GENERALES DE UNA INTERFAZ REST REST (REpresentational States Transfer) es un estilo de arquitectura basado en los siguientes principios: Direccionabilidad: Los recursos son expuestos mediante URIs. Sin Estado. Las peticiones a los recursos son independientes una de la otra. Conectividad. Los recursos pueden incluir enlaces a otros recursos. Una interfaz uniforme: Las operaciones permitidas son obtencin, creacin, modificacin y eliminacin de recursos utilizando el protocolo HTTP.

La implementacin de estos pilares da como resultado servicios RESTful que se basan en el protocolo HTTP, son independientes del lenguaje, pueden usarse en presencia de firewalls, las aplicaciones pueden cachearlos, son altamente escalables, etc. REST tiene como propsito la implementacin de servicios ligeros, inteligibles y fcilmente implementables que se definen en base a una serie de operaciones RESTful, que implica el intercambio de informacin acorde a los formatos de los datos REST. 2.2 CONSIDERACIONES ESPECFICAS PARA LA API REST DE MMS 1. La peticin de envo de MMS es una peticin POST que se puede hacer con los siguiente Content-Types: - application/xml - application/json - application/x-www-form-urlencoded (soportado, aunque se recomienda usar XML o JSON) 2. La respuesta a esa peticin ir en el formato expresado en la peticin, excepto cuando la peticin sea url-encoded, en cuyo caso las respuestas sern XML. 3. La peticin de MessageDeliveryStatus es una peticin GET, en la que se indica el MMS a consultar a travs de un parmetro indicado en la URI que forma la peticin. Por defecto la respuesta tiene formato XML, aunque se puede pedir que la respuesta est en formato JSON a travs de un parmetro alt, incluido en la URI que forma la peticin. 4. Mapeo de XML a JSON. Puesto que XML es el formato por defecto utilizado en la API de MMS, se incluyen archivos XSD que describen los datos necesarios para invocar al API mediante XML. Para pasar estas representaciones a formato JSON, se presentan las siguientes reglas de aplicacin general:a. Los