Eylül 3, 20267 görüntülenme

Mikro Api Hakkında Sık Sorulan Sorular ?

Mikro API ile iş uygulamalarınızı Mikro Yazılım verileriyle güvenli ve kontrollü biçimde konuşturabilirsiniz. Bu bölümde API’nin çalışma mantığı, bağlantı kurulumu, kimlik doğrulama, endpoint kullanımı, hata mesajları ve test süreciyle ilgili sık sorulan soruları yanıtlıyoruz.

1. Genel Bilgiler

Mikro API ne işe yarar?

Mikro API, Mikro Yazılım altyapısındaki verilerin üçüncü taraf uygulamalarla alışverişini sağlayan bir entegrasyon katmanıdır. Böylece web uygulamanız, mobil uygulamanız veya kurum içi yazılımınız; müşteri, stok, sipariş ve benzeri iş verilerini tanımlı API metotları üzerinden okuyabilir veya yetkili işlemleri gerçekleştirebilir. Kullanılabilecek işlemler, hesabınızın lisansına ve aktif endpoint kapsamına bağlıdır. 1

Mikro API hangi teknolojiyle çalışır?

Mikro API, REST yaklaşımını kullanır ve veri alışverişinde JSON formatından yararlanır. Bu yapı, farklı yazılım dilleriyle geliştirilen uygulamaların HTTP istekleri üzerinden haberleşmesine olanak tanır.

JSON nedir ve neden kullanılır?

JSON, uygulamalar arasında veri taşımak için kullanılan, insanlar tarafından okunabilir ve metin tabanlı bir veri biçimidir. API isteklerinde gönderilecek alanların ve API’den dönen yanıtın düzenli biçimde taşınmasını sağlar.

REST API nasıl çalışır?

REST API’de uygulamanız belirli bir URL’ye HTTP isteği gönderir. İstek yöntemi, gönderilen veri ve kimlik doğrulama bilgileri birlikte değerlendirilir; API de işlemin sonucunu çoğunlukla JSON formatında döndürür. Her endpoint’in beklediği alanlar ve yetkiler farklı olabileceği için ilgili metot dokümanı kontrol edilmelidir.

REST API nasıl çalışır?
REST API’de uygulamanız belirli bir URL’ye HTTP isteği gönderir. İstek yöntemi, gönderilen veri ve kimlik doğrulama bilgileri birlikte değerlendirilir; API de işlemin sonucunu çoğunlukla JSON formatında döndürür. Her endpoint’in beklediği alanlar ve yetkiler farklı olabileceği için ilgili metot dokümanı kontrol edilmelidir.

2. İstekler ve Yanıtlar

GET, POST, PATCH ve DELETE ne zaman kullanılır?

HTTP yöntemleri farklı işlem türlerini ifade eder. GET veri görüntüleme, POST yeni veri gönderme, PATCH mevcut verinin belirli alanlarını güncelleme ve DELETE veri silme amacıyla kullanılır. Ancak gerçek kullanım yetkisi endpoint’in tanımına ve Mikro API lisansınıza göre değişebilir.

Yöntem	Genel kullanım	Web sayfasında açıklama
GET	Veri okuma	Mevcut kayıtları getirir.
POST	Veri oluşturma	Yeni kayıt veya işlem gönderir.
PATCH	Kısmi güncelleme	Kaydın belirli alanlarını değiştirir.
DELETE	Silme	Yetki verilen kaydı kaldırır.

API yanıtındaki HTTP durum kodu ne anlama gelir?

HTTP durum kodu, gönderilen isteğin sonucunu hızlıca anlamanıza yardımcı olur. Örneğin ;
200 başarılı yanıtı,
201 oluşturma işleminin tamamlandığını,
204 içerik dönmeden başarılı sonucu,
400 hatalı isteği,
401 kimlik doğrulama sorununu,
403 yetki eksikliğini,
404 bulunamayan kaynağı,
429 çok sayıda isteği ifade eder.

Hata aldığımda ilk olarak neyi kontrol etmeliyim?

Öncelikle endpoint adresini, HTTP yöntemini, port bilgisini, API Key değerini, kullanıcı ve firma bilgilerini, istek gövdesindeki alan adlarını ve kullanılan Mikro sürümünü kontrol edin. Yanıt kodu 401 veya API Key ile ilgili bir hata gösteriyorsa kimlik doğrulama bilgilerini; 400 gösteriyorsa gönderilen JSON yapısını ve zorunlu alanları inceleyin. Gerçek API anahtarınızı, parolanızı veya veritabanı bilgilerinizi destek talebinde açık olarak paylaşmayın.

