Mikro API, Mikro Yazılım tarafından 3rd Party yazılım uygulamaları ile haberleşmeyi sağlayan, veri bütünlüğünü koruyan, akıllı kontrol sistemleriyle desteklenen bir hizmettir.
REST mimarisi kullanılarak geliştirilmiştir. Veri alışverişi JSON formatında gerçekleşir.
JSON, veri alışverişinde kullanılan, XML'e göre daha sade bir veri formatıdır.
REST, HTTP protokolünü kullanır. Veriler URL’ler üzerinden aktarılır. JSON kullanılır.
GET
: Veri görüntülemePOST
: Veri eklemeDELETE
: Veri silmePATCH
: Kısmi güncelleme
Kod | Anlamı |
---|---|
200 | OK |
201 | Created |
204 | No Content |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
429 | Too Many Requests |
API test ve entegrasyonu için kullanılan bir istemcidir.
Setup dosyası ile API servisi otomatik kurulur. Hizmetler > Mikro API servisi çalışıyor olmalıdır.
Postman collection dosyası ile alınabilir. API Başvuru Formu
Örnek istek:
POST http://mikro-api.com:8084/API/APIMethods/CariKaydetV2
{
"Mikro": {
"Sifre": "2023-03-09 123asd → MD5",
"KullaniciKodu": "SRV",
"FirmaKodu": "TESTDB",
"ApiKey": "xxxxxxxxxxxx",
"CalismaYili": "2023"
}
}
Tarih + Şifre → MD5 Hash
Örn: 2023-03-09 123asd → MD5
- v17 için: 8094
- v16 için: 8084
Yeni alanlar geldikçe versiyonlar güncellenir (örneğin V1
, V2
).
API local sunucuda çalışır. Active-Active desteklemez.
API JSON'da olmayan tablo alanları da doğrudan DB isimleriyle kullanılabilir.
API Eğitim Sertifikaları üzerinden erişilebilir.
Demo setup ile 100 kayda kadar test edilebilir. Ayrıca lisanslı kullanıcılar için test DB açılabilir.
Postman'da mevcut olan endpoint’ler için kullanılabilir. Yeni tablo talepleri için: API Başvuru Formu
API servisi bir Windows servisi olduğu için gerekli yönlendirmeler sistem yöneticileri tarafından yapılmalıdır.
API Key lisansı:
- Dikey çözüm kullananlara otomatik atanır.
- Şirket içi yazılımlar için manuel lisans verilir.
Yanlış API Key ile istek yapılırsa "Geçersiz api key"
hatası döner.
Alan | Açıklama |
---|---|
ath_Guid | Uniqueidentifier |
ath_DBCno | Smallint |
ath_create_user | Kullanıcı Kodu |
ath_checksum | Integer |
... | ... |
Bu doküman, Mikro Yazılım API altyapısına entegrasyon sürecinde sık sorulan soruları kapsamaktadır.