Sistema Integral Multicanal de Atención al

Ciudadano
PAI_CONTRATO_INTEGRACION_SALT_REST_v2

Contrato de Integración para Servicio de Traducción de

Textos con Interfaz REST

Versión 002
DIRECCIO GENERAL DE TECNOLOGIAS Mayo de 2018
DE LA INFORMACIÓN Y LAS COMUNICACIONES
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

Índice

Índice.........................................................................................................................................................
1 Control del documento........................................................................................................................
1.1 Información general.................................................................................................................................

1.2 Histórico de revisiones............................................................................................................................

1.3 Estado del documento.............................................................................................................................

2 Introducción..........................................................................................................................................
2.1 Alcance......................................................................................................................................................

2.2 Objetivos...................................................................................................................................................

2.3 Audiencia..................................................................................................................................................

2.4 Glosario.....................................................................................................................................................

2.5 Referencias...............................................................................................................................................

3 Descripción de la integración.............................................................................................................
3.1 Descripción del servicio..........................................................................................................................

3.2 Listado de métodos..................................................................................................................................

4 Detalle del servicio SaltService_v2_00 REST....................................................................................

4.1 /api/translate.............................................................................................................................................

4.1.1 Parámetros Entrada...........................................................................................................................................

4.1.1.1 Tipo de documento (parámetro doctype)................................................................................................................

4.1.1.2 Ejemplo de JSON de entrada...............................................................................................................................
4.1.1.3 Ejemplo de JSON de entrada desde fichero...........................................................................................................
4.1.2 Parámetros Salida.............................................................................................................................................

4.1.2.1 Ejemplo de JSON de salida..................................................................................................................................

4.1.2.2 Ejemplo de JSON de salida desde fichero..............................................................................................................
4.1.3 Mensajes de Error.............................................................................................................................................

5 Errores que se devuelven como Fault...............................................................................................

5.1 Seguridad del Servicio Web....................................................................................................................

6 Anexo I. WADL....................................................................................................................................

Contrato de Integración para Servicio Web SALT con Interfaz REST 2/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

1 Control del documento

1.1 Información general
Título Contrato de Integración Servicio SALT_v2 con Interfaz REST

Creado por DGTIC

Revisado por

Lista de distribución

Nombre del fichero PAI_CONTRATO_INTEGRACION_SALT_REST_v2_v002.doc

1.2 Histórico de revisiones

Versión Fecha Autor Observaciones

1 17/01/2018 DGTIC Versión inicial

Se elimina la referencia que se hace a la necesidad de indicar
2 03/05/2018 DGTIC usuario/password y el método de token

1.3 Estado del documento

Responsable aprobación Fecha

2 Introducción
Este documento contiene un contrato de integración asociado al consumo del Servicio Web
para la Traducción de Textos Castellano/Valenciano y viceversa en su modalidad 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 cómo consumir
el mismo. Detalla que parámetros espera y que parámetros o excepciones de error devuelve.

Contrato de Integración para Servicio Web SALT con Interfaz REST 3/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

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 SALT. 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
Sistema informático que hace de intermediación entre el consumo directo de
Intermediador un webservice, que es el que ofrece en última, (a efectos del intermediador),
instancia la funcionalidad, y el consumidor del servicio.

Tabla 2: Glosario

2.5 Referencias
Referencia Título

Tabla 3: Referencias

3 Descripción de la integración
Nombre del Servicio SaltService_REST_v2_00

Tipo de Integración Servicio Web

Modo de Funcionamiento N/A

Intermediario Plataforma Autonómica de Interoperabilidad de la GVA (PAI)

Proveedor del Servicio DGTIC

Contacto PAI

Tabla 4: Datos generales de integración

Contrato de Integración para Servicio Web SALT con Interfaz REST 4/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

3.1 Descripción del servicio

El presente documento recoge la especificación técnica del servicio para la traducción de
textos castellano/valenciano y viceversa en su versión REST. En el documento se recoge tanto
la estructura de los parámetros de la petición que llegará al servicio como los que devolverá el
mismo.

3.2 Listado de métodos

Se listan los diferentes subservicios/métodos que ofrece el servicio:

/api/translate: Procesamiento de peticiones de traducción.

4 Detalle del servicio SaltService_v2_00 REST

A continuación se detallan los datos de acceso al servicio de SaltService_v2_00:

Datos de Acceso al Servicio de SaltService_v2_00 en el BUS Innovación

Endpoint Pre
Producción
Endpoint
Producción

Tipo de Firma
admitida N/A

Respuesta Cifrada 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.

Este servicio contiene las operaciones:

• /api/translate: Ver 4.1 /api/translate

4.1 /api/translate

Datos de Acceso al método

Endpoint Pre
Producción
Endpoint
Producción

Método POST

Tipo de
Petición JSON

Contrato de Integración para Servicio Web SALT con Interfaz REST 5/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

Tipo de
Respuesta JSON

Tabla 7.- Datos de acceso al método

4.1.1 Parámetros Entrada

Etiqueta Campo
Ubicación Nombre Tipo Descripción
Obligatoria Obligatorio

