API Dokümantasyonu
ProcessMind için API referansı: endpoint, authentication ve entegrasyon rehberleri.
Bu rehber, ProcessMind servislerine API çağrısı yapmak için örnekler ve en iyi uygulamaları sunar. Data çekmek, bilgi göndermek veya workflow otomasyonu yapmak istiyorsanız, API ile nasıl etkileşim kuracağınızı bilmek önemlidir.
Tüm endpoint’lerin dokümantasyonu ve istek/yanıt formatlarını API Reference bölümünde bulabilirsiniz.
Daha fazla örnek ve client kütüphaneleri için API Documentation on GitHub adresini ziyaret edebilirsiniz.
Tüm API istekleri şu adrese yapılmalıdır:
https://api.processmind.com Tüm API isteklerinde x-api-key header’ında API anahtarınız olmalı:
x-api-key: your-api-key-here API anahtarınızı ProcessMind hesap ayarlarından alabilirsiniz. Talimatlar için API Anahtarınızı Almak sayfasına bakabilirsiniz.
ProcessMind API ile şunları yapabilirsiniz:
Aşağıda, ProcessMind API ile yaygın işlemleri nasıl yapabileceğinizi gösteren pratik örnekler bulabilirsiniz.
Bir datatable’a dosya yüklemek için önce presigned bir URL alın:
const presignedUrl = await getPresignedUploadUrl({
apiKey,
tenantId: "tenant-123",
datatableId: "table-456"
});
console.log(presignedUrl); // https://s3.amazonaws.com/…?X-Amz-Signature=… Tenant’ınızdaki tüm dataset’leri alın:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); Tenant’ınızla ilgili bilgileri alın:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); Tenant’ınızda yeni bir process oluşturun:
const process = await createProcess({
apiKey,
tenantId: "tenant-123",
displayName: "Order to Cash"
});
console.log(process.id); // Bu ID'yi sonraki işlemler için kullanabilirsiniz Process modelinizi tanımlamak için bir BPMN dosyası yükleyin:
const fs = require("fs");
const bpmnXml = fs.readFileSync("./my-process.bpmn", "utf8");
await uploadBpmn({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
bpmnXml
}); Analiz için bir datatable’ı bir process’e bağlayın:
const mapping = await createProcessMapping({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
dataTableId: "datatable-789",
displayName: "Sales Data 2024",
showByDefault: true
}); Tenant’ınıza kullanıcı ekleyin:
const result = await addTenantUser({
apiKey,
tenantId: "tenant-123",
id: "user-456",
email: "colleague@example.com",
isAdminInTenant: false,
isActiveInTenant: true,
sendInvitationEmail: true
}); ProcessMind platformuna dosya yükleme adımları:
getPresignedUploadUrl ile presigned URL alın.fetch ile basit bir örnek:
async function uploadFile({ apiKey, tenantId, datatableId, file }) {
// 1. adım: Presigned URL alın
const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
// 2. adım: PUT ile dosya yükleyin
await fetch(uploadUrl, {
method: "PUT",
headers: {
"Content-Type": file.type
},
body: file
});
} info
Farklı programlama dilleri için kopyala-yapıştır hazır eksiksiz örnekler aşağıda.
Tüm değerler için parametreli, iki curl komutuyla dosya yüklemeyi gösteren minimal Bash scripti.
Yerel CSV dosyasını ProcessMind’a pre-signed URL ile yükler.
Adımlar:
Ayarlar:
https://api.processmind.comYerel CSV dosyasını pre-signed URL ile uzak API’ya yükler.
Adımlar:
Ayarlar:
info
API kullanımıyla ilgili sorularınız olursa ya da desteğe ihtiyacınız varsa, destek ekibimizle iletişime geçebilir veya geliştirici topluluğu forumlarımıza katılabilirsiniz.
Site deneyiminizi iyileştirmek, içerikleri kişiselleştirmek ve site trafiğini analiz etmek için çerezler kullanıyoruz. "Tümünü Kabul Et"e tıklayarak onay verirsiniz.