Postman nedir ve entegrasyon sürecinde nasıl kullanılır?

Postman, API isteklerini göndermek, istek gövdelerini denemek ve dönen yanıtları incelemek için kullanılan bir test istemcisidir. Geliştirme aşamasında endpoint’in beklediği alanları doğrulamak ve uygulama koduna geçmeden önce bağlantıyı izole biçimde test etmek için kullanılabilir.

3. Kurulum ve Bağlantı

Mikro API kurulumu nasıl yapılır?

Kaynak dokümana göre API servisi setup dosyasıyla kurulabilir. Kurulumdan sonra Windows hizmetleri bölümünde Mikro API servisinin çalışır durumda olduğu kontrol edilmelidir. Kurulum sırasında bağlantı, güvenlik duvarı, ağ yönlendirmesi ve servis hesabı ayarları kurumunuzun sistem yöneticisi tarafından doğrulanmalıdır.

Hangi portu kullanmalıyım?

Kaynak SSS sayfasında v17 için 8094, v16 için 8084 portu belirtilmektedir. Ancak port bilgisi, kurulumunuzdaki yapılandırmaya ve güncel Mikro sürümüne göre teyit edilmelidir. Web sitenizde bu bilgiyi sabit bir değer gibi sunmak yerine “Kullandığınız sürüme ve kurulum yapılandırmasına göre doğrulayınız” notunu eklemeniz daha güvenlidir.

API yerel sunucuda mı çalışır?

Kaynak dokümana göre API servisi yerel sunucuda çalışır ve Active-Active kullanımını desteklemez. Dışarıdan erişim gerekiyorsa ağ, güvenlik duvarı, SSL ve port yönlendirmeleri sistem yöneticisi tarafından güvenli biçimde planlanmalıdır.

SSL ve port yönlendirmesi neden önemlidir?

API’ye farklı bir ağdan erişilecekse bağlantının hangi adresten ve hangi port üzerinden kurulacağı belirlenmelidir. SSL kullanımı, sertifika yönetimi ve güvenlik duvarı kuralları yalnızca yazılım geliştiricinin değil, sistem ve ağ yöneticisinin de kontrol etmesi gereken konulardır. Kurulumunuzun güvenlik politikası doğrulanmadan API’yi doğrudan internete açmayın.

4. Kimlik Doğrulama Ve Lisans

API isteğinde hangi kimlik doğrulama bilgileri bulunur?

Kaynak dokümandaki örnek istekte kullanıcı kodu, firma kodu, çalışma yılı, API Key ve şifre alanları yer almaktadır. Sitenizde bu alanları gerçek bilgilerle göstermeyin; bunun yerine ORNEK_API_KEY, TEST_FIRMA ve ****** gibi maskelenmiş değerler kullanın. 1

API Key nedir?

API Key, API servisinin isteği gönderen uygulamayı tanımasına yardımcı olan lisanslama ve kimlik doğrulama bilgisidir. API Key’in nasıl temin edileceği, hesabınızın lisans türüne ve entegrasyon modelinize göre değişebilir. Kaynak SSS sayfasında dikey çözüm kullanıcıları için otomatik atama, şirket içi yazılımlar için ise manuel lisanslama bilgisi verilmektedir. 1

“Geçersiz API Key” hatasını nasıl çözebilirim?

Bu hata, istekte gönderilen API Key’in hatalı, eksik, süresi dolmuş veya ilgili ortam için yetkisiz olabileceğini gösterir. Önce anahtarın doğru ortamda kullanıldığını, başında veya sonunda boşluk bulunmadığını ve isteğin doğru JSON alanına yazıldığını kontrol edin. Sorun devam ederse anahtarı web sayfasında paylaşmadan lisans ve yetki durumunu kontrol ettirin.

Şifre formatı nasıldır?

Kaynak dokümanda şifre değerinin tarih ve parola bilgisinin birleştirilmesiyle oluşturulup MD5 hash’ine dönüştürüldüğü örneklenmektedir. Uygulamanızda bu yöntemi kullanmadan önce güncel API dokümantasyonundaki formatı teyit edin; web sayfanızda gerçek parola, gerçek hash veya üretim ortamına ait örnek kimlik bilgileri yayımlamayın.

5. Sürüm,Veri Ve Test Süreci

V1, V2 gibi API sürümleri ne anlama gelir?

API sürümleri, metotların zaman içinde güncellenebildiğini ve yeni alanların eklenebildiğini belirtir. Entegrasyon geliştirirken kullandığınız endpoint’in sürümünü sabitlemeniz, sürüm değişikliklerini takip etmeniz ve geçiş öncesinde test yapmanız önerilir.

