Login API Dokümantasyonu

Genel Bakış

Bu doküman, kullanıcıların kimlik doğrulaması yapmak için Login API'sini nasıl kullanacaklarını açıklar.

Uç Nokta

POST https://cloud-api-dev.snitechnology.net/bouncer-service/api/auth/signin

Başlıklar (Headers)

• Content-Type: application/json

İstek Gövdesi (Request Body)

İstek gövdesi JSON formatında olmalı ve aşağıdaki alanları içermelidir:

Alan	Tip	Zorunlu	Açıklama
username	String	Evet	Kullanıcının kullanıcı adı.
password	String	Evet	Kullanıcının şifresi.

Örnek İstek Gövdesi

{
    "username": "testuser",
    "password": "Sni"
}

Yanıt

API, kimlik doğrulama detaylarını veya hata mesajlarını içeren bir JSON yanıtı döndürür.

Başarılı Yanıt

{
    "jwtToken": "token",
    "refreshToken": "FC69A5590D97CCE8017F6010BABD7D5362F1900E310968E59FC04CF3FD92D941",
    "jwtTokenExpireDate": "2024-12-16T09:55:19.598+00:00"
}

• jwtToken: Kimlik doğrulama oturumu için JSON Web Token (JWT).
• refreshToken: Yeniden kimlik doğrulama yapmadan yeni bir JWT almak için kullanılan token.
• jwtTokenExpireDate: JWT tokenın son kullanım tarihi ve saati.

Hata Yanıtı

{
    "error": false,
    "messages": [
        {
            "messageClass": "bouncer",
            "messageNumber": "000",
            "messageType": "ERROR",
            "message": "Hatalı kimlik bilgileri",
            "variable1": "Hatalı kimlik bilgileri",
            "variable2": "",
            "variable3": "",
            "variable4": ""
        }
    ],
    "refreshData": false,
    "popUpFormClose": false,
    "noCountTable": false,
    "rowUpdate": false,
    "rowOperations": [],
    "defaultXslt": false
}

• error: Bir hata olup olmadığını belirtir (bu durumda false).
• messages: Ayrıntılı hata bilgilerini içeren bir dizi.
  • messageClass: Mesajın sınıfı.
  • messageNumber: Belirli bir hata kodu.
  • messageType: Mesajın tipi (örn. ERROR).
  • message: Hata mesajının açıklaması.
  • variable1-4: Ayrıntılı bağlam için ek değişkenler.
• refreshData: Verilerin yenilenip yenilenmeyeceğini belirtir.
• popUpFormClose: Popup formunun kapatılıp kapatılmayacağını belirtir.
• noCountTable: Sayım tablosunun olup olmadığını belirtir.
• rowUpdate: Satır güncellemesinin yapılıp yapılmadığını belirtir.
• rowOperations: Satırlara ilişkin işlemleri içeren bir dizi.
• defaultXslt: Varsayılan XSLT kullanılıp kullanılmadığını belirtir.

Örnek cURL Komutu

curl -X POST "https://cloud-api-dev.snitechnology.net/bouncer-service/api/auth/signin" \
     -H "Content-Type: application/json" \
     -d '{
          "username": "testuser",
          "password": "Sni"
         }'