API-documentatie
API referentie voor ProcessMind: endpoints, authenticatie en integratiegidsen voor developers.
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.
Alle API-requests doe je naar:
https://api.processmind.com 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.
Met de ProcessMind API kun je:
Hieronder vind je praktische voorbeelden van veelgebruikte acties met de ProcessMind API.
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=… Haal alle datasets op binnen je tenant:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); Haal details op van je tenant:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); 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 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
}); 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
}); 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
}); Het uploadproces naar ProcessMind gaat als volgt:
getPresignedUploadUrl call.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
Hieronder staan volledige, direct te gebruiken voorbeelden in verschillende programmeertalen.
Minimaal Bash script om een bestand naar ProcessMind te uploaden met twee curl commando’s waarin placeholders voor alle waarden staan.
Upload een lokaal CSV-bestand naar ProcessMind met een presigned URL.
Stappen:
Configuratie:
https://api.processmind.comUpload een lokaal CSV-bestand naar een externe API met een presigned URL.
Stappen:
Configuratie:
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.
We gebruiken cookies om je ervaring te verbeteren, gepersonaliseerde inhoud te tonen en het verkeer op onze site te analyseren. Door op "Alles accepteren" te klikken, ga je akkoord met ons gebruik van cookies.