parampos-nodejs-sdk

Bu depo, PARAMPOS Node.js istemcisi için (yerel) bir çatı örneğidir — PARAMPOS API'leri ile iletişim kurmak için hazırlanmış bir örnek proje yapısı ve yardımcı kodlar içerir.

Resmi PARAMPOS Node.js istemcisi: https://github.com/PARAMPOS/nodejs-client

Kapsam:

• src/ : Uygulama kodları (controller, service, types ve config örnekleri).
• example_code/ : Hızlı örnekler ve script'ler.
• test.js : Basit çalıştırma/snippet örneği.

Önemli: Bu repo PARAMPOS tarafından sağlanan resmi paketin örnek bir çalışma dizinini temel alır. Resmi repodaki güncellemeleri ve dokümantasyonu takip etmeniz önerilir.

Hızlı Başlangıç

1. Bağımlılıkları yükleyin:

npm install

2. Konfigürasyon:

• Konfigürasyon örnekleri src/configs/index.js içinde yer alır. Gerçek ortamda kullanmadan önce parametreleri (API anahtarı, terminal bilgileri, endpoint URL'leri vb.) kendi bilgilerinize göre güncelleyin.
• Geliştirme sırasında çevresel değişkenleri kullanmak isterseniz, proje köküne .env dosyası ekleyip process.env üzerinden erişim sağlayabilirsiniz.

3. Örnek çalıştırma:

node test.js

Veya özel bir örneği çalıştırmak için example_code/ içindeki script'lerden birini çalıştırabilirsiniz:

node example_code/odeme.js

Kullanım / API

Bu proje modüler bir yapı içerir:

• src/controllers/ : HTTP veya CLI arayüzü ile kullanılabilecek controller fonksiyonları.
• src/services/ : PARAMPOS API'sine istek atan servis katmanı. Her controller gerekli servisleri çağırır.
• src/types/models/ : İstek/yanıt için model tanımları (veri biçimleri).
• src/configs/ : API anahtarları, endpointler ve ortak konfigürasyon.

Basit bir kullanım örneği (örn. ödeme işlemi çağrısı):

// örnek: src/index.js veya kendi script'inizde
const OdemeService = require('./src/services/OdemeService');

async function runPayment() {
	const payload = {
		amount: 1000,
		currency: 'TRY',
		cardNumber: '4111111111111111',
		expiryMonth: '12',
		expiryYear: '25',
		cvv: '000'
	};

	try {
		const result = await OdemeService.createPayment(payload);
		console.log('İşlem sonucu:', result);
	} catch (err) {
		console.error('Hata:', err);
	}
}

runPayment();

Not: Yukarıdaki kod, sadece örnek amaçlıdır — OdemeService içindeki doğru metod isimlerini ve parametreleri src/services/OdemeService.js dosyasından kontrol edin.

Geliştirme İpuçları

• Yeni bir endpoint eklerken önce types/models içine model ekleyin, sonra services içinde API çağrısını yazın, en son controllers içine bir arayüz ekleyin.
• Servislerin test edilebilmesi için HTTP çağrılarını izole eden küçük mock'lar veya sanal istemciler kullanın.

Testler

Bu depo örnek script'ler içerir; kapsamlı bir test altyapısı bulunmamaktadır. Jest veya Mocha ile birim testleri eklemek isterseniz:

npm install --save-dev mocha chai
npx mocha

Katkıda Bulunma

İyileştirme, hata düzeltme veya eksik dokümantasyon için PR gönderebilirsiniz. Değişikliklerinizin açık ve küçük parçalara bölünmüş olmasına dikkat edin.

Kaynaklar

• Resmi PARAMPOS Node.js istemcisi: https://github.com/PARAMPOS/nodejs-client
• Bu repo içindeki example_code/ klasörü: hızlı kullanım örnekleri ve senaryolar.