Ana içeriğe geç

👤 Kimlik Doğrulama

SecTrail CM API'si, kimlik doğrulama belirteci (Bearer token) tabanlı kimlik doğrulama kullanır. API uç noktalarını kullanabilmek için öncelikle bir erişim belirteci almanız gerekmektedir.

API Kullanıcısı Oluşturma​

API'yi kullanmaya başlamadan önce, API rolüne sahip bir kullanıcı oluşturmalısınız:

Adımlar​

  1. SecTrail CM arayüzünde Users > Local Users bölümüne gidin
  2. Yeni bir kullanıcı oluşturun
  3. Kullanıcıya API rolünü atayın
  4. Kullanıcı adı ve şifreyi kaydedin
ipucu

API kullanıcıları için güçlü şifreler kullanın ve bu kimlik bilgilerini güvenli bir şekilde saklayın.

Kimlik Doğrulama Belirteci Alma​

API kullanıcınızı oluşturduktan sonra, bir kimlik doğrulama belirteci almanız gerekmektedir.

Uç Nokta​

POST /api/login

İstek Gövdesi​

{
  "username": "api-user",
  "password": "your-secure-password"
}

Yanıt​

{
  "user": "apiuser",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGci..."
}

Örnek cURL Komutu​

curl -X POST https://your-sectrailcm-server/api/login \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=api-user&password=your-secure-password"

Belirteç Kullanımı​

Aldığınız kimlik doğrulama belirtecini, tüm API isteklerinizde Authorization başlığında kullanmalısınız:

curl -X GET https://your-sectrailcm-server/api/endpoint \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Belirteç Süresi​

  • Kimlik doğrulama belirteçleri belirli bir süre sonra geçerliliğini kaybeder
  • Belirteç süreniz dolduğunda, yeni bir belirteç almanız gerekir
  • Yanıtta kullanıcı adı (user) ve erişim belirteci (access_token) bilgilerini alırsınız

Güvenlik Önerileri​

  • Belirteçlerinizi asla kaynak kodunuzda saklamayın
  • Ortam değişkenleri veya güvenli bir kasa (vault) kullanın
  • HTTPS kullanarak tüm API isteklerini güvenli hale getirin
  • Belirteçleri düzenli olarak yenileyin
  • API kullanıcılarına sadece gerekli yetkileri verin