Documenten Lijst

Op Deze Pagina

API calls

API-aanroepen naar ProcessMind

Deze gids biedt voorbeelden en best practices voor het maken van API calls naar de services van ProcessMind. Of je nu data wilt ophalen, informatie wilt insturen of workflows wilt automatiseren, het is belangrijk te weten hoe onze API werkt.

Authenticatievariabelen

apiKey Voeg je API key toe aan de request headers voor authenticatie bij alle API verzoeken. Je API key vind je in je ProcessMind accountinstellingen.
tenantId Sommige API endpoints vereisen een Tenant ID om de context van het verzoek aan te geven. Deze ID is uniek voor jouw organisatie en is ook te vinden in je accountinstellingen.
datatableId Werk je met een dataset, dan geef je de Datatable ID op zodat duidelijk is met welke datatable je werkt. Deze ID vind je in het instellingenmenu van de dataset [Get Data Table ID] in ProcessMind.

Direct bestand uploaden

ProcessMind ondersteunt direct uploaden van bestanden naar datatables via presigned URLs. Hiermee kun je veilig bestanden uploaden zonder je API key of andere gevoelige info zichtbaar te maken. Let op: presigned URLs zijn tijdelijk geldig en moeten direct na ophalen gebruikt worden. Om de upload URL te krijgen moet je een GET request doen naar de endpoint. Deze URL vind je in het dataset instellingenmenu [Get upload URL] binnen ProcessMind. Hier stel je een tijdslimiet in van maximaal 1 uur, 1 week of 1 maand.

Endpoint overzicht

Method	Endpoint	Beschrijving
GET	`/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl`	Geeft een tijdelijke pre-signed URL voor het uploaden van een bestand naar een datatable.
GET	`/tenant/{tenantId}/datasets`	Geeft een lijst van datasets voor de opgegeven tenant.
GET	`/tenant/{tenantId}`	Geeft details van de opgegeven tenant.
GET	`/tenant/{tenantId}/organization`	Geeft informatie over de organisatie van de tenant.

Base URL

Alle API requests gaan naar de volgende base URL: https://api.processmind.com

Pre-signed Upload URL ophalen

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl Parameters:

tenantId – ID van de tenant (string).
datatableId – ID van de datatable waar je naar wilt uploaden (string).
apiKey – Jouw API key (string).

Retourneert: Een response object met PreSignedUploadUrl, een tijdelijke URL waarmee je direct een bestand kunt uploaden (meestal via HTTP PUT).

Voorbeeld (met de helper):

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

Datasets ophalen

Endpoint: GET /tenant/{tenantId}/datasets Parameters:

tenantId – ID van de tenant.
apiKey – Jouw API key.

Retourneert: Een array van dataset-objecten die horen bij de tenant.

Voorbeeld:

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

Tenantdetails ophalen

Endpoint: GET /tenant/{tenantId} Parameters:

tenantId – ID van de tenant.
apiKey – Jouw API key.

Retourneert: Een object met metadata over de tenant, zoals naam, aanmaakdatum en plan.

Voorbeeld:

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

Organisatiedetails ophalen

Endpoint: GET /tenant/{tenantId}/organization Parameters:

tenantId – ID van de tenant.
apiKey – Jouw API key.

Retourneert: Informatie over de organisatie die gekoppeld is aan de tenant (zoals bedrijfsnaam, adres, contactgegevens).

Voorbeeld:

const org = await getOrganization({
  apiKey,
  tenantId: 'tenant-123'
});
console.log(org);

Bestand uploaden

De uploadFile functie laat zien hoe je een bestand uploadt via de pre‑signed URL. Het standaardproces is:

Haal de pre‑signed URL op met getPresignedUploadUrl.
Voer een PUT request uit naar deze URL met het bestand. De pre‑signed URL geeft direct toestemming om te uploaden naar de storage provider, extra credentials zijn niet nodig.
(Eventueel) Geef je API een seintje dat de upload klaar is, als jouw backend dat vereist.

Hieronder een eenvoudig voorbeeld met fetch om een bestand te uploaden:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
  // Stap 1: Haal een pre-signed 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
  });
  
  // Stap 3: Optioneel, geef je API een seintje dat de upload klaar is
  // (afhankelijk van je backend)
}

info

Pre‑signed URLs verlopen vaak na enkele minuten. Gebruik de URL direct na ophalen.
Gaat uploaden mis (bijvoorbeeld slechte netwerkverbinding)? Vraag dan een nieuwe pre‑signed URL aan voor je opnieuw probeert.
Houd je apiKey altijd veilig en maak deze nooit openbaar aan de clientkant (zoals in een publieke frontend).

BASH Voorbeeld

Minimal Bash-script om een bestand naar ProcessMind te uploaden via twee curl-calls, met invulvelden voor alle waarden

Download BASH Voorbeeld

#!/bin/bash
# Minimal Bash-script om een bestand te uploaden naar ProcessMind met twee curl-commando's en invulvelden voor alle waarden

# Vervang de onderstaande invulvelden door je eigen waarden:
# <API_KEY>, <TENANT_ID>, <DATATABLE_ID>, <FILE_PATH>