- data String Sí Sí El texto de entrada

El modo de traducción. Los
- mode String Sí Sí modos posibles son:
• cat-spa: Traducción
valencià-castellano, único
para todas las variedades de
origen
• spa-cat_valencia:
Traducción castellano-
valencià, con los criterios de
la Generalitat Valenciana
Especifica si se quieren generar
- marks Boolean No No marcas de palabras
desconocidas
Especifica si ‘data’ va codificado
- base64 Boolean No No en base64,útil para formatos de
archivo binarios

Nombre de tipo de archivo. Los

valores posibles se detallan en
- doctype String No No 4.1.1.1 Tipo de documento
(parámetro doctype)

4.1.1.1 Tipo de documento (parámetro doctype)

Al lado de cada tipo de documento se especifica si se tiene que activar el modo base64 o no
para cada tipo.

Tipo de documento Descripción Base64:true Requerido

txt Text planer No

html Hipertext HTML No
odt Documento de procesador de textos OpenOffice / LibreOffice Sí
ods Documento de hoja de cálculo OpenOffice / LibreOffice Sí
odp Documento de presentaciones OpenOffice / LibreOffice Sí
docx Documento de procesador de textos MS Office Word Sí
xlsx Documento de hoja de cálculo MS Office Word Sí
pptx Documento de presentaciones MS Office Word Sí
xml Documento XML No

Contrato de Integración para Servicio Web SALT con Interfaz REST 6/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

4.1.1.2 Ejemplo de JSON de entrada

{
"data":"perejil",
"mode":"spa-cat"
}
4.1.1.3 Ejemplo de JSON de entrada desde fichero
{
"mode": "spa-cat_valencia", "base64":
true,
"data": "UEsDBBQAAAgAADJ…",
"doctype": "odt"
}

4.1.2 Parámetros Salida

Campo
Ubicación Nombre Tipo Etiq. Oblig. Descripción
Oblig.

El documento traducido,
- data String Sí Sí en el mismo formato que la
entrada

4.1.2.1 Ejemplo de JSON de salida

{
"data": “julivert”

4.1.2.2 Ejemplo de JSON de salida desde fichero

{
"base64": true,
"data": "UEsDBAoAAAAAADJbLE…"
}

4.1.3 Mensajes de Error

Se presentan en forma de objetos JSON con la propiedad “Error” que toma los siguientes
valores auto-explicativos.

Mensajes

application/json content-type is required

Required field ‘data’
Required field ‘mode’
Mode ‘{0}’ not supported
Document type ‘{0}’ not supported

Contrato de Integración para Servicio Web SALT con Interfaz REST 7/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

Base64 encoding is mandatory for the specified document type

5 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 Imposible ejecutar el El servicio esta caído y no se pudo cursar la petición del cliente.
servicio
0301 Organismo no El certificado o procedimiento utilizados son incorrectos y no se pudo
autorizado autorizar el consumo al servicio

0309 Error general al Los credenciales no se han podido validar

verificar las
credenciales.
0800 Operación solicitada Se dará cuando se invoque un método que no existe en el servicio.
incorrecta
0809 Falta la cabecera la petición recibida no contenía en la cabecera HTTP el campo “xapi-
“xapi-key” key” o no contiene valor
0810 Falta la cabecera la petición recibida no contenía en la cabecera HTTP el campo
“aplicación” “aplicación” o no contiene valor
Tabla 8.- Errores HTTP 500 Fault

Ejemplo de fault JSON:

{"errorMessage": "[0301]Organismo no autorizado"}

5.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.
6 Anexo I. WADL
<? xml version="1.0" encoding="UTF-8" ?>
<ns0:application xmlns:ns0="http://wadl.dev.java.net/2009/02">
<ns0:doc xmlns:ns1="http://jersey.java.net/" ns1:generatedBy ="Jerse
2.21.1 2015-09-16 06:09:31"/> y:
<ns0:doc xmlns:ns2="http://jersey.java.net/" 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: https://innovacion -
pre.gva.es/pai_bus_inno/SALT/SaltService_REST_v2_00/application.wadl?detail=t
rue"/>
<ns0:grammars/>
<ns0:resources

Contrato de Integración para Servicio Web SALT con Interfaz REST 8/9
DIRECCIO GENERAL DE TECNOLOGIAS
DE LA INFORMACIÓN Y LAS COMUNICACIONES

base="https://innovacionpre.gva.es/pai_bus_inno/SALT/SaltService_RES />
T_v2_00/">
<ns0:resource path="/api/translate"> />
<ns0:param name="mode" style="template"
/>
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:string"
<ns0:param name="doctype" style="template" />
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:string"
<ns0:param name="data" style="template" />
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:string"
<ns0:param name="base64" style="template"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:boolean" />
<ns0:param name="marks" style="template"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:boolean"
<ns0:method id="translate" name="POST">
<ns0:request>
<ns0:param name="javax.ws.rs.container.Suspended"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" type="xsd:string"
</ns0:request>
</ns0:method>
</ns0:resource>
</ns0:resources>
</ns0:application>

Contrato de Integración para Servicio Web SALT con Interfaz REST 9/9