Her tabloya veya her alana veri yazılabilir mi?

Hayır. Kullanılabilecek tablolar ve alanlar, API’de tanımlı endpoint’lere, veri modeline ve yetkilere bağlıdır. Kaynak dokümanda bazı sistem alanlarının veri girişi için kullanılamayacağı belirtilmektedir. Web sitenizde “tüm tablolara sınırsız erişim” gibi yanıltıcı ifadeler kullanmayın; desteklenen endpoint listesini güncel biçimde yayınlayın.

API’de görünmeyen tablo alanları kullanılabilir mi?

Kaynak SSS sayfasında JSON içinde bulunmayan bazı tablo alanlarının veritabanı isimleriyle kullanılabileceği belirtilmektedir. Bu konu doğrudan veritabanı yapısına ve ilgili metodun davranışına bağlı olduğundan, üretim ortamında denemeden önce endpoint dokümanını ve test ortamını kullanarak doğrulama yapılmalıdır.

Test ortamı var mı?

Kaynak dokümana göre demo setup ile 100 kayda kadar test yapılabilir; lisanslı kullanıcılar için ayrıca test veritabanı açılabileceği belirtilmektedir. Test verisiyle üretim verisini ayırın ve canlı ortama geçmeden önce okuma, ekleme, güncelleme, hata yönetimi ve yetki senaryolarını ayrı ayrı deneyin.

Hangi veriler entegre edilebilir?

Entegrasyon kapsamı, kullanılabilir endpoint’lerle sınırlıdır. Postman collection veya güncel API metot listesinde yer alan işlemler üzerinden hangi verilerin okunabildiği ya da gönderilebildiği belirlenmelidir. Yeni bir tablo veya işlem ihtiyacınız varsa, bunu ayrı bir entegrasyon talebi olarak değerlendirmeniz gerekir.

Web sayfasına uyarlama önerisi

SSS bölümünü tek uzun metin halinde vermek yerine ziyaretçinin ihtiyacına göre beş kategoriye ayırın: Genel Bilgiler, İstek ve Yanıtlar, Kurulum, Kimlik Doğrulama, Test ve Sürüm. Her soru bir akordeon bileşeninde açılabilir. Soruların başlığında teknik terimi ve kullanıcı problemini birlikte kullanmanız, örneğin “Geçersiz API Key hatasını nasıl çözerim?” biçimi, ziyaretçinin arama amacına daha iyi karşılık verir.

SSS bölümünün sonuna kısa bir yönlendirme ekleyin: “Entegrasyon kapsamınızı birlikte değerlendirelim” veya “API başvuru ve teknik destek talebi oluşturun.” Bu çağrı, ziyaretçiyi yalnızca dokümanda bırakmak yerine başvuru formuna, demo talebine veya teknik destek sayfasına yönlendirir.

Sayfa içi güvenlik notu

API Key, kullanıcı adı, şifre, firma kodu, gerçek IP adresi, port bilgisi ve üretim verisi içeren örnekleri kamuya açık sayfada göstermeyin. Kod örneği gerekiyorsa tüm gizli değerleri maskeleyin ve gerçek bağlantı adresleri yerine https://api.ornekalanadiniz.com gibi örnek alan adları kullanın.

Önerilen SEO alanları

Alan	Öneri
SEO başlığı	Mikro API Entegrasyonu: Kurulum, API Key ve SSS
Meta açıklaması	Mikro API entegrasyonu hakkında REST, JSON, API Key, endpoint, port, test ortamı ve hata kodlarıyla ilgili sık sorulan sorular.
H1	Mikro API Entegrasyonu Hakkında Sık Sorulan Sorular
URL	/mikro-api-sss
Anahtar ifadeler	Mikro API entegrasyonu, Mikro API Key, Mikro REST API, Mikro API endpoint, Mikro API kurulumu

Yayın öncesi kontrol tablosu

Kontrol	Yapılacak işlem
Teknik güncellik	Sürüm, port, şifreleme ve lisans bilgilerini güncel dokümanla karşılaştırın.
Marka uyarlaması	“Kaynak doküman” ifadelerini kendi şirketinizin destek ve hizmet kapsamına göre değiştirin.
Güvenlik	Gerçek anahtar, parola, IP, firma ve veritabanı bilgilerini kaldırın.
Kapsam	Desteklemediğiniz endpoint veya işlem türlerini kesin vaat gibi yazmayın.
Kullanıcı yönlendirmesi	Her kategori sonunda destek, demo veya başvuru bağlantısı verin.
Güncelleme tarihi	Sayfanın en altında “Son güncelleme” tarihini gösterin.