En esta página

Resumen API ProcessMind

Cómo Realizar Llamadas a la API de ProcessMind

Esta guía te muestra ejemplos y buenas prácticas para utilizar la API de ProcessMind. Tanto si necesitas consultar data, enviar información o automatizar workflows, es clave conocer cómo interactuar con nuestra API.

Para ver toda la documentación de endpoints y formatos de request/response, consulta la Referencia de la API.

Para más ejemplos y librerías de cliente, visita la Documentación API en GitHub.

URL Base de la API

Todas las peticiones a la API deben dirigirse a:

https://api.processmind.com

Autenticación

Todas las peticiones a la API requieren tu API key en el header x-api-key:

x-api-key: your-api-key-here

La API key se obtiene en la configuración de tu cuenta en ProcessMind. Consulta Cómo obtener tu API Key para más información.

Conceptos Clave

  • apiKey – Tu token de autenticación para peticiones a la API.
  • tenantId – Identifica tu espacio de trabajo o contexto de organización. Lo encuentras en la configuración de tu cuenta.
  • datatableId – Identificador de un datatable para operaciones con data. Lo puedes localizar en el menú de configuración de los datasets, en [Get Data Table ID] dentro de ProcessMind.

Qué Puedes Hacer

La API de ProcessMind te permite:

  • Gestionar Tenants – Consultar info del tenant, actualizar settings y ver estadísticas
  • Gestionar Usuarios – Añadir, actualizar o eliminar usuarios de tenants y organizaciones
  • Gestionar Procesos – Crear procesos, subir modelos BPMN, organizar en carpetas
  • Conectar Data – Mapear datatables a procesos para análisis
  • Subir Data – Subir archivos CSV/XLSX directamente a los datatables
  • Gestionar Datasets – Listar, inspeccionar y eliminar datasets y datatables

Ejemplos Comunes

A continuación encontrarás ejemplos prácticos para realizar operaciones habituales con la API de ProcessMind.

Obtener una URL de Subida Presignada

Para subir un archivo a un datatable, primero obtén una URL presignada:

const presignedUrl = await getPresignedUploadUrl({
	apiKey,
	tenantId: "tenant-123",
	datatableId: "table-456"
});
console.log(presignedUrl); // https://s3.amazonaws.com/…?X-Amz-Signature=…

Listar Datasets

Obtén todos los datasets de tu tenant:

const datasets = await getDatasets({
	apiKey,
	tenantId: "tenant-123"
});
console.log(datasets);

Obtener Información del Tenant

Obtén detalles sobre tu tenant:

const tenantInfo = await getTenant({
	apiKey,
	tenantId: "tenant-123"
});
console.log(tenantInfo);

Crear un Proceso

Crea un proceso nuevo en tu tenant:

const process = await createProcess({
	apiKey,
	tenantId: "tenant-123",
	displayName: "Order to Cash"
});
console.log(process.id); // Usa este ID en las operaciones siguientes

Subir un Modelo BPMN

Sube un archivo BPMN para definir tu modelo de proceso:

const fs = require("fs");
const bpmnXml = fs.readFileSync("./my-process.bpmn", "utf8");

await uploadBpmn({
	apiKey,
	tenantId: "tenant-123",
	processId: "process-456",
	bpmnXml
});

Mapear Data a un Proceso

Conecta un datatable a un proceso para su análisis:

const mapping = await createProcessMapping({
	apiKey,
	tenantId: "tenant-123",
	processId: "process-456",
	dataTableId: "datatable-789",
	displayName: "Sales Data 2024",
	showByDefault: true
});

Añadir un Usuario a un Tenant

Agrega un usuario a tu tenant:

const result = await addTenantUser({
	apiKey,
	tenantId: "tenant-123",
	id: "user-456",
	email: "colleague@example.com",
	isAdminInTenant: false,
	isActiveInTenant: true,
	sendInvitationEmail: true
});

Subida de Archivos

El flujo general para subir un archivo en ProcessMind es:

  1. Consigue una URL presignada usando getPresignedUploadUrl.
  2. Realiza un PUT a esa URL con el contenido del archivo.
  3. La URL presignada autoriza la subida directa al cloud storage – sin credenciales extra.

Aquí tienes un ejemplo sencillo usando fetch:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// Paso 1: Obtén una URL presignada
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// Paso 2: Sube el archivo con PUT
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
}

info

  • Las URLs presignadas caducan tras un tiempo (normalmente minutos). Úsalas al momento.
  • Si la subida falla (por ejemplo, por corte de red), solicita una nueva URL presignada antes de reintentar.
  • Mantén siempre segura tu apiKey y nunca la expongas en el lado cliente (por ejemplo, en el front‑end público).

Ejemplos Completos

A continuación tienes ejemplos listos para copiar y pegar en diferentes lenguajes.

Ejemplo Bash: Subida de un archivo

Script Bash sencillo para subir un archivo a ProcessMind con dos llamadas curl, usando datos a completar.

Descargar ejemplo BASH

Ejemplo Node.js: Subida de archivo CSV local

Sube un archivo CSV local a ProcessMind usando una URL presigned.

Pasos:

  1. Solicita una URL presigned de subida a la API.
  2. Lee el archivo local.
  3. Sube el archivo con HTTP PUT.

Configuración:

  • Indica tu API key, tenantId, datatableId y filePath al llamar uploadFileToProcessMind().
  • La URL base de la API es https://api.processmind.com
Descargar ejemplo NodeJS

Ejemplo Python: Subida de archivo CSV local

Sube un archivo CSV local a la API usando una URL presigned.

Pasos:

  1. Solicita una URL presigned de subida a la API.
  2. Lee el archivo local.
  3. Sube el archivo a la URL con HTTP PUT.

Configuración:

  • Actualiza api_key, tenant_id, datatable_id y file_path según corresponda.
Descargar ejemplo Python

Siguientes Pasos

info

Si tienes preguntas o necesitas soporte con el uso de la API, puedes contactar con nuestro equipo de soporte o unirte a los foros de la comunidad de desarrolladores.