Documentazione API
Riferimento API ProcessMind: endpoint, autenticazione e guide d’integrazione per sviluppatori.
Questa guida include esempi e best practice per usare le API ProcessMind. Che tu voglia recuperare data, inviare informazioni o automatizzare workflow, comprendere il funzionamento dell’API è fondamentale.
Per la documentazione completa degli endpoint con i formati request/response, consulta la API Reference.
Per altri esempi e client library, visita la nostra API Documentation su GitHub.
Tutte le richieste API devono essere inviate a:
https://api.processmind.com Tutte le richieste API richiedono la tua API key nell’header x-api-key:
x-api-key: your-api-key-here Puoi ottenere la tua API key nelle impostazioni del tuo account ProcessMind. Consulta Getting your API Key per le istruzioni.
La ProcessMind API ti permette di:
Di seguito trovi esempi pratici per eseguire le operazioni più comuni con la ProcessMind API.
Per caricare un file su una datatable, ottieni prima una presigned URL:
const presignedUrl = await getPresignedUploadUrl({
apiKey,
tenantId: "tenant-123",
datatableId: "table-456"
});
console.log(presignedUrl); // https://s3.amazonaws.com/…?X-Amz-Signature=… Recupera tutti i dataset nel tuo tenant:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); Recupera i dettagli sul tuo tenant:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); Crea un nuovo process nel tuo tenant:
const process = await createProcess({
apiKey,
tenantId: "tenant-123",
displayName: "Order to Cash"
});
console.log(process.id); // Usa questo ID per le operazioni successive Carica un file BPMN per definire il tuo process model:
const fs = require("fs");
const bpmnXml = fs.readFileSync("./my-process.bpmn", "utf8");
await uploadBpmn({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
bpmnXml
}); Collega una datatable a un process per l’analisi:
const mapping = await createProcessMapping({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
dataTableId: "datatable-789",
displayName: "Sales Data 2024",
showByDefault: true
}); Aggiungi un utente al tuo tenant:
const result = await addTenantUser({
apiKey,
tenantId: "tenant-123",
id: "user-456",
email: "colleague@example.com",
isAdminInTenant: false,
isActiveInTenant: true,
sendInvitationEmail: true
}); Il flusso per caricare un file su ProcessMind è:
getPresignedUploadUrl.Ecco un esempio semplificato con fetch:
async function uploadFile({ apiKey, tenantId, datatableId, file }) {
// Step 1: Ottieni una presigned URL
const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
// Step 2: Carica il file con PUT
await fetch(uploadUrl, {
method: "PUT",
headers: {
"Content-Type": file.type
},
body: file
});
} info
Di seguito trovi esempi completi e pronti da copiare in diversi linguaggi.
Script Bash minimale per caricare file su ProcessMind tramite due chiamate curl, con placeholder per tutti i valori
Carica un file CSV locale su ProcessMind tramite presigned URL.
Procedure:
Configurazione:
https://api.processmind.comCarica un file CSV locale su una API remota tramite presigned URL.
Procedure:
Configurazione:
info
Per domande o supporto nell’uso dell’API, contatta il nostro team di supporto o partecipa alla developer community.
Utilizziamo cookie per migliorare la Sua esperienza di navigazione, offrire contenuti personalizzati e analizzare il traffico. Cliccando su "Accetta tutto", Lei acconsente all'uso dei cookie.