Doküman Listesi
Bu Sayfada

API çağrıları

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

Bu rehber, ProcessMind servislerine API çağrısı yapmak için örnekler ve pratik ipuçları sunar. Veri çekme, bilgi gönderme veya workflow otomasyonu işlemleri için API ile etkileşimi anlamak önemlidir. Tüm endpointler, kimlik doğrulama, örnek çağrılar ve entegrasyon rehberi için API Dokümantasyonumuzu GitHub’da inceleyebilirsiniz.

Kimlik Doğrulama Değişkenleri

  • apiKey Tüm API çağrılarında API anahtarınızı başlığa eklemelisiniz. Anahtarı ProcessMind hesabınızdan alabilirsiniz.
  • tenantId Bazı endpointlerde isteğin hangi tenant ile alakalı olduğunu belirtmek için Tenant ID gereklidir. Her organizasyona özeldir ve hesap ayarlarında yer alır.
  • datatableId Dataset ile çalışırken, hangi datatable’ın kullanılacağını göstermek için Datatable ID gerekir. Bu ID’yi ProcessMind’da dataset ayarlarında [Get Data Table ID] ile görebilirsiniz.

Doğrudan Dosya Yükleme

ProcessMind, datatable’a presigned URL kullanarak dosya yüklemenizi sağlar. Böylece API anahtarı veya hassas veriler paylaşılmadan güvenli yükleme yapılır. Presigned URL’ler zamanla sınırlıdır; aldıktan sonra kısa sürede kullanılmalıdır. Doğrudan yükleme için GET endpoint’ine istek atmanız gerekir. Bu URL’yi ProcessMind içinde dataset ayarlarından [Get upload URL] seçeneğiyle alabilirsiniz. Süreyi 1 saat, 1 hafta veya 1 ay olarak ayarlayabilirsiniz.

API Endpoint Genel Bakış

MethodEndpointAçıklama
GET/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurlDatatable’a dosya yüklemek için geçici pre‑signed URL verir.
GET/tenant/{tenantId}/datasetsİlgili tenant için dataset listesini döner.
GET/tenant/{tenantId}Seçili tenant hakkında detay döner.
GET/tenant/{tenantId}/organizationTenant’ın organizasyonuna dair bilgi döner.

API Ana URL

Tüm API istekleri için ana URL: https://api.processmind.com

Pre‑signed Upload URL Nasıl Alınır?

Endpoint: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
Parametreler:

  • tenantId – Tenant ID (string).
  • datatableId – Yükleme yapılacak datatable ID’si (string).
  • apiKey – API anahtarınız (string).

Dönen Cevap:
PreSignedUploadUrl içeren bir nesne döner. Bu geçici URL ile dosya (genelde HTTP PUT ile) yükleyebilirsiniz.

Yardımcı fonksiyon örneği:

const presignedUrl = await getPresignedUploadUrl({
	apiKey,
	tenantId: "tenant-123",
	datatableId: "table-456"
});
console.log(presignedUrl); // örn. https://s3.amazonaws.com/...?

Datasetler Nasıl Listelenir?

Endpoint: GET /tenant/{tenantId}/datasets
Parametreler:

  • tenantId – Tenant ID.
  • apiKey – API anahtarı.

Dönen Sonuç:
Tenant’a ait dataset nesnelerinden oluşan bir dizi.

Örnek:

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

Tenant Detayı Nasıl Alınır?

Endpoint: GET /tenant/{tenantId}
Parametreler:

  • tenantId – Tenant ID.
  • apiKey – API anahtarı.

Dönen Sonuç:
Tenant’ın adı, oluşturulma tarihi ve plan bilgisi içeren bir nesne döner.

Örnek:

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

Organizasyon Detayı Nasıl Alınır?

Endpoint: GET /tenant/{tenantId}/organization
Parametreler:

  • tenantId – Tenant ID.
  • apiKey – API anahtarı.

Dönen Sonuç:
Tenant’a ait organizasyonun adı, adresi ve iletişim bilgileri gibi bilgiler.

Örnek:

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

Dosya Nasıl Yüklenir?

uploadFile fonksiyonu, pre-signed URL kullanarak dosya yüklemeyi gösterir. Genel akış:

  1. getPresignedUploadUrl çağrısıyla pre-signed URL alınır.
  2. Bu URL’ye PUT ile dosya içeriği gönderilir. Pre-signed URL, doğrudan depolayıcıya yüklemeye izin verir; başka bilgi gerekmez.
  3. (Opsiyonel) Backend gerektiriyorsa yükleme tamam bilgisini API’ye gönderin.

Fetch ile örnek:

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
	// 1. adım: Pre-signed URL al
	const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
	
	// 2. adım: PUT yöntemiyle dosya yükle
	await fetch(uploadUrl, {
		method: "PUT",
		headers: {
			"Content-Type": file.type
		},
		body: file
	});
	
	// 3. adım: (Opsiyonel) Yükleme bitti ise API'ye haber ver
	// (backend uygulamanıza bağlı)
}

info

  • Pre‑signed URL’ler belirli süre aktif kalır (genellikle dakikalar). Aldıktan sonra hemen kullanın.
  • Yükleme başarısızsa (örn. ağ kesilirse) tekrar yüklemek için yeni pre‑signed URL isteyin.
  • apiKey bilgisini asla client-side veya herkese açık frontend ile paylaşmayın.

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 pre-signed URL ile yükler.

Adımlar:

  1. API’dan pre-signed upload URL alın.
  2. Yerel dosyayı diskten okuyun.
  3. Pre-signed URL’ye HTTP PUT ile dosya yükleyin.

Ayarlar:

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

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

Yerel CSV dosyasını pre-signed URL ile uzak API’ya yükler.

Adımlar:

  1. API’dan pre-signed upload URL alın.
  2. Yerel dosyayı diskten okuyun.
  3. Dosyayı pre-signed 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

info

Detaylı API dokümantasyonu, endpointler, kimlik doğrulama, örnek istekler, yanıt formatları ve adım adım entegrasyon için GitHub’daki API Dokümantasyonu adresini ziyaret edin. API kullanımıyla ilgili sorularınız için destek ekibimize ulaşabilir veya geliştirici forumlarımıza katılabilirsiniz.