API REST
En resumen
El procesamiento de Documentize es asíncrono: envías una tarea, consultas su estado y después descargas el resultado. Las aplicaciones web usan exactamente esta interfaz REST (bajo /webapi/), y el autoalojamiento sirve la misma. Advertencia importante: el repositorio no tiene una referencia pública de la API ni un archivo de peticiones de ejemplo, así que los detalles de los puntos de conexión que siguen describen lo que el servicio hace hoy, no un contrato publicado y con versiones (compruébalo antes de construir un producto encima).
Cómo funciona una tarea asíncrona
- Crear. Haz POST de un formulario multipart con tus archivos a una ruta de operación, por ejemplo
POST /webapi/compress(con parámetros comocompressTypeen la cadena de consulta) oPOST /webapi/merge(filesmás opciones comoinputType,outputType). La respuesta es un objeto de estado que lleva el id de la tarea y un nombre de archivo o carpeta. - Cola. La petición se pone en una cola y la recoge un worker de esa aplicación; no te quedas atado a la conexión.
- Consultar.
POST /webapi/process_status/{id}devuelve el estado actual. Códigos de estado de la respuesta:203sigue procesando (continúa consultando; puede haber campos de progreso y un mensaje de paso),200terminado con enlaces de descarga,204en espera o estancado (un indicador de estancamiento marca el trabajo que dejó de avanzar),500fallo. - Descargar. Una respuesta terminada enumera los archivos de resultado; los enlaces de archivo tienen este aspecto:
/webapi/file_url/{dir}/{file}. Los resultados se conservan temporalmente, no para siempre. - Limpiar.
POST /webapi/ImmediatelyRemove/{id}borra de inmediato los archivos de una tarea. Los usuarios con sesión iniciada pueden listarGET /webapi/my-files.
Las demás rutas de aplicación siguen la misma forma: rotate, removepages, splitdoc, convert, searchable, ocr, extract-text, extract-image, extract-metadata, resize, booklet, flatten, deskew, abstracts-generator, chat y más.
Continuaciones
En el plan gratuito, un trabajo largo puede detenerse al llegar a un límite de tiempo con solo una parte de su entrada procesada. El resultado lleva entonces un id de continuación (32 caracteres hexadecimales):
GET /webapi/continuations/{id}muestra los archivos que quedan.POST /webapi/continuations/{id}/continueinicia una nueva tarea para ellos. Es gratuito (no se cobra ninguna operación), puede ofrecerse solo tras un tiempo de espera (HTTP 429 conavailableFromUtc) y una segunda llamada devuelve la misma tarea.DELETE /webapi/continuations/{id}la descarta. El id caduca; uno que no existe o ya está terminado devuelve 404.
Autenticación y límites
- Las peticiones anónimas se ejecutan con una cuota diaria pequeña; las cuentas con sesión iniciada y las suscritas obtienen más (consulta canales).
- El acceso a la cuenta usa un token de portador (bearer). Las claves de larga duración son las claves
dmk_emitidas en la página de MCP, que funcionan comoAuthorization: Bearer dmk_...; los clientes de escritorio aceptan un token copiado de la aplicación web. Aquí no se documenta si las clavesdmk_se aceptan en todas las rutas REST (compruébalo en la aplicación en funcionamiento). - Una ejecución del plan gratuito puede estar limitada (por ejemplo, por tamaño de archivo o por un límite de páginas del PDF), y una suscripción de pago lo elimina.
Un esbozo mínimo
curl -F "files=@big.pdf" "https://<host>/webapi/compress?compressType=1"
# -> JSON with the task id
curl -X POST "https://<host>/webapi/process_status/<id>"
# repeat until statusCode is 200, then fetch the listed file URLs
<host> es el servicio con el que habla la aplicación web, o tu propio autoalojamiento (http://localhost/webapi/). Los nombres exactos de los campos JSON (compruébalos con una respuesta real de la aplicación en funcionamiento) no se fijan en este libro.