Op deze pagina

API Overzicht

Hoe maak je API-calls naar ProcessMind

Deze gids geeft voorbeelden en best practices voor het doen van API-calls naar de services van ProcessMind. Of je nu data wilt ophalen, informatie wilt aanleveren of workflows wilt automatiseren, het begrijpen van onze API is essentieel.

Voor volledige endpoint documentatie en request/response-formaten bekijk je de API Referentie.

Voor meer voorbeelden en client libraries, bezoek onze API Documentatie op GitHub.

API Basis URL

Alle API-requests doe je naar:

https://api.processmind.com

Authenticatie

Alle API-requests vereisen jouw API key in de x-api-key header:

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

Je API key kun je opvragen via je ProcessMind-accountinstellingen. Zie API Key Aanvragen voor uitleg.

Belangrijke begrippen

  • apiKey – Jouw authenticatietoken voor alle API-requests.
  • tenantId – Identificeert je workspace/organisatiecontext. Vindbaar in je accountinstellingen.
  • datatableId – Identificeert een specifieke datatable voor data-operaties. Beschikbaar in de dataset-instellingen onder [Get Data Table ID] in ProcessMind.

Wat kun je doen

Met de ProcessMind API kun je:

  • Tenants beheren – Informatie ophalen, instellingen wijzigen, statistieken bekijken
  • Gebruikers beheren – Gebruikers toevoegen, aanpassen of verwijderen binnen tenants en organisaties
  • Processen beheren – Processen aanmaken, BPMN-modellen uploaden, in mappen organiseren
  • Data koppelen – Datatables koppelen aan processen voor analyse
  • Data uploaden – CSV/XLSX-bestanden direct uploaden naar datatables
  • Datasets beheren – Lijsten, bekijken en verwijderen van datasets en datatables

Veelvoorkomende Voorbeelden

Hieronder vind je praktische voorbeelden van veelgebruikte acties met de ProcessMind API.

Presigned Upload URL ophalen

Om een bestand te uploaden naar een datatable, haal eerst een presigned URL op:

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

Datasets ophalen

Haal alle datasets op binnen je tenant:

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

Tenantinformatie ophalen

Haal details op van je tenant:

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

Proces aanmaken

Maak een nieuw proces aan binnen je tenant:

const process = await createProcess({
	apiKey,
	tenantId: "tenant-123",
	displayName: "Order to Cash"
});
console.log(process.id); // Gebruik dit ID voor vervolgstappen

BPMN-model uploaden

Upload een BPMN-bestand om je procesmodel te definiëren:

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

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

Data mappen aan een proces

Koppel een datatable aan een proces voor analyse:

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

Gebruiker toevoegen aan een Tenant

Voeg een gebruiker toe aan je tenant:

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

Bestanden Uploaden

Het uploadproces naar ProcessMind gaat als volgt:

  1. Haal een presigned URL op via de getPresignedUploadUrl call.
  2. Doe een PUT-request naar die URL met de file als inhoud.
  3. De presigned URL geeft direct toestemming voor uploaden naar cloud storage – geen extra credentials nodig.

Hieronder een eenvoudig voorbeeld met fetch:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// Stap 1: Haal de presigned URL op
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// Stap 2: Upload het bestand via PUT
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
}

info

  • Presigned URLs verlopen binnen korte tijd (meestal minuten). Gebruik de URL direct na ophalen.
  • Is een upload mislukt (bijv. door netwerkproblemen), vraag dan een nieuwe presigned URL aan voordat je het opnieuw probeert.
  • Bewaar je apiKey altijd veilig en stel deze nooit bloot aan de clientkant (zoals in een openbare front‑end).

Complete Voorbeelden

Hieronder staan volledige, direct te gebruiken voorbeelden in verschillende programmeertalen.

Bash Voorbeeld: Bestand Uploaden

Minimaal Bash script om een bestand naar ProcessMind te uploaden met twee curl commando’s waarin placeholders voor alle waarden staan.

Download BASH Voorbeeld

Node.js Voorbeeld: Lokale CSV Uploaden

Upload een lokaal CSV-bestand naar ProcessMind met een presigned URL.

Stappen:

  1. Haal een presigned upload URL op van de API.
  2. Lees het lokale bestand van schijf.
  3. Upload het bestand via HTTP PUT naar de presigned URL.

Configuratie:

  • Geef je API key, tenantId, datatableId en filePath mee aan uploadFileToProcessMind().
  • De API base URL is https://api.processmind.com
Download NodeJS Voorbeeld

Python Voorbeeld: Lokale CSV Uploaden

Upload een lokaal CSV-bestand naar een externe API met een presigned URL.

Stappen:

  1. Haal een presigned upload URL op via de API.
  2. Lees het lokale bestand vanaf schijf.
  3. Upload het bestand met HTTP PUT naar de presigned URL.

Configuratie:

  • Pas indien nodig api_key, tenant_id, datatable_id en file_path aan.
Download Python Voorbeeld

Volgende Stappen

info

Heb je vragen of hulp nodig bij gebruik van de API? Neem gerust contact op met ons supportteam of doe mee in onze developer community forums.