Bu Sayfada

API Genel Bakış

ProcessMind API Çağrıları Nasıl Yapılır?

Bu rehber, ProcessMind servislerine API çağrısı yapmak için örnekler ve en iyi uygulamaları sunar. Veri ç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 Referansı bölümünde bulabilirsiniz.

Daha fazla örnek ve istemci kütüphaneleri için GitHub’daki API Dokümantasyonu adresini ziyaret edebilirsiniz.

API Ana Adresi

Tüm API istekleri şu adrese yapılmalıdır:

https://api.processmind.com

Kimlik Doğrulama

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.

Temel Kavramlar

  • apiKey – Tüm API işlemleri için kimlik anahtarınız.
  • tenantId – Çalışanşma alanı/organizasyonunuzu tanımlar. Hesap ayarlarında bulunur.
  • datatableId – Belirli bir datatable’ı tanımlar. ProcessMind üzerinde dataset ayarlarında [Get Data Table ID] ile alınabilir.

Neler Yapabilirsiniz?

ProcessMind API ile şunları yapabilirsiniz:

  • Tenant Yönetimi – Tenant bilgilerini görüntüleme, ayar güncelleme, istatistikleri görme
  • Kullanıcı Yönetimi – Tenant veya organizasyona kullanıcı ekleme, güncelleme ve kaldırma
  • Süreç Yönetimi – Süreç oluşturma, BPMN model yükleme, klasör ile düzenleme
  • Veri Bağlama – Analiz için datatable’ı process’e eşleştirme
  • Veri Yükleme – CSV/XLSX dosyalarını doğrudan datatable’a yükleme
  • Dataset Yönetimi – Dataset ve datatable’ı listeleme, inceleme ve silme

Sık Kullanılan Örnekler:::::::

Aşağıda, ProcessMind API ile yaygın işlemleri nasıl yapabileceğinizi gösteren pratik örnekler bulabilirsiniz.

Presigned Yükleme URL’si Alma

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=…

Verisetleri Listeleme

Tenant’ınızdaki tüm dataset’leri alın:

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

Tenant Bilgisi Alma

Tenant’ınızla ilgili bilgileri alın:

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

Process Oluşturma

Tenant’ınızda yeni bir process oluşturun:

const process = await createProcess({
	apiKey,
	tenantId: "tenant-123",
	displayName: "Order to Cash"
});
console.log(process.id); // Use this ID for subsequent operations

BPMN Model Yükleme

Süreç 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
});

Veri ile Process Eşleştirme

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’a Kullanıcı Ekleme

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
});

Dosya Yükleme

ProcessMind platformuna dosya yükleme adımları:

  1. getPresignedUploadUrl ile presigned URL alın.
  2. Bu URL’ye PUT isteğiyle dosya içeriğini yükleyin.
  3. Presigned URL ile doğrudan bulut depolamaya yükleme yetkisi sağlanır – ek kimlik doğrulamaya gerek yoktur.

fetch ile basit bir örnek:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// Step 1: Obtain a presigned URL
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// Step 2: Upload the file via PUT
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
}

info

  • Presigned URL’ler belirli bir süre (genellikle birkaç dakika) geçerlidir. Aldıktan sonra hemen kullanın.
  • Yükleme başarısız olursa (ör. ağ kesilirse), tekrar denemeden önce yeni bir presigned URL alın.
  • apiKey’inizi daima güvenli tutun ve istemci tarafında (ör. açık front‑end) paylaşmayın.

Tam Detaylı Örnekler:::::::

Farklı programlama dilleri için kopyala-yapıştır hazır eksiksiz örnekler aşağıda.

Bash Örneği: Dosya Yükleme

Tüm değerler için parametreli, iki curl komutuyla dosya yüklemeyi gösteren minimal Bash scripti.

BASH Örneğini İndir

Node.js Örneği: Yerel CSV Dosyası Yükleme

Yerel CSV dosyasını ProcessMind’a presigned URL ile yükler.

Adımlar:

  1. API’dan presigned upload URL alın.
  2. Yerel dosyayı diskten okuyun.
  3. Dosyayı presigned URL’ye HTTP PUT ile yükleyin.

Ayarlar:

  • uploadFileToProcessMind() çağrılırken API anahtarı, tenantId, datatableId ve filePath girilmelidir.
  • API ana URL: https://api.processmind.com
Node.js Örneğini İndir

Python Örneği: Yerel CSV Dosyası Yükleme

Yerel CSV dosyasını presigned URL ile uzak API’ya yükler.

Adımlar:

  1. API’dan presigned upload URL alın.
  2. Yerel dosyayı diskten okuyun.
  3. Dosyayı presigned URL’ye HTTP PUT ile yükleyin.

Ayarlar:

  • api_key, tenant_id, datatable_id ve file_path değerlerini güncelleyin.
Python Örneğini İndir

Sonraki Adımlar

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.