Skip to content

Extraer referencias de un PDF

Manuel Olguín edited this page Nov 22, 2016 · 5 revisions

Endpoint designado a la extracción de referencias contenidos en el cuerpo de un documento PDF.

###URL

/api/v1/refs/pdf

###Métodos: POST

###Parámetros del Formulario

  • pdf_file=[file] Archivo pdf a extraer referencias.

###Solicitud Exitosa

En caso de éxito, el servidor retornará un código 202 y un JSON con la información del job creado. El estado de éste puede ser consultado en el endpoint asignado.

Código: 202
Contenido:

{
    "job": "IjY4Zjc3NjRkLTY...",
    "submitted": "1970-01-01T00:00:00.000000+00:00"
}

El formato del resultado en el job es una lista de JSON estándar, uno por cada referencia identificada en el PDF. Todo esto va dentro de la llave result del JSON de respuesta de la consulta al estado del job diferido.

###Ejemplo

Solicitud:

$ curl "http://0.0.0.0:5001/api/v1/refs/pdf" -X POST -F "pdf_file=@/path_to_file/example.pdf"

Respuesta:

{
  "job": "ImRiZDYyNDExLTQzOWEtNDYxNy1hOGYxLWIxMDZiYmNkYjIwYyI.T8gkpANvFaiJd9kpCI1mSk4AD8w",
  "submitted": "2016-11-15T17:05:47.334962+00:00"
}

###Notas

El servicio puede retornar más mensajes de error que los detallados, sin embargo éstos sólo aparecerán en el caso de que fallen ambos servicios remotos.