Documentación data2check – Uso del API

1. Objeto

Se pueden chequear documentos incluso sin utilizar la interfaz web gratuita. Utilizando un sencillo API REST, se pueden integrar los chequeos disponibles dentro de otros servicios, tales como Sistemas de Gestión de Contenidos propios.

2. Crear un API token

Para poder usar el API REST, se debe crear primero un "Token API". Para ello, debe seleccionar "Gestión de Tokens" en la gestión de usuarios de data2check, en la parte derecha del menú principal (ver figura 1, círculo naranja).

Gestión de usuarios de data2check - Gestión de Tokens

Figura 1: Gestión de usuarios de data2check - Gestión de Tokens.

Aparecerá la gestión de Tokens API. Para crear un Token API, por favor, haga click en el botón verde "Crear Token API" (ver figura 2).

Administración de Tokens API - Crear un Token API

Figura 2: Administración de Tokens API - Crear un Token API.

En la página siguiente, los Tokens API se podrán visualizar, renovar (botón verde "Refrescar Token API") y borrar (botón rojo "Borrar Token API"). Sólo un Token API está activo cada vez para cada usuario y podrá utilizarse para cualquier configuración disponible (ver figura 3).

Token API activo

Figura 3: Token API activo (ejemplo).

NOTA: En general, los Tokens API tienen un tiempo activo limitado y por lo tanto deben renovarse cuando expiran. Normalmente el tiempo activo estándar es de un mes.

3. Chequear un documento

Con este API se pueden chequear documentos Word e InDesign. La salida de cada chequeo consistirá en un único documento resultado. Para simplificar la generación de las URLs necesarias, la gestión de Tokens API muestra un resumen de las configuraciones disponibles junto con las correspondientes REST URLs. En dichas URLs el Token API correcto ya vendrá incluído. Después de seleccionar el tipo de resultado deseado, la URL puede insertarse fácilmente en su propio sistema.

Las configuraciones disponibles para chequear documentos aparecen listadas cronológicamente con un fondo gris. Haciendo click en una de las configuraciones, aparecerán los siguientes detalles: el texto describiendo la configuración (Descripción), una lista desplegable conteniendo los posibles tipos de resultados (Tipo) así como la REST URL correspondiente al formato de salida seleccionado (ver figura 4).

Detalles de la configuración seleccionada

Figura 4: Detalles de la configuración seleccionada (ejemplo).

Dependiendo del documento resultado requerido (versión comentada del documento, versión XML del documento, informe del chequeo en formato XML o informe del chequeo en formato HTML) debe hacerse la selección en la lista desplegable "Tipo" (ver figura 5).

Selección del formato de salida deseado

Figura 5: Selección del formato de salida deseado.

Puede encontrarse más información sobre los documentos resultado disponibles después de chequear un documento en Chequear un documento Word - 3.2 Documentos de salida para Word, en Chequear un documento InDesign - 3.2 Documentos de salida así como en Chequeo de la conversión InDesign-EPUB - 2.2 Documentos de salida para InDesign.

Para chequear un documento, se enviará una petición POST en formato multipart/form-data a la correspondiente URL. El archivo a chequear deberá ser adjuntado como un parámetro con nombre file. El proceso es síncrono, lo que quiere decir que la petición dura hasta que el proceso se completa y se devuelve el formato de salida seleccionada como resultado. Dependiendo de la carga en el servidor data2check, este proceso puede tardar algunos segundos.

Ejemplo: Utilizando curl, se podría chequear un documento Word con:

curl -X POST -o resultado.docx -F file=@ejemplo.docx "http://service.data2check.de/api/doc/docx?wfid=CONFIGURACION-ID&tokenid=TOKEN"

4. Limitaciones de uso

Sólo se puede chequear un documento por usuario cada vez. Hay que tener esto en cuenta de cara a la integración del API con los propios servicios. En caso de uso excesivo, data2check se reserva el derecho a introducir limitaciones de uso. Se pueden obtener condiciones individuales especiales de utilización, por ejemplo un período más amplio de validez de los Tokens API. Por favor, contactar con data2check en Contacto.

Copyright © 2017 data2check, todos los derechos reservados

GTCT | Aviso legal | Política de privacidad