curl -s -H "x-api-key: <API_KEY>" \
    "https://api.processmind.com/tenant/<TENANT_ID>/datatable/<DATATABLE_ID>/uploads/presignedurl" \
    | grep -oP '"PreSignedUploadUrl"\s*:\s*"\K[^"]+' \
    | xargs -I {} curl -s -X PUT --upload-file "<FILE_PATH>" "{}"

NodeJS Voorbeeld

Uploadt een lokaal CSV-bestand naar ProcessMind via een presigned URL.

Stappen:

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

Configuratie:

Geef je API key, tenantId, datatableId en filePath mee bij het aanroepen van uploadFileToProcessMind().
De API base URL is https://api.processmind.com

Download NodeJS Voorbeeld

/**
 * Uploadt een lokaal CSV-bestand naar ProcessMind via een presigned URL.
 *
 * Stappen:
 * 1. Haal een presigned upload-URL op via de API.
 * 2. Lees het lokale bestand van schijf.
 * 3. Upload het bestand met HTTP PUT.
 *
 * Configuratie:
 * - Geef je API key, tenantId, datatableId en filePath mee aan uploadFileToProcessMind().
 * - De API base URL is https://api.processmind.com
 */

const fs = require("node:fs");

/**
 * Uploadt een bestand naar een ProcessMind datatable via een presigned URL.
 * @param {string} apiKey - Je API key voor authenticatie.
 * @param {string} tenantId - Je tenant ID.
 * @param {string} datatableId - Je datatable ID.
 * @param {string} filePath - Pad naar het te uploaden bestand.
 */

async function getApi({path, apiKey, apiUrl = "https://api.processmind.com"}) {
	try {
        const response = await fetch(`${apiUrl}${path}`, {
            method: "GET",
            headers: {
                "x-api-key": apiKey
            }
        });
        const body = await response.json();
        if (!response.ok) {
            console.error(`Fout bij laden van de API: ${response.status}, ${response.statusText}: ${body.message}`);
            return;
        }
        return body;
    } catch (err) {
        console.error("Onverwachte fout:", err);
    }
}

async function getPresignedUploadUrl({apiKey, tenantId, datatableId, apiUrl = "https://api.processmind.com"}) {
	return (await getApi({apiKey, path: `/tenant/${tenantId}/datatable/${datatableId}/uploads/presignedurl`, apiUrl})).PreSignedUploadUrl;
}

async function getDatasets({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}/datasets`, apiUrl});
}

async function getTenant({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}`, apiUrl});
}

async function getOrganization({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/tenant/${tenantId}/organization`, apiUrl});
}

async function uploadFile({apiKey, tenantId, datatableId, filePath, apiUrl = "https://api.processmind.com"}) {
    try {
        const uploadUrl = await getPresignedUploadUrl({apiKey, tenantId, datatableId, apiUrl});

		console.log("Bestand uploaden...");
        fs.readFile(filePath, async (err, data) => {
            if (err) {
                console.error("Fout bij lezen van bestand:", err);
                return;
            }
            try {
                const uploadRes = await fetch(uploadUrl, {
                    method: "PUT",
                    body: data
                });
                if (!uploadRes.ok) {
                    console.error("Upload mislukt:", uploadRes.status, uploadRes.statusText);
                } else {
                    console.log("Bestand succesvol geüpload.");
                }
            } catch (uploadErr) {
                console.error("Fout bij uploaden:", uploadErr);
            }
        });
    } catch (err) {
        console.error("Onverwachte fout:", err);
    }
}

// Exporteer de functies voor gebruik in andere modules
module.exports = { 
	getPresignedUploadUrl,
	getDatasets,
	getTenant,
	getOrganization,
	uploadFile 
};

Python Voorbeeld

Uploadt een lokaal CSV-bestand naar een externe API via een presigned URL.

Stappen:

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

Configuratie:

Pas api_key, tenant_id, datatable_id, file_path aan indien nodig.

Download Python Voorbeeld

"""
Uploadt een lokaal CSV-bestand naar een externe API via een presigned URL.

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

Configuratie:
- Pas api_key, tenant_id, datatable_id, file_path aan waar nodig.
"""

import requests

# === Configuratie ===
api_key = ""  # API key voor authenticatie
tenant_id = ""  # Tenant ID
datatable_id = ""  # Datatable ID
file_path = ""  # Pad naar het te uploaden bestand


print("Upload-URL ophalen...")
api_url = "https://api.processmind.com"  # Basis API URL
presign_url = f"{api_url}/tenant/{tenant_id}/datatable/{datatable_id}/uploads/presignedurl"
presign_res = requests.get(presign_url, headers={"x-api-key": api_key})
if not presign_res.ok:
	print(f"Fout bij ophalen upload-URL: {presign_res.status_code}, {presign_res.reason}: {presign_res.text}")
	exit(1)

presign_body = presign_res.json()
upload_url = presign_body.get("PreSignedUploadUrl")
if not upload_url:
	print("Geen presigned upload-URL ontvangen.")
	exit(1)

print("Bestand uploaden...")
with open(file_path, "rb") as f:
	upload_res = requests.put(upload_url, data=f)
if not upload_res.ok:
	print(f"Upload mislukt: {upload_res.status_code}, {upload_res.reason}")
else:
	print("Bestand succesvol geüpload.")

Gerelateerde Documentatie

API Key Beheer

Beheer eenvoudig je API keys en koppel ProcessMind veilig en efficiënt met je apps.