In questa pagina

Panoramica API

Come effettuare chiamate API a ProcessMind

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.

API Base URL

Tutte le richieste API devono essere inviate a:

https://api.processmind.com

Autenticazione

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.

Concetti chiave

  • apiKey – Il tuo token di autenticazione per tutte le richieste API.
  • tenantId – Identifica il tuo workspace o organization. Si trova nelle impostazioni account.
  • datatableId – Identifica una datatable specifica per le operazioni sui data. Disponibile nelle impostazioni dataset in [Get Data Table ID] in ProcessMind.

Cosa puoi fare

La ProcessMind API ti permette di:

  • Gestire i tenant – Recuperare info tenant, aggiornare impostazioni e vedere statistiche
  • Gestire utenti – Aggiungere, modificare o rimuovere utenti da tenant e organization
  • Gestire process – Creare process, caricare modelli BPMN, organizzare in cartelle
  • Collegare data – Mappare datatable su process per l’analisi
  • Caricare data – Eseguire upload di file CSV/XLSX sulle datatable
  • Gestire dataset – Elencare, consultare o eliminare dataset e datatable

Esempi Comuni

Di seguito trovi esempi pratici per eseguire le operazioni più comuni con la ProcessMind API.

Ottenere una presigned upload URL

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=…

Lista dataset

Recupera tutti i dataset nel tuo tenant:

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

Recuperare informazioni tenant

Recupera i dettagli sul tuo tenant:

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

Creare un nuovo process

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

Caricare un modello BPMN

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
});

Mappare data su un process

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
});

Aggiungere un utente a un tenant

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
});

Upload File

Il flusso per caricare un file su ProcessMind è:

  1. Ottieni una presigned URL usando la chiamata getPresignedUploadUrl.
  2. Esegui una richiesta PUT verso quella URL con il contenuto del file.
  3. La presigned URL autorizza l’upload diretto su cloud storage – non servono altre credenziali.

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

  • Le presigned URL scadono dopo un certo tempo (di solito pochi minuti). Usale subito.
  • Se l’upload fallisce (es. interruzione rete), richiedi una nuova presigned URL per riprovare.
  • Mantieni la tua apiKey sicura e non pubblicarla lato client (es. in frontend pubblico).

Esempi Completi

Di seguito trovi esempi completi e pronti da copiare in diversi linguaggi.

Esempio Bash: Upload di un file

Script Bash minimale per caricare file su ProcessMind tramite due chiamate curl, con placeholder per tutti i valori

Scarica esempio BASH

Esempio Node.js: Upload di un file CSV locale

Carica un file CSV locale su ProcessMind tramite presigned URL.

Procedure:

  1. Richiedi una presigned upload URL dalla API.
  2. Leggi il file locale dal disco.
  3. Carica il file sulla presigned URL usando HTTP PUT.

Configurazione:

  • Inserisci API key, tenantId, datatableId e filePath quando richiami uploadFileToProcessMind().
  • L’URL base API è https://api.processmind.com
Scarica esempio NodeJS

Esempio Python: Upload di un file CSV locale

Carica un file CSV locale su una API remota tramite presigned URL.

Procedure:

  1. Richiedi una presigned upload URL alla API.
  2. Leggi il file dal disco.
  3. Carica il file sulla presigned URL tramite HTTP PUT.

Configurazione:

  • Aggiorna api_key, tenant_id, datatable_id, file_path secondo necessità.
Scarica esempio Python

Prossimi Passi

info

Per domande o supporto nell’uso dell’API, contatta il nostro team di supporto o partecipa alla developer community.