Auf dieser Seite

API-Überblick

API-Aufrufe bei ProcessMind durchführen

Diese Anleitung zeigt Beispiele und Best Practices für API-Calls in ProcessMind. Egal ob Sie Daten abrufen, Informationen übermitteln oder Workflows automatisieren möchten: Ein gutes Verständnis der API sorgt für einen problemlosen Ablauf.

Umfassende Dokumentationen zu allen Endpunkten und Request/Response-Formaten finden Sie in der API-Referenz.

Weitere Beispiele und Client Libraries stehen in unserer API-Dokumentation auf GitHub zur Verfügung.

API-Basis-URL

Alle API-Requests richten Sie bitte an:

https://api.processmind.com

Authentifizierung

Jeder API-Request benötigt Ihren API-Key im x-API-key Header:

x-API-key: your-API-key-here

Den API-Key anfordern Sie in den Einstellungen Ihres ProcessMind-Accounts. Eine Anleitung finden Sie unter API-Key anfordern.

Zentrale Begriffe

  • APIKey: Ihr Authentifizierungs-Token für alle API-Anfragen.
  • tenantId: Kennzeichnet Ihren Workspace/Organisations-Kontext. Zu finden in den Kontoeinstellungen.
  • datatableId: Eindeutige Kennung einer Datentable für Datenoperationen. Im Datenset-Einstellungen-Menü [Get Daten Table ID] in ProcessMind verfügbar.

Ihre Möglichkeiten

Mit der ProcessMind API können Sie:

  • Tenants verwalten: Informationen abrufen, Einstellungen anpassen, Statusstiken einsehen
  • Benutzer verwalten: Nutzer zu Tenants/Organisationen hinzufügen, aktualisieren oder entfernen
  • Prozesse managen: Prozesse anlegen, BPMN-Modellle hochladen, in Ordnern organisieren
  • Daten verknüpfen: Datentables Prozessen für Analysen zuordnen
  • Daten hochladen: CSV/XLSX-Dateien direkt in Datentables importieren
  • Datensets verwalten: Datensets und Datentables auflisten, prüfen und löschen

Häufige Beispiele

Hier finden Sie praxisnahe Beispiele für typische Anwendungsfälle mit der ProcessMind API.

Signierte Upload-URL abrufen

Um eine Datei in eine Datentable hochzuladen, holen Sie zuerst eine presigned URL:

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

Datensets auflisten

Listeen Sie alle Datensets in Ihrem Tenant auf:

const Datensatzs = await getDatensets({
	APIKey,
	tenantId: "tenant-123"
});
console.log(Datensatzs);

Tenant-Informationen abrufen

Rufen Sie Informationen zu Ihrem Tenant ab:

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

Prozess erstellen

Legen Sie einen neuen Prozess in Ihrem Tenant an:

const process = await createProcess({
	APIKey,
	tenantId: "tenant-123",
	displayName: "Order-to-Cash"
});
console.log(process.id); // Verwenden Sie diese ID für weitere Aktionen

BPMN-Modelll hochladen

Laden Sie eine BPMN-Datei hoch, um Ihr Prozessmodell zu definieren:

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

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

Daten einem Prozess zuordnen

Verknüpfen Sie eine Datentable mit einem Prozess für Analysen:

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

Benutzer zu einem Tenant hinzufügen

Fügen Sie einen Benutzer zu Ihrem Tenant hinzu:

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

Dateien hochladen

So funktioniert der Datei-Upload zu ProcessMind im Überblick:

  1. Rufen Sie eine presigned URL via getPresignedUploadUrl-Call ab.
  2. Senden Sie die Datei per PUT-Request an diese URL.
  3. Die presigned URL autorisiert den direkten Upload in den Cloud-Speicher, ohne weitere ZugangsDaten.

Hier ein vereinfachtes Beispiel mit fetch:

async function uploadFile({ APIKey, tenantId, datatableId, file }) {
	// Schritt 1: Presigned URL abrufen
	const uploadUrl = await getPresignedUploadUrl({ APIKey, tenantId, datatableId });
	
	// Schritt 2: Datei per PUT hochladen
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Typ": file.type
		},
		body: file
	});
}

Hinweis

  • Presigned URLs sind zeitlich begrenzt (meist wenige Minuten). Verwenden Sie die URL unmittelbar nach Abruf.
  • Bei Upload-Fehlern (z. B. Netzwerkunterbrechung) holen Sie eine neue presigned URL, bevor Sie es erneut versuchen.
  • Halten Sie Ihren APIKey immer sicher und geben Sie ihn nicht im Client (beispielsweise im öffentlichen Frontend) preis.

Komplette Beispiele

Nachfolgend finden Sie vollständige, direkt nutzbare Beispiele in verschiedenen Programmiersprachen.

Bash-Beispiel: Datei-Upload

Mini-Bash-Script zum Datei-Upload nach ProcessMind mit zwei curl-Calls. Platzhalter ersetzen.

Bash-Beispiel herunterladen

Node.js-Beispiel: CSV-Upload

Upload einer lokalen CSV-Datei per presigned URL zu ProcessMind.

Ablauf:

  1. Presigned Upload URL über API abrufen.
  2. Datei lokal von der Festplatte lesen.
  3. Datei per HTTP PUT an die URL hochladen.

Konfiguration:

  • APIKey, tenantId, datatableId und filePath an uploadFileToProcessMind() übergeben.
  • Die API-Basis-URL ist https://API.processmind.com
Node.js-Beispiel herunterladen

Python-Beispiel: CSV-Upload

Lokale CSV-Datei per presigned URL zum API-Endpoint hochladen.

Ablauf:

  1. Presigned Upload URL von der API holen.
  2. Datei lokal einlesen.
  3. Datei per HTTP PUT zur URL hochladen.

Konfiguration:

  • Passen Sie API_key, tenant_id, datatable_id und file_path an.
Python-Beispiel herunterladen

Nächste Schritte

  • API-Referenz: Vollständige Dokumentation aller Endpunkte inkl. Request- und Response-Formate
  • GitHub Beispiele: Downloadbare Beispiele und Client-Bibliotheken
  • API-Key anfordern: Wie Sie Ihren API-Key anfordern und verwalten

Hinweis

Bei Fragen oder für Unterstützung zur API wenden Sie sich gerne an unser Kundensupport oder besuchen unsere Entwickler-Community-Foren.