API genel bakışı

ProcessMind API çağrıları nasıl yapılır?

Bu rehber, veri almak, bilgi göndermek veya iş akışlarını otomatikleştirmek için ProcessMind API çağrılarının nasıl yapılacağını örnekler ve en iyi uygulamalarla açıklar.

İstek ve yanıt biçimleriyle birlikte tüm uç nokta belgeleri için API Referansına bakın.

Ek örnekler ve istemci kitaplıkları için GitHub üzerindeki API Belgelerini ziyaret edin.

API temel URLsi

Tüm API istekleri şu adrese gönderilmelidir:

https://api.processmind.com

Tüm rotalar /v1 altında sürümlendirilir. Makine tarafından okunabilen API belirtiminin tamamı, OpenAPI 3.1, şu adreste bulunur:

GET https://api.processmind.com/v1/openapi.json

Kimlik doğrulama

Tüm API isteklerinde x-api-key üst bilgisinde API anahtarınız bulunmalıdır:

x-api-key: your-api-key-here

API anahtarınızı ProcessMind hesap ayarlarınızdan alabilirsiniz. Talimatlar için API anahtarınızı alma bölümüne bakın.

Durum kodları

ProcessMind API, standart HTTP durum kodlarını izler:

Temel kavramlar

• apiKey: Tüm API istekleri için kimlik doğrulama belirtecinizdir.
• tenantId: Çalışma alanı veya kuruluş bağlamınızı tanımlar. Hesap ayarlarınızda bulunur.
• datatableId: Veri işlemleri için belirli bir veri tablosunu tanımlar. ProcessMind içindeki Veri Seti ayarları menüsünde bulunan Veri Tablosu Kimliğini Al seçeneğinden erişilebilir.

Yapabilecekleriniz

ProcessMind API şunları yapmanızı sağlar:

• Kiracıları yönetin: Kiracı bilgilerini alın, ayarları güncelleyin ve istatistikleri görüntüleyin
• Kullanıcıları yönetin: Kiracılara ve kuruluşlara kullanıcı ekleyin, kullanıcıları güncelleyin veya kaldırın
• Süreçleri yönetin: Süreçler oluşturun, BPMN modelleri yükleyin ve klasörlerde düzenleyin
• Verileri bağlayın: Analiz için veri tablolarını süreçlerle eşleyin
• Veri yükleyin: CSV/XLSX dosyalarını doğrudan veri tablolarına yükleyin
• Veri Setlerini yönetin: Veri Setlerini ve veri tablolarını listeleyin, inceleyin ve silin

Yaygın örnekler

Aşağıda, ProcessMind API ile yaygın işlemlerin nasıl gerçekleştirileceğini gösteren pratik örnekler yer alır.

İmzalı yükleme URLsi alma

Bir dosyayı veri tablosuna yüklemek için önce imzalı 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=…

Veri Setlerini listeleme

Kiracınızdaki tüm Veri Setlerini alın:

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

Kiracı bilgilerini alma

Kiracınızla ilgili ayrıntıları alın:

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

Süreç oluşturma

Kiracınızda yeni bir süreç 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 modeli 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
});

Verileri bir süreçle eşleme

Analiz için bir veri tablosunu sürece bağlayın:

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

Kiracıya kullanıcı ekleme

Kiracınıza bir kullanıcı ekleyin:

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

Not: Gövdedeki rol alanları (isAdminInTenant, access, isDashboardViewer) olduğu gibi dikkate alınır. Kullanıcı yönetimi uç noktaları tam kapsamlı tenant yöneticisi işlevleri sunar. Bu nedenle yalnızca yönetim yetkisi vereceğiniz kişilere yazma kapsamlı API anahtarları sağlayın. System API tarafından davet e-postası gönderilmez. Kullanıcıyı sisteme dahil etme sürecinden siz sorumlusunuz.

Dosya yükleme

ProcessMind’e dosya yüklemek için genel akış şöyledir:

