Mikro ERP API Dokümantasyonu
Mikro ERP sistemini kendi uygulamalarınıza entegre edin. REST API ile güvenli ve hızlı entegrasyon sağlayın.
Başlangıç
Mikro ERP API'si, REST mimarisi üzerine kurulu bir web servistir. API'yi kullanmaya başlamadan önce aşağıdaki gereksinimleri sağladığınızdan emin olun:
- Mikro ERP V17 veya üzeri sürüm
- API erişim anahtarı (ApiKey)
- Kullanıcı kimlik bilgileri
Oturum Yönetimi
API oturumlarını yönetmek için kullanabileceğiniz endpoint'ler:
/Api/APIMethods/APILogin
API oturumu başlatır.
{
"FirmaKodu": "MIKROFLY",
"CalismaYili": "2024",
"ApiKey": "your-api-key",
"KullaniciKodu": "SRV",
"Sifre": "your-password",
"FirmaNo": 0,
"SubeNo": 0
}
/Api/APIMethods/APILogin
Mikro API servisini başlatır.
{
"FirmaKodu": "V16XX",
"CalismaYili": "2023",
"KullaniciKodu": "SRV",
"Sifre": "",
"FirmaNo": 0,
"SubeNo": 0
}
/Api/APIMethods/LoggerDone
Logger durumunu kontrol eder.
/Api/APIMethods/HealthCheck
API servisinin sağlık durumunu kontrol eder.
/Api/APIMethods/HealthCheck2
Detaylı sağlık durumu kontrolü yapar.
/Api/apiMethods/APILogoff
API oturumunu sonlandırır.
{
"KullaniciKodu": "SRV"
}
/Api/apiMethods/APILogoffV2
Gelişmiş oturum sonlandırma (V2).
{
"Mikro": {
"FirmaKodu": "V16XX",
"CalismaYili": "2023",
"KullaniciKodu": "SRV",
"Sifre": ""
},
"KullaniciKodu": "1"
}
Stok İşlemleri
Stok yönetimi için kullanabileceğiniz endpoint'ler:
/Api/APIMethods/StokListesiV2
Stok listesini sorgular ve filtreler.
{
"Mikro": {
"FirmaKodu": "MIKROFLY",
"CalismaYili": "2024",
"KullaniciKodu": "SRV",
"Sifre": "your-password"
},
"StokKod": "",
"TarihTipi": 2,
"IlkTarih": "2023-01-01",
"SonTarih": "2023-12-01",
"Sort": "-sto_kod",
"Size": "5"
}
Cari Hesap İşlemleri
Cari hesap yönetimi için kullanabileceğiniz endpoint'ler:
/api/APIMethods/CariBorcAlacakEslemeKaydetV2
Cari hesap borç/alacak eşleştirmelerini kaydeder.
{
"Mikro": {
"FirmaKodu": "MIKROFLY",
"CalismaYili": "2024",
"KullaniciKodu": "SRV",
"Sifre": "your-password"
},
"satirlar": [
{
"chk_Guid": "unique-guid",
"chk_Borc_uid": "borc-uid",
"chk_Borcvade": "01.04.2024",
"chk_Tutar": 100000,
"chk_Alc_uid": "alacak-uid",
"chk_Alacakvade": "04.04.2024",
"chk_Aciklama1": "",
"chk_Aciklama2": "",
"chk_OrjBorcTutar": 300000,
"chk_OrjAlacakTutar": 250000
}
]
}
/api/APIMethods/CariBorcAlacakEslemeGuidSilV2
Cari hesap borç/alacak eşleştirmelerini siler.
{
"Mikro": {
"FirmaKodu": "MIKROFLY",
"CalismaYili": 2024,
"KullaniciKodu": "SRV",
"Sifre": "your-password"
},
"satirlar": [
{
"chk_Guid": "77f606d1-1367-4238-b6c0-43342441df57"
},
{
"chk_Guid": "78f606d1-1367-4238-b6c0-43342441df57"
}
]
}
Sipariş İşlemleri
Sipariş yönetimi için kullanabileceğiniz endpoint'ler:
/api/APIMethods/Deneme
Yeni sipariş kaydı oluşturur.
{
"WorkingYear": 2024,
"CompanyAlias": "XLLE-4253",
"evraklar": [
{
"fatura_aciklama": "deneme",
"cari": {
"cari_Guid": "C9C2E898-98E7-4201-BB0A-BBFDDB44290F",
"cari_unvan1": "AAA ambalaj",
"cari_vdaire_no": "11111111111",
"cari_vdaire_adi": "TAŞOVA VERGİ DAİRESİ",
"cari_doviz_cinsi1": 0,
"cari_KurHesapSekli": 1,
"cari_sevk_adres_no": 1,
"cari_fatura_adres_no": 1,
"adres": {
"adr_Guid": "CAC2E898-98E7-4201-BB0A-BBFDDB44290F",
"adr_cadde": "cadde",
"adr_mahalle": "mahalle",
"adr_sokak": "sokak",
"adr_Semt": "semt",
"adr_Apt_No": "A1",
"adr_Daire_No": "2",
"adr_posta_kodu": "34340",
"adr_ilce": "Sarıyer",
"adr_il": "İstanbul",
"adr_ulke": "Türkiye"
}
},
"satirlar": [
{
"sip_tarih": "26.01.2021",
"sip_teslim_tarih": "28.01.2021",
"sip_tip": 0,
"sip_cins": 0,
"sip_evrakno_seri": "S",
"sip_b_fiyat": 15,
"sip_miktar": 100.0,
"sip_birim_pntr": 1,
"sip_tutar": 1500,
"sip_depono": 1,
"sip_vergisiz_fl": false,
"kdv_istisna_kodu": "",
"shopside_fl": true,
"sip_kanali": "hepsiburada",
"stok": {
"sto_Guid": "CBC2E898-98E7-4201-BB0A-BBFDDB44290F",
"sto_isim": "shopside test",
"sto_kisa_ismi": "",
"sto_cins": 4,
"sto_doviz_cinsi": 0,
"sto_birim1_ad": "ADET",
"sto_perakende_vergi": 4
}
}
]
}
]
}
API Kullanım Örnekleri
Stok Yönetimi
Stok sorgulama ve listeleme örneği.
// Stok listesi sorgulama
async function getStockList() {
const response = await fetch('/Api/APIMethods/StokListesiV2', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
Mikro: {
FirmaKodu: "MIKROFLY",
CalismaYili: "2024",
KullaniciKodu: "SRV",
Sifre: "your-password"
},
StokKod: "",
TarihTipi: 2,
IlkTarih: "2024-01-01",
SonTarih: "2024-12-31"
})
});
return await response.json();
}
Cari İşlemler
Borç/Alacak eşleştirme örneği.
// Borç/Alacak eşleştirme
async function matchDebtCredit(debtData) {
const response = await fetch('/api/APIMethods/CariBorcAlacakEslemeKaydetV2', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
Mikro: {
FirmaKodu: "MIKROFLY",
CalismaYili: "2024",
KullaniciKodu: "SRV",
Sifre: "your-password"
},
satirlar: [debtData]
})
});
return await response.json();
}
Sipariş İşlemleri
Yeni sipariş oluşturma örneği.
// Sipariş oluşturma
async function createOrder(orderData) {
const response = await fetch('/api/APIMethods/Deneme', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
WorkingYear: 2024,
CompanyAlias: "XLLE-4253",
evraklar: [orderData]
})
});
return await response.json();
}
API Güvenliği
API güvenliği için dikkat edilmesi gereken noktalar:
- Her istek için kimlik doğrulama gereklidir
- API anahtarınızı güvenli bir şekilde saklayın
- Oturum süreleri sınırlıdır, gerektiğinde yenileme yapın
- İşlemler bittiğinde mutlaka oturumu kapatın
İstek Limitleri
API kullanımında dikkat edilmesi gereken limitler:
| İşlem | Limit | Periyot |
|---|---|---|
| Kimlik Doğrulama | 100 | Saat başı |
| Stok Listesi | 1000 | Günlük |
| Cari İşlemler | 5000 | Günlük |
Örnek Uygulamalar
E-Ticaret Entegrasyonu
Stok ve sipariş yönetimi için örnek e-ticaret entegrasyonu.
// Stok kontrolü
async function checkStock(productId) {
const response = await fetch('/Api/APIMethods/StokListesiV2', {
method: 'POST',
body: JSON.stringify({
Mikro: {
FirmaKodu: "MIKROFLY",
// ... diğer kimlik bilgileri
},
StokKod: productId
})
});
return await response.json();
}
Muhasebe Entegrasyonu
Cari hesap işlemleri için örnek muhasebe entegrasyonu.
// Borç/Alacak eşleştirme
async function matchDebtCredit(data) {
const response = await fetch('/api/APIMethods/CariBorcAlacakEslemeKaydetV2', {
method: 'POST',
body: JSON.stringify({
Mikro: {
FirmaKodu: "MIKROFLY",
// ... diğer kimlik bilgileri
},
satirlar: [data]
})
});
return await response.json();
}
API Entegrasyonu için Destek Alın
Mikro ERP API entegrasyonu konusunda uzman ekibimizden destek alın.