Documentenlijst

Op deze pagina

> bronnen > docs > api > api aanroepen > API calls

API-calls

API Calls maken naar ProcessMind

Deze gids geeft je voorbeelden en best practices voor het maken van API calls naar de ProcessMind services. Of je nu data wilt ophalen, informatie wilt toevoegen of workflows wilt automatiseren: goed weten hoe je met onze API werkt is essentieel. Bekijk de uitgebreide API documentatie, inclusief beschikbare endpoints, authenticatiemethoden, voorbeeldverzoeken, response formats en stap-voor-stap integratiegidsen op onze API-documentatie op GitHub.

Authenticatie Variabelen

apiKey Voor alle API requests moet je je API key toevoegen aan de request headers voor authenticatie. Je API key vind je in je ProcessMind accountinstellingen.
tenantId Sommige API endpoints vereisen een Tenant ID om de context van het verzoek te bepalen. Dit ID is uniek voor jouw organisatie en vind je ook in je accountinstellingen.
datatableId Werk je met datasets, dan moet je het Datatable ID opgeven om aan te geven met welke datatable je werkt. Dit ID vind je in het dataset instellingen menu via [Get Data Table ID] in ProcessMind.

Direct Bestand Uploaden

ProcessMind ondersteunt het direct uploaden van bestanden naar datatables via presigned URLs. Met deze methode kun je veilig bestanden uploaden zonder je API key of andere gevoelige info te delen. Let op: presigned URLs zijn tijdelijk geldig en moeten direct na ophalen gebruikt worden. De upload URL verkrijg je met een GET request naar het endpoint. Deze URL haal je op via het dataset instellingen menu [Get upload URL] in ProcessMind. Hier stel je de tijdslimiet in tot maximaal 1 uur, 1 week of 1 maand.

API Endpoint Overzicht

Methode	Endpoint	Beschrijving
GET	`/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl`	Geeft een tijdelijke pre‑signed URL terug om een bestand te uploaden naar een datatable.
GET	`/tenant/{tenantId}/datasets`	Geeft een lijst met datasets voor de betreffende tenant.
GET	`/tenant/{tenantId}`	Geeft details over de opgegeven tenant.
GET	`/tenant/{tenantId}/organization`	Geeft informatie over de organisatie van de tenant.

API Base URL

Alle API requests moeten gedaan worden naar deze base URL: https://api.processmind.com

Hoe verkrijg je een Pre‑signed Upload URL

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

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

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

Voorbeeld (met helper):

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

Hoe kun je Datasets Overzicht Opvragen

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

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

Resultaat:
Een array met dataset objecten van de tenant.

Voorbeeld:

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

Tenantgegevens Opvragen

Endpoint: GET /tenant/{tenantId}
Parameters:

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

Resultaat: Een object met metadata over de tenant, zoals naam, aanmaakdatum en abonnement.

Voorbeeld:

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

Organisatiegegevens Opvragen

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

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

Resultaat: Informatie over de organisatie gekoppeld 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 met een pre‑signed URL. De workflow is:

Haal de pre‑signed URL op via getPresignedUploadUrl.
Doe een PUT request naar deze URL met het bestand. De pre‑signed URL geeft direct uploadrechten bij de storage provider, je hebt verder geen extra credentials nodig.
(Optioneel) Geef je API door dat de upload voltooid is, als jouw backend dat vereist.

Hieronder een simpel fetch-voorbeeld:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// Stap 1: pre-signed URL ophalen
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// Stap 2: upload bestand via PUT
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
	
	// Stap 3: optioneel API melden dat upload klaar is
	// (afhankelijk van je backend implementatie)
}

info

Pre‑signed URLs verlopen na een ingestelde tijd (vaak minuten). Gebruik ze direct na ophalen.
Als uploaden mislukt (bijv. door netwerkproblemen), vraag een nieuwe pre‑signed URL aan voor je opnieuw probeert.
Houd je apiKey altijd veilig en deel deze niet aan de client side (bijv. in een publieke front‑end).

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

#!/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>" "{}"

Node.js Voorbeeld: Lokale CSV Uploaden

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

Stappen:

Haal een presigned upload URL op van de API.
Lees het lokale bestand van schijf.
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

/**
 * Upload een lokaal CSV-bestand naar ProcessMind met 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 naar de presigned URL via HTTP PUT.
 *
 * Configuratie:
 * - Vul je API-key, tenantId, datatableId en filePath in bij het aanroepen van 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 identifier.
 * @param {string} datatableId - Je datatable identifier.
 * @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 het laden via 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 wordt geüpload...");
        fs.readFile(filePath, async (err, data) => {
            if (err) {
                console.error("Fout bij het 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 van bestand:", 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: Lokale CSV Uploaden

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

Stappen:

Haal een presigned upload URL op via de API.
Lees het lokale bestand vanaf schijf.
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

"""
Upload 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 lokale bestand van schijf.
3. Upload het bestand met HTTP PUT naar de presigned URL.

Configuratie:
- Vul 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 bestand om te uploaden


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.")

info

Zie onze API Documentatie op GitHub voor uitgebreide info, endpoints, voorbeelden en integratiegidsen. Heb je vragen of hulp nodig bij het gebruik van de API? Neem gerust contact op met ons supportteam of sluit je aan bij onze developer community forums.

Gerelateerde documentatie

API Documentatie

API reference voor ProcessMind: endpoints, authenticatie en integratiegidsen voor developers.

API Key Management

Veilig API keys aanmaken, beheren en gebruiken voor integratie met de ProcessMind API in je app.