1. İmzalı bir URL almak için getPresignedUploadUrl çağrısını kullanın.
2. Dosya içeriğiyle bu URLye PUT isteği gönderin.
3. İmzalı URL, yüklemeyi doğrudan bulut depolamaya yetkilendirir; ek kimlik bilgileri gerekmez.

Aşağıda fetch kullanılarak hazırlanmış basitleştirilmiş bir örnek yer alır:

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

Eksiksiz örnekler

Aşağıda farklı dillerde, eksiksiz ve kopyalanıp yapıştırılmaya hazır örnekler yer alır.

Bash örneği: Dosya yükleme

Tüm değerler için yer tutucular içeren, ProcessMind’e iki curl çağrısıyla dosya yükleyen minimal Bash betiği

#!/bin/bash
# Minimal Bash script to upload a file to ProcessMind using two curl calls, with placeholders for all values

# Replace the following placeholders with your actual values:
# <API_KEY>, <TENANT_ID>, <DATATABLE_ID>, <FILE_PATH>

curl -s -H "x-api-key: <API_KEY>" \
	"https://api.processmind.com/v1/tenant/<TENANT_ID>/datatables/<DATATABLE_ID>/uploads/presigned-url" \
	| grep -oP '"PreSignedUploadUrl"\s*:\s*"\K[^"]+' \
	| xargs -I {} curl -s -X PUT --upload-file "<FILE_PATH>" "{}"

Node.js örneği: Yerel CSV dosyası yükleme

İmzalı URL kullanarak yerel bir CSV dosyasını ProcessMind’e yükler.

Adımlar:

1. API’den imzalı bir yükleme URLsi alın.
2. Yerel dosyayı diskten okuyun.
3. HTTP PUT kullanarak dosyayı imzalı URLye yükleyin.

Yapılandırma:

• uploadFile() çağrısını yaparken API anahtarınızı, tenantId, datatableId ve filePath bilgilerini sağlayın.
• API temel URLsi https://api.processmind.com olarak ayarlanmıştır.

/**
 * Uploads a local CSV file to ProcessMind using a presigned URL.
 *
 * Steps:
 * 1. Fetch a presigned upload URL from the API.
 * 2. Read the local file from disk.
 * 3. Upload the file to the presigned URL using HTTP PUT.
 *
 * Configuration:
 * - Provide your API key, tenantId, datatableId, and filePath when calling uploadFile().
 * - The API base URL is set to https://api.processmind.com
 */

const fs = require("node:fs");

/**
 * Uploads a file to ProcessMind datatable using a presigned URL.
 * @param {string} apiKey - Your API key for authentication.
 * @param {string} tenantId - Your tenant identifier.
 * @param {string} datatableId - Your datatable identifier.
 * @param {string} filePath - Path to the file to upload.
 */

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(`Error loading from API: ${response.status}, ${response.statusText}: ${body.message}`);
            return;
        }
        return body;
    } catch (err) {
        console.error("Unexpected error:", err);
    }
}

async function getPresignedUploadUrl({apiKey, tenantId, datatableId, apiUrl = "https://api.processmind.com"}) {
	return (await getApi({apiKey, path: `/v1/tenant/${tenantId}/datatables/${datatableId}/uploads/presigned-url`, apiUrl})).PreSignedUploadUrl;
}

async function getDatasets({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/v1/tenant/${tenantId}/datasets`, apiUrl});
}

async function getTenant({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/v1/tenant/${tenantId}`, apiUrl});
}

