DocTransform
AyudaAPIGuía rápida

Guía rápida

De una clave de API a un archivo descargado en cinco pasos.

Cinco pasos de una clave a un archivo descargado.

La API pública ejecuta una plantilla que ya creaste en DocTransform sobre un archivo que subes desde un script — sin ninguna pestaña del navegador de por medio.

Los cinco pasos

1

Crea una clave

Desde tu página de cuenta, Crea una clave. Cópiala ahora — se muestra solo una vez.

2

Guárdala como variable de entorno

Todos los ejemplos de estas páginas leen la clave desde DOCTRANSFORM_API_KEY, nunca como un literal en el comando:

export DOCTRANSFORM_API_KEY=dt_live_...
3

Lista tus plantillas

Encuentra el id de la plantilla que quieres ejecutar.

curl "https://doctransform.xyz/api/v1/templates" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
4

Crea una ejecución

Sube un archivo para ejecutar esa plantilla sobre él.

curl -X POST "https://doctransform.xyz/api/v1/templates/tmpl_123/runs" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
  -F "file=@/ruta/a/tu/archivo.csv"

Solo una ejecución que devuelve un archivo cuenta para tus ejecuciones mensuales.

5

Consulta y descarga

Una ejecución rápida responde 201 de inmediato, con el resultado ya listo. Una más larga responde 202 mientras sigue trabajando — consulta GET /runs/{id} hasta que su estado se resuelva, y luego descarga:

curl "https://doctransform.xyz/api/v1/runs/run_abc/output" \
  -H "Authorization: Bearer $DOCTRANSFORM_API_KEY" \
  -o resultado.csv

Consulta Autenticación, Ejecuciones y Errores y límites para el detalle completo detrás de cada paso.