DocTransform

Primera ejecución con la API

Ejecuta una plantilla sobre un archivo desde un script y descarga el resultado.

Qué necesitas

Pasos

  1. Crea una clave

    Desde tu página de cuenta, pulsa 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=@/path/to/your/file.csv"

    Solo una ejecución que devuelve un archivo gasta una de tus exportaciones del mes.

  5. Consulta su estado

    Una ejecución rápida responde 201 con el resultado adjunto. Una más larga responde 202: consulta GET /runs/{id} hasta que su estado deje de ser running.

    curl "https://doctransform.xyz/api/v1/runs/run_abc" \
      -H "Authorization: Bearer $DOCTRANSFORM_API_KEY"
  6. Descarga el resultado

    Cuando la ejecución haya terminado bien, descarga su salida:

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

Siguientes pasos