async function getOrganization({apiKey, tenantId, apiUrl = "https://api.processmind.com"}) {
	return await getApi({apiKey, path: `/v1/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("Uploading file...");
        fs.readFile(filePath, async (err, data) => {
            if (err) {
                console.error("Error reading file:", err);
                return;
            }
            try {
                const uploadRes = await fetch(uploadUrl, {
                    method: "PUT",
                    body: data
                });
                if (!uploadRes.ok) {
                    console.error("Upload failed:", uploadRes.status, uploadRes.statusText);
                } else {
                    console.log("File uploaded successfully.");
                }
            } catch (uploadErr) {
                console.error("Error uploading file:", uploadErr);
            }
        });
    } catch (err) {
        console.error("Unexpected error:", err);
    }
}

// Export the function for use in other modules
module.exports = { 
	getPresignedUploadUrl,
	getDatasets,
	getTenant,
	getOrganization,
	uploadFile 
};

Python örneği: Yerel CSV dosyası yükleme

İmzalı URL kullanarak yerel bir CSV dosyasını uzak bir API’ye yükler.

Adımlar:

1. API’den imzalı bir yükleme URLsi alın.
2. Yerel dosyayı diskten okuyun.
3. HTTP PUT kullanarak dosyayı imzalı URLye yükleyin.

Yapılandırma:

• api_key, tenant_id, datatable_id ve file_path değerlerini ihtiyacınıza göre güncelleyin.

"""
Uploads a local CSV file to a remote API using a presigned URL.

Steps:
1. Fetch a presigned upload URL from the API.
2. Read the local file from disk.
3. Upload the file to the presigned URL using HTTP PUT.

Configuration:
- Update api_key, tenant_id, datatable_id, file_path as needed.
"""

import requests

# === Configuration ===
api_key = ""  # API key for authentication
tenant_id = ""  # Tenant identifier
datatable_id = ""  # Datatable identifier
file_path = ""  # Path to the file to upload


print("Fetching upload URL...")
api_url = "https://api.processmind.com"  # Base API URL
presign_url = f"{api_url}/v1/tenant/{tenant_id}/datatables/{datatable_id}/uploads/presigned-url"
presign_res = requests.get(presign_url, headers={"x-api-key": api_key})
if not presign_res.ok:
	print(f"Error fetching 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("No presigned upload URL returned.")
	exit(1)

print("Uploading file...")
with open(file_path, "rb") as f:
	upload_res = requests.put(upload_url, data=f)
if not upload_res.ok:
	print(f"Upload failed: {upload_res.status_code}, {upload_res.reason}")
else:
	print("File uploaded successfully.")

Sayfalama

Liste uç noktaları limit ve offset sorgu parametrelerini kabul eder ve yalın bir JSON dizisi döndürür, kapsayıcı veya toplam sayı içermez:

GET /v1/tenant/{tenantId}/processes?limit=50&offset=100

Tüm sayfalara erişmek için offset += limit ile istek göndermeye devam edin; yanıt dizisi, istenen limit değerinden kısa veya boş olana kadar bunu sürdürün. Maksimum değerin üzerindeki değerler 400 ile reddedilir. Sürümlendirilmiş veri uç noktaları, Veri Setleri, veri tabloları, sürümler ve web kancaları, aynı kuralı izler.

Sürüm oluşturma ve kullanımdan kaldırma

• Tüm rotalar /v1 altında sürümlendirilir; geriye dönük uyumsuz değişiklikler /v1 sessizce değiştirilmek yerine yeni bir sürümde yayımlanır.
• Kullanımdan kaldırma duyuruları, bir rota kaldırılmadan en az 6 ay önce değişiklik günlüğünde ve bu sayfada yayımlanır; kullanımdan kaldırılan rotalar bu süre boyunca çalışmaya devam eder.
• Kullanımdan kaldırılan rotaların yanıtlarında kaldırılma tarihini belirten bir Sunset üst bilgisi ve Deprecation: true bulunur.
• İstemcileri etkileyen önemli değişiklikler her zaman değişiklik günlüğünde listelenir. Sabitlenmiş API istemcilerini yükseltmeden önce abone olun veya güncellemeleri kontrol edin.

Sonraki adımlar

• API Referansı: İstek ve yanıt biçimleriyle birlikte tüm uç noktaların eksiksiz belgeleri
• GitHub örnekleri: İndirilebilir örnekler ve istemci kitaplıkları
• API anahtarınızı alma: API anahtarınızı alma ve yönetme