Documentación de API
Referencia API ProcessMind: endpoints, autenticación y guías de integración para developers.
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.
Todas las peticiones a la API deben dirigirse a:
https://api.processmind.com 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.
La API de ProcessMind te permite:
A continuación encontrarás ejemplos prácticos para realizar operaciones habituales con la API de ProcessMind.
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=… Obtén todos los datasets de tu tenant:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); Obtén detalles sobre tu tenant:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); 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 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
}); 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
}); 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
}); El flujo general para subir un archivo en ProcessMind es:
getPresignedUploadUrl.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
A continuación tienes ejemplos listos para copiar y pegar en diferentes lenguajes.
Script Bash sencillo para subir un archivo a ProcessMind con dos llamadas curl, usando datos a completar.
Sube un archivo CSV local a ProcessMind usando una URL presigned.
Pasos:
Configuración:
https://api.processmind.comSube un archivo CSV local a la API usando una URL presigned.
Pasos:
Configuración:
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.
Usamos cookies para mejorar su experiencia de navegación, mostrar contenido personalizado y analizar nuestro tráfico. Al hacer clic en "Aceptar todo", usted consiente el uso de cookies.