API-Dokumentation ProcessMind
ProcessMind API-Referenz: Endpoints, Authentifizierung und Integration für Entwickler.
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.
Alle API-Requests richten Sie bitte an:
https://api.processmind.com 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.
Mit der ProcessMind API können Sie:
Hier finden Sie praxisnahe Beispiele für typische Anwendungsfälle mit der ProcessMind API.
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=… Listeen Sie alle Datensets in Ihrem Tenant auf:
const Datensatzs = await getDatensets({
APIKey,
tenantId: "tenant-123"
});
console.log(Datensatzs); Rufen Sie Informationen zu Ihrem Tenant ab:
const tenantInfo = await getTenant({
APIKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); 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 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
}); 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
}); 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
}); So funktioniert der Datei-Upload zu ProcessMind im Überblick:
getPresignedUploadUrl-Call ab.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
Nachfolgend finden Sie vollständige, direkt nutzbare Beispiele in verschiedenen Programmiersprachen.
Mini-Bash-Script zum Datei-Upload nach ProcessMind mit zwei curl-Calls. Platzhalter ersetzen.
Upload einer lokalen CSV-Datei per presigned URL zu ProcessMind.
Ablauf:
Konfiguration:
https://API.processmind.comLokale CSV-Datei per presigned URL zum API-Endpoint hochladen.
Ablauf:
Konfiguration:
Hinweis
Bei Fragen oder für Unterstützung zur API wenden Sie sich gerne an unser Kundensupport oder besuchen unsere Entwickler-Community-Foren.
Wir verwenden Cookies, um Ihr Nutzungserlebnis zu verbessern, personalisierte Inhalte anzuzeigen und die Nutzung unserer Website zu analysierenn. Mit Klick auf "Alle akzeptieren" stimmen Sie dem Einsatz von Cookies zu.