Ana içeriğe geç

Servisler Hakkında

eKüpsoft Bilişim Teknolojileri A.Ş olarak, yazılım geliştirme süreçlerini hızlandırmak ve verimliliği artırmak amacıyla çeşitli servisler sunmaktayız. Bu servisler, projelerinizi daha hızlı ve etkili bir şekilde yönetmenize yardımcı olur.

eKüpsoft Bilişim Teknolojileri A.Ş. güncel teknolojileri takip ederek, yazılım geliştirme süreçlerinizi optimize etmek için sürekli olarak yeni araçlar ve yöntemler geliştirmektedir. Amacımız, müşterilerimize en iyi hizmeti sunmak ve projelerinin başarısını sağlamaktır.

Bu sebepten dolayı servislerimiz;

  • Restful API servisleri
  • Bearer token tabanlı kimlik doğrulama
  • HTTP Durum kodları ile uyumlu
  • Merkezi hata yönetimi

gibi bir çok standart özellikleri barındırmaktadır. Ayrıca, servislerimiz, kullanıcı dostu arayüzler ve kapsamlı dokümantasyon ile desteklenmektedir.

Entegrasyon Önerileri​

Servislere istek göndermeye başlamadan önce bilinmesi gereken bazı önemli noktalar bulunmaktadır:

İstek üst bilgileri (headers) ve istek gövdesi (body) gibi parametrelerin doğru bir şekilde ayarlanması gerekmektedir. Bu parametreler, servislerin doğru bir şekilde çalışabilmesi için kritik öneme sahiptir.

  • Body parametreleri her zaman JSON formatında olmalıdır. Bu, servislerin veri alışverişini daha verimli ve anlaşılır hale getirir.
  • HTTP üst bilgisinde (headers) Content-Type ve Accept değerlerinin application/json olarak ayarlanması gerekmektedir. Bu, servislerin JSON formatında veri alıp göndermesini sağlar.
  • İsteklerde Bearer token kullanılarak kimlik doğrulama yapılmalıdır. ( Authorization: Bearer token )

Cevap Yapısı​

Tüm servisler aynı cevap zarfını kullanır. error alanı işlemin başarılı (0) ya da hatalı (1) olduğunu belirtir.

Başarılı cevap​

{ "error": 0, "message": "İşlem başarıyla tamamlandı", "extra": { } }
  • extra alanının içeriği uca göre değişir: tek bir nesne, bir liste ya da boş ([]) olabilir.
  • Bazı uçlar sadece mesaj döner, extra boş kalır.
  • Silme gibi bazı işlemlerde gövde hiç dönmez (204 No Content).

Sayfalanmış liste cevabı​

{
"error": 0,
"message": "İşlem başarıyla tamamlandı",
"extra": { "list": [ /* ... */ ], "limit": 25, "total": 120, "currentPage": 1, "maxPage": 5 }
}
  • Sayfa başına dönen kayıt sayısı (limit) sabit 25'tir, istekte ayarlanamaz.
  • Bir sonraki sayfaya geçmek için page query parametresi kullanılır (?page=2, varsayılan 1). Bu parametrenin hangi uçlarda desteklendiği ilgili endpoint'in İstek (Query) Parametreleri bölümünde belirtilir.

Hatalı cevap​

{ "error": 1, "message": "<hata metni>" }
  • Validasyon hatalarında (422) ek olarak fields alanı gelir: { "fields": { "alanAdı": ["mesaj"] } }.
  • Her endpoint'in kendine özel iş kuralı hataları, ilgili dokümantasyon sayfasındaki Cevaplar (Responses) bölümünde örnekleriyle listelenir.

Genel HTTP durum kodları​

KodAnlam
200 / 204Başarılı
302Yönlendirme (onboarding/2FA)
401Kimlik doğrulanmadı / token geçersiz
404Bulunamadı
422Validasyon / iş kuralı hatası
429Çok fazla istek (rate limit)
500Sunucu hatası