Sistema Integral Multicanal de Atención al Ciudadano

Transcripción

1 Sistema Integral Multicanal de Atención al Ciudadano Contrato de Integración para Servicio Web SMS v3 REST DIRECCIO GENERAL DE TECNOLOGIAS Versión 001 Marzo de 2017

2 Índice 1 Control del documento Información general Histórico de revisiones Estado del documento Introducción Alcance Objetivos Audiencia Glosario Referencias Descripción de la integración Descripción del servicio Detalle del servicios de Envío SMS GVA v3 REST smstextsubmit Parámetros de entrada Ejemplo JSON de entrada Ejemplo XML de entrada Parámetros de salida Ejemplo JSON de salida Ejemplo XML de salida mmssubmit Parámetros de Entrada Ejemplo de JSON de entrada Ejemplo de XML de entrada Parámetros Salida Ejemplo de JSON de salida Ejemplo de XML de salida Errores de negocio Detalle del servicios de Consulta SMS GVA v3 REST estadomensaje Parámetros de entrada Parámetros de salida Ejemplo de JSON de respuesta Ejemplo XML de respuesta consultapendientes Parámetros de entrada Parámetros de salida Ejemplo JSON de respuesta Ejemplo XML de respuesta Errores que se devuelven como Fault Seguridad del Servicio Web / 27

3 7 Anexo I. WADL WADL EnvioSMS v WADL ConsultaSMS v / 27

4 1 Control del documento 1.1 Información general Título Creado por Contrato de integración del SMS con interfaz REST DGTIC Revisado por Lista de distribución Nombre del fichero PAI_CONTRATO_INTEGRACION_SMS_REST_v3_001.doc 1.2 Histórico de revisiones Versión Fecha Autor Observaciones 1 03/2017 DGTIC Versión inicial. 1.3 Estado del documento Responsable aprobación Fecha 4 / 27

5 2 Introducción Este documento contiene un contrato de integración asociado al consumo del Servicio Web de SMS versión 3 de la GVA con interfaz REST. El contrato de integración detalla, los aspectos relacionados con el procedimiento de integración, pudiendo exponer los mecanismos de consulta o consumo, las posibles respuestas o devolución de información, los formatos a utilizar, etc. 2.1 Alcance Este documento tiene un enfoque técnico y describe lo que hace el servicio y como consumir el mismo. Detalla que parámetros espera y que parámetros o excepciones de error devuelve. 2.2 Objetivos El objetivo principal del contrato de integración es permitir conocer la definición de la estructura de invocación al servicio de SMS v3 GVA. De este modo el usuario final podrá realizar el consumo del servicio web correctamente. 2.3 Audiencia Nombre y Apellidos Rol Tabla 1: Audiencia 2.4 Glosario Término Definición Tabla 2: Glosario 2.5 Referencias Referencia Título Tabla 3: Referencias 5 / 27

6 3 Descripción de la integración Nombre del Servicio Tipo de Integración Modo de Funcionamiento Intermediario Proveedor del Servicio Contacto SMS v3 Servicio Web N/A Plataforma Autonómica de Interoperabilidad de la GVA (PAI) DGTIC PAI Tabla 4: Datos generales de integración 3.1 Descripción del servicio El Servicio Web SMS versión 3 dispone de una serie de webservices con funcionalidades bien marcadas. Dichos webservices son: Servicio de Envío SMS: Permite el envío de mensajes SMS/MMS a terminales móviles en varias modalidades. Servicio de Consulta SMS: Permite la consulta del estado de los mensajes enviados en caso de haber activado las notificaciones de entrega. 6 / 27

7 4 Detalle del servicios de Envío SMS GVA v3 REST Endpoint Pre Producción Endpoint Producción Tipo de Firma admitida Respuesta Cifrada Datos de Acceso al Servicio de Firma_v1_00 en el BUS Innovación N/A NO Tabla 5.- Datos de acceso al servicio en el BUS Innovación IMPORTANTE: Los servicios publicados en el bus de Innovación son para uso exclusivo de aplicaciones de la GVA desplegadas en la infraestructura de la DGTIC. El servicio de envío permite realizar envíos de mensajes de texto y mensajes multimedia a terminales móviles. Permite entregas diferidas de dichos mensajes y múltiples destinos, siempre acogiéndose a las siguientes restricciones: En cada envío se pueden incluir como máximo 50 destinatarios. Cada mensaje no puede superar los 300kb. Los elementos de tipo string son de tamaño variable. Salvo en aquellos casos donde se especifica que el elemento string puede tener ciertos valores concretos, los elementos string pueden tener cualquier tamaño y valor. El servicio MMS sólo se garantiza que funcione correctamente cuando el proveedor sea Movistar. Cobertura internacional: Permite el envío de SMS a terminales móviles de operadoras internacionales (siendo responsabilidad de la operadora internacional destino la entrega). Según Telefónica, el servicio permite hasta 50 SMS/seg (desde la PAI no se han hecho pruebas de carga para confirmar dicho volumen de SMS's). Este servicio contiene las operaciones siguientes: smstextsubmit: Ver 4.1 smstextsubmit mmssubmit: Ver 4.2 mmssubmit Error: no se encontró el origen de la referencia 7 / 27

8 4.1 smstextsubmit Datos de Acceso al método Endpoint Pre Producción Endpoint Producción Método Tipo de Petición Tipo de Respuesta POST JSON/XML JSON/XML El servicio de SMS ofrece el envío de mensajes de texto a teléfonos móviles de cualquier operador. Parámetros de entrada En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de petición al método smstextsubmit. Figura 1 Diagrama del mensaje de petición del servicio al método smstextsubmit Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción smstextsubmitreq Sender String Sí Sí Remitente del mensaje. Alfanuméricos. Números cortos. Sólo se podrán utilizar remites dados de 8 / 27

9 smstextsubmitreq Recipients BLOQUE Sí Sí smstextsubmitreq/ Recipients To String Sí Sí alta. Bloque único Engloba la lista de destinatarios del mensaje. Teléfono destinatario del mensaje SMS. El tipo de numeración soporta es formato MSISDN en dos patrones: - MSISDN Nacional: 6xxxxxxxx 7xxxxxxxx - MSISDN Internacional: smstextsubmitreq SMSText String Sí Sí Texto del mensaje xxxxxxxx y +346xxxxxxxx 00347xxxxxxxx y +347xxxxxxxx La entrega diferida se utilizará para indicar la hora de entrega del mensaje. El cliente podrá especificar el intervalo de tiempo a transcurrir antes de la entrega. Están soportados tanto el formato absoluto (UTC) como el formato relativo: smstextsubmitreq EarliestDeliveryTime String No No - El formato absoluto (UTC) es: T00:00:00+02:00, es importante poner +02:00 como zona horaria para que se envíen los mensajes en horario de España - El formato relativo es PT2H para enviarlo tras dos horas de la petición, siguiendo la expresión regular: P[yY] [mm][dd][t[hh][mm][s[.s]s]] Este parámetro indica si se requiere notificación de entrega. smstextsubmitreq DeliveryReport String No No - All : Se solicita todos los tipos de notificación de entrega (mensajes entregados, expirados y rechazados) - None : No se solicita notificación de entrega. Si no se incluye este campo el valor por defecto es None. smstextsubmitreq ExpiryDateDeliveryRep ort String No/Si (Ver descripción) No/Si (Ver descripción) Fecha límite de validez del mensaje. El formato es: T00:00:00+02:00, es importante poner +02:00 como zona horaria para que se envíen los mensajes en horario de España Está soportado el formato absoluto (UTC). La obligatoriedad de este campo está determinada por el valor del campo DeliveryReport, Si el valor de dicho campo es All, la ExpiryDateDeliveryReport deberá ser 9 / 27

10 informada Ejemplo JSON de entrada { "Sender" : "GVA-SMS-PRE", "Recipients" : { "To" : [ "6xxxxxxxx" ] }, "SMSText" : "Texto del mensaje", "EarliestDeliveryTime" : "PT10M", "DeliveryReport" : "All", "ExpiryDateDeliveryReport" : " T00:00:00+02:00" } Ejemplo XML de entrada <smstextsubmitreq xmlns=" <Sender>GVA-SMS-PRE</Sender> <Recipients> <To>6xxxxxxxx</To> </Recipients> <SMSText>Texto</SMSText> <EarliestDeliveryTime>PT10M</EarliestDeliveryTime> <DeliveryReport>All</DeliveryReport> <ExpiryDateDeliveryReport> T00:00:00+02:00</ExpiryDateDeliveryReport> </smstextsubmitreq> Parámetros de salida En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de respuesta a una petición al método smstextsubmit. Figura 2 Diagrama del mensaje de respuesta del servicio al método smstextsubmit 10 / 27

11 Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción SubmitRes Version String Sí Sí SubmitRes Status Bloque Sí Sí Bloque único SubmitRes/Status StatusCode String Sí Sí El parámetro de versión está relacionado con las futuras versiones del Interfaz Simplificado. En la actualidad el valor permitido es 1.0. Código de respuesta que indica si una petición se procesó correctamente o no. Los distintos códigos de respuesta están estructurados de la siguiente manera: : Petición procesada correctamente. - 2xxx: Error en la petición del servidor de Telefónica. - 3xxx: Error en el servidor del cliente. - 4xxx: Error en el servicio del cliente. SubmitRes/Status StatusText String Sí Sí Texto asociado al código de respuesta. SubmitRes/Status Details String No No SubmitRes MessageId String No No Texto que incluye el detalle asociado al código de respuesta. En caso de error incluye información adicional acerca del mismo. Identificador del mensaje. Si se solicita notificación de entrega será necesario almacenar este valor para más tarde poder relacionarlo con la notificación de entrega Ejemplo JSON de salida { } "Version" : "1.0", "Status" : { "StatusCode" : "1000", "StatusText" : "Success", "Details" : "Request processed succesfully" }, "MessageId" : "vasadpt1-is@453@ @ " Ejemplo XML de salida <SubmitRes xmlns=" <Version>1.0</Version> 11 / 27

12 <Status> <StatusCode>1000</StatusCode> <StatusText>Success</StatusText> <Details>Request processed succesfully</details> </Status> </SubmitRes> 4.2 mmssubmit Datos de Acceso al método Endpoint Pre Producción Endpoint Producción Método POST Tipo de Petición Tipo de Respuesta JSON/XML JSON/XML Tabla 5.- Datos de acceso al método El servicio de SMS ofrece el envío de mensajes multimedia a teléfonos móviles de cualquier operador. Parámetros de Entrada En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de petición al método mmssubmit. 12 / 27

13 Figura 3 Diagram del mensaje de petición del servicio al método mmssubmit Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción mmssubmitreq Sender String Sí Sí mmssubmitreq Recipients BLOQUE Sí Sí mmssubmitreq / Recipients To String Sí Sí Remitente del mensaje. Alfanuméricos. Números cortos. Sólo se podrán utilizar remites dados de alta. Bloque único Engloba la lista de destinatarios del mensaje. Teléfono destinatario del mensaje SMS. El tipo de numeración soporta es formato MSISDN en dos patrones: - MSISDN Nacional: 6xxxxxxxx 7xxxxxxxx - MSISDN Internacional: mmssubmitreq Contents BLOQUE Sí Sí Bloque único 00346xxxxxxxx y +346xxxxxxxx 00347xxxxxxxx y +347xxxxxxxx 13 / 27

14 mmssubmitreq/co ntents mmssubmitreq/co ntents/content mmssubmitreq/co ntents/content mmssubmitreq/co ntents/content Content BLOQUE Sí Sí contenttype String Sí Sí contentid String No No contentdata base64binary Sí Sí Engloba la lista de contenidos MMS Engloba la lista de definición del contenido MMS Campo obligatorio que indicara el tipo del contenido, por ejemplo: - text/plain - image/jpeg Campo opcional que servirá para enlazar los contenidos con un elemento de presentaciones (smil) Campo obligatorio que contendrá el contenido multimedia en base64. mmssubmitreq Subject String No No Asunto del mensaje MMS La entrega diferida se utilizará para indicar la hora de entrega del mensaje. El cliente podrá especificar el intervalo de tiempo a transcurrir antes de la entrega. Están soportados tanto el formato absoluto (UTC) como el formato relativo: mmssubmitreq EarliestDeliveryTime String No No - El formato absoluto (UTC) es: T00:00:00+02:00, es importante poner +02:00 como zona horaria para que se envíen los mensajes en horario de España - El formato relativo es PT2H para enviarlo tras dos horas de la petición, siguiendo la expresión regular: P[yY] [mm][dd][t[hh][mm][s[.s]s]] Este parámetro indica si se requiere notificación de entrega. mmssubmitreq DeliveryReport String No No - All : Se solicita todos los tipos de notificación de entrega (mensajes entregados, expirados y rechazados) - None : No se solicita notificación de entrega. Si no se incluye este campo el valor por defecto es None. Fecha límite de validez del mensaje. mmssubmitreq ExpiryDateDeliveryRep ort String No/Si (Ver descripción) No/Si (Ver descripción) El formato es: T00:00:00+02:00, es importante poner +02:00 como zona horaria para que se envíen los mensajes en horario de España Está soportado el formato absoluto (UTC). La obligatoriedad de este campo está determinada por el valor del campo DeliveryReport, Si el valor de dicho campo es All, la ExpiryDateDeliveryReport deberá ser informada. 14 / 27

15 Ejemplo de JSON de entrada { "Sender" : "GVA-SMS-PRE", "Recipients" : { "To" : [ "6xxxxxxxx" ] }, "Contents" : { "Content" : [ { "contenttype" : "text/plain", "contentid" : "mmstext", "contentdata" : "VGV4dG8gZGVsIE1NUw==" } ] }, "Subject" : "Titulo", "EarliestDeliveryTime" : "P1M", "DeliveryReport" : "All", "ExpiryDateDeliveryReport" : " T00:00:00+02:00" } Ejemplo de XML de entrada <mmssubmitreq xmlns=" <Sender xmlns="">gva-sms-pre</sender> <Recipients xmlns=""> <To>6xxxxxxxx</To> </Recipients> <Contents xmlns=""> <Content> <contenttype>text/plain</contenttype> <contentid>mmstext</contentid> <contentdata>vgv4dg8gzgvsie1nuw==</contentdata> </Content> </Contents> <Subject xmlns="">titulo</subject> <EarliestDeliveryTime xmlns="">pt1m</earliestdeliverytime> <DeliveryReport xmlns="">all</deliveryreport> <ExpiryDateDeliveryReport xmlns=""> T00:00:00+02:00</ExpiryDateDeliveryReport> </mmssubmitreq> Parámetros Salida En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de respuesta a una petición al método mmssubmit. 15 / 27

16 Figura 4 Diagrama del mensaje de respuesta del servicio al método mmssubmit Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción SubmitRes Version String Sí Sí SubmitRes Status Bloque Sí Sí Bloque único SubmitRes/Status StatusCode String Sí Sí El parámetro de versión está relacionado con las futuras versiones del Interfaz Simplificado. En la actualidad el valor permitido es 1.0. Código de respuesta que indica si una petición se procesó correctamente o no. Los distintos códigos de respuesta están estructurados de la siguiente manera: : Petición procesada correctamente. - 2xxx: Error en la petición del servidor de Telefónica. - 3xxx: Error en el servidor del cliente. - 4xxx: Error en el servicio del cliente. SubmitRes/Status StatusText String Sí Sí Texto asociado al código de respuesta. SubmitRes/Status Details String No No SubmitRes MessageId String No No Texto que incluye el detalle asociado al código de respuesta. En caso de error incluye información adicional acerca del mismo. Identificador del mensaje. Si se solicita notificación de entrega será necesario almacenar este valor para más tarde poder relacionarlo con la notificación de entrega Ejemplo de JSON de salida { "Version" : "1.0", "Status" : { 16 / 27

17 } "StatusCode" : "1000", "StatusText" : "Success", "Details" : "Request processed succesfully" }, "MessageId" : "vasadpt1-is@453@ @ " Ejemplo de XML de salida <SubmitRes xmlns=" <Version>1.0</Version> <Status> <StatusCode>1000</StatusCode> <StatusText>Success</StatusText> <Details>Request processed succesfully</details> </Status> <MessageId>vasadpt1-is@453@ @ </MessageId> </SubmitRes> Errores de negocio Respuesta (Status Code) Status-text Details Descripción 1000 Success Request processed succesfully El mensaje se ha procesado correctamente 2002 Sender Address Error El campo Detail incluirá el texto Sender %sender% is rejected, Donde %sender% será el remitente del mensaje rechazado. El remitente proporcionado no es correcto ya que no se encuentra entre los contratados en el servicio 2003 Recipient Address error El campo De-tails incluirá el texto Recipient %recipient% is rejected, donde %recipient% será el destinatario del mensaje rechazado. El destinatario del mensaje o el formato del mismo son incorrectos Content refused El campo Details incluirá el texto Content not supported. Alguno de los contenidos del mensaje es incorrecto o no está permitido Not allowed sending time El campo De-tails incluirá el texto Not allowed sending time El cliente ha realizado el envío en una franja horaria no permitida Server Error El campo Details incluirá el texto Generic Server error. Please, contact system admi-nistrators 4000 Operation restricted El campo De-tails incluirá el texto Generic Service error El Relay/Server no está disponible o existe alguna incidencia en alguno de los elementos de la red de Telefónica que impiden cursar la petición del cliente. El servicio esta caído y no se pudo cursar la petición del cliente. 17 / 27

18 18 / 27

19 5 Detalle del servicios de Consulta SMS GVA v3 REST Datos de Acceso al Servicio de Firma_v1_00 en el BUS Innovación Endpoint Pre Producción Endpoint Producción Tipo de Firma admitida Respuesta Cifrada N/A NO Tabla 5.- Datos de acceso al servicio en el BUS Innovación IMPORTANTE: Los servicios publicados en el bus de Innovación son para uso exclusivo de aplicaciones de la GVA desplegadas en la infraestructura de la DGTIC. El servicio de consulta permite realizar consultas para conocer el estado de los mensajes enviados anteriormente con notificación de entrega activa. Para ello deberá proporcionar el idmensaje que se informa en la respuesta del servicio de Envío SMS. Este servicio contiene las operaciones siguientes: estadomensaje: Ver Error: no se encontró el origen de la referencia consultapendientes: Ver Error: no se encontró el origen de la referencia 5.1 estadomensaje Datos de Acceso al método Endpoint Pre Producción Endpoint Producción Método Tipo de Petición Tipo de Respuesta GET N/A N/A El servicio de SMS ofrece la posibilidad de consultar el estado de los mensajes enviados mediante la consulta de notificaciones. En caso de enviar un idmensaje que es incorrecto el nodo notificaciones vendrá vacío y se mostrará un mensaje de error adicional. 19 / 27

20 Parámetros de entrada En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de petición al método estadomensaje. Figura 5 Diagrama del mensaje de petición del servicio al método estadomensaje Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción estadomensaje/idm ensaje idmensaje String Sí Sí Identificador de mensaje, es el mismo que se obtiene en la respuesta del método de envío Este servicio se consume pasando el parámetro por url: idmensaje=vasadpt1-is@2970@ @ Parámetros de salida En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de respuesta al método estadomensaje. Figura 6 Diagrama del mensaje de respuesta del servicio al método estadomensaje Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción estadomensajeres ponse estadomensajeres ponse/respuesta estadomensajeres ponse/respuesta respuesta BLOQUE Sí Sí Bloque único error String No No notificaciones BLOQUE Sí Sí Texto que incluye el detalle del error sucedido. No aparece en caso de buen funcionamiento. Bloque único Vendrá vacío en caso de error en idmensaje 20 / 27

21 estadomensajeres ponse/respuesta/no tificaciones estadomensajeres ponse/respuesta/no tificaciones/notificac ion notificacion BLOQUE No No destinatario String No No Bloque que contiene el detalle de la notificación. Texto que indica del destinatario asociado a la notificación Estado final del mensaje entregado estadomensajeres ponse/respuesta/no tificaciones/notificac ion estado String No No Los posibles valores son los siguientes: - Entregado: El mensaje ha sido entregado al usuario. - Rechazado: El mensaje se ha rechazado y no se ha podido entregar al usuario. - Caducado: El mensaje ha expirado y no se ha podido entregar al usuario - Sin notificaciones: No se han recibido notificaciones para este destinatario Ejemplo de JSON de respuesta {"respuesta": {"notificaciones": {"notificacion": [{ "destinatario": "6XXXXXXXX", "estado": "Sin notificaciones" }]}}} Ejemplo XML de respuesta <ns3:estadomensajeresponse xmlns:ns2=" xmlns:ns3=" xmlns:soap=" <respuesta> <notificaciones> <notificacion> <destinatario>6xxxxxxxx</destinatario> <estado>sin notificaciones</estado> </notificacion> </notificaciones> </respuesta> </ns3:estadomensajeresponse> 5.2 consultapendientes Datos de Acceso al método 21 / 27

22 Endpoint Pre Producción Endpoint Producción Método Tipo de Petición Tipo de Respuesta GET N/A N/A El servicio de SMS ofrece la posibilidad de consultar los destinos de los cuales no se ha recibido ninguna notificación de entrega En caso de enviar un idmensaje que es incorrecto el nodo notificaciones vendrá vacío y se mostrará un mensaje de error adicional. Parámetros de entrada En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de petición al método consultapendientes. Figura 7 Diagrama del mensaje de petición del servicio método consultapendientes Ubicación Nombre Tipo Etiqueta Obligatoria Campo Obligatorio Descripción consultapendientes /idmensaje idmensaje String Sí Sí Identificador de mensaje, es el mismo que se obtiene en la respuesta del método de envío Este servicio se consume pasando el parámetro por url: idmensaje=vasadpt1-is@2970@ @ Parámetros de salida En el siguiente diagrama y tabla se resume el tipo de dato y la información que contienen cada uno de los campos del mensaje de respuesta al método consultapendientes. 22 / 27

23 Figura 8 Diagrama del mensaje de respuesta del servicio al método consultapendientes Ubicación Nombre Tipo Etiq. Oblig. Campo Oblig. Descripción consultapendientesr esponse consultapendientesr esponse/respuesta consultapendientesr esponse/respuesta consultapendientesr esponse/respuesta/no tificaciones consultapendientesr esponse/respuesta/no tificaciones/notificacio n respuesta BLOQUE Sí Sí Bloque único error String No No notificaciones BLOQUE Sí Sí notificacion BLOQUE No No destinatario String No No Texto que incluye el detalle del error sucedido. No aparece en caso de buen funcionamiento. Bloque único Vendrá vacío en caso de error en idmensaje Bloque que contiene el detalle de la notificación. Texto que indica del destinatario asociado a la notificación Estado final del mensaje entregado consultapendientesr esponse/respuesta/no tificaciones/notificacio n estado String No No Los posibles valores son los siguientes: - Sin notificaciones: No se han recibido notificaciones para este destinatario Ejemplo JSON de respuesta {"respuesta": {"notificaciones": {"notificacion": [{ "destinatario": "6XXXXXXXX", "estado": "Sin notificaciones" }]}}} Ejemplo XML de respuesta <ns3:consultapendientesresponse xmlns:ns2=" 23 / 27

24 tos" xmlns:ns3=" xmlns:soap=" <respuesta> <notificaciones> <notificacion> <destinatario>6xxxxxxxx</destinatario> <estado>sin notificaciones</estado> </notificacion> </notificaciones> </respuesta> </ns3:consultapendientesresponse> 24 / 27

25 6 Errores que se devuelven como Fault Los errores se trasladan con el código HTTP 500 y contienen el código del error que corresponde con la siguiente tabla. ErrorCode faultstring Descripción 0101 [0101]Imposible ejecutar el servicio 0301 [0301] Organismo no autorizado El servicio esta caído y no se pudo cursar la petición del cliente. El certificado o procedimiento utilizados son incorrectos y no se pudo autorizar el consumo al servicio 0309 [0309] Error general al verificar las credenciales [0800]Operación solicitada incorrecta 0809 [0809]Falta la cabecera x-api-key 0810 [0810]Falta la cabecera aplicación Los credenciales no se ha podido validar Se dará cuando se invoque un método que no existe en el servicio. la petición recibida no contenía el en la cabecera HTTP el campo xapi-key o no contiene valor la petición recibida no contenía el en la cabecera HTTP el campo aplicación o no contiene valor Tabla 6.- Errores HTTP 500 Fault Ejemplo de fault XML: <err:resterror xmlns:err=" <err:errormessage>[0301]organismo no autorizado</err:errormessage> </err:resterror> Ejemplo de fault JSON: {"errormessage": "[0301]Organismo no autorizado"} 6.1 Seguridad del Servicio Web Se debe incluir en la cabecera HTTP mensaje dos campos personalizados, x-api-key y aplicacion completados según las normas marcadas en el documento Desarrollo y consumo de servicios web. Buenas prácticas, que podrá encontrar en el portal de documentación de la PAI, apartado Cómo usar la plataforma. La seguridad de los servicios también incluirá el cifrado de canal HTTP mediante el protocolo Secure Sockets Layer con una clave de longitud mínima de 128 bits. La publicación de los servicios se realizará por tanto por HTTPS. 25 / 27

26 7 Anexo I. WADL 7.1 WADL EnvioSMS v3 <?xml version="1.0" encoding="utf-8"?> <ns0:application xmlns:ns0=" <ns0:doc xmlns:ns1=" ns1:generatedby="jersey: :09:31"/> <ns0:doc xmlns:ns2=" ns2:hint="this is simplified WADL with user and core resources only. To get full WADL with extended resources use the query parameter detail. Link: tion.wadl?detail=true"/> <ns0:grammars/> <ns0:resources base=" > <ns0:resource path="/mmssubmit"> <ns0:method id="mmssubmit" name="post"> <ns0:request> <ns0:param name="javax.ws.rs.container.suspended" xmlns:xsd=" type="xsd:string"/> <ns0:representation mediatype="application/xml"/> <ns0:representation mediatype="application/json"/> </ns0:request> </ns0:method> </ns0:resource> <ns0:resource path="/smstextsubmit"> <ns0:method id="smstextsubmit" name="post"> <ns0:request> <ns0:param name="javax.ws.rs.container.suspended" xmlns:xsd=" type="xsd:string"/> <ns0:representation mediatype="application/xml"/> <ns0:representation mediatype="application/json"/> </ns0:request> </ns0:method> </ns0:resource> </ns0:resources> </ns0:application> 7.2 WADL ConsultaSMS v3 <?xml version="1.0" encoding="utf-8"?> <ns0:application xmlns:ns0=" <ns0:doc xmlns:ns1=" ns1:generatedby="jersey: :09:31"/> <ns0:doc xmlns:ns2=" ns2:hint="this is simplified WADL with user and core resources only. To get full WADL with extended resources use the query parameter detail. Link: ication.wadl?detail=true"/> <ns0:grammars/> <ns0:resources base=" 0/"> <ns0:resource path="/consultapendientes"> 26 / 27

27 <ns0:method id="consultapendientes" name="get"> <ns0:request> <ns0:param name="idmensaje" style="query" xmlns:xsd=" type="xsd:string"/> <ns0:param name="javax.ws.rs.container.suspended" xmlns:xsd=" type="xsd:string"/> </ns0:request> </ns0:method> </ns0:resource> <ns0:resource path="/estadomensaje"> <ns0:method id="estadomensaje" name="get"> <ns0:request> <ns0:param name="idmensaje" style="query" xmlns:xsd=" type="xsd:string"/> <ns0:param name="javax.ws.rs.container.suspended" xmlns:xsd=" type="xsd:string"/> </ns0:request> </ns0:method> </ns0:resource> </ns0:resources> </ns0:application> 27 / 27