Ana içeriğe geç

🔗 API Uç Noktaları

SecTrail CM API'si, sertifika yönetimi işlemlerinizi otomatikleştirmek için çeşitli uç noktalar sunar. Tüm uç noktaların detaylı dokümantasyonu için Swagger arayüzünü kullanabilirsiniz:

https://your-sectrailcm-server/documentation

Temel Kullanım Alanları​

1. Sertifika İmzalama​

API üzerinden çeşitli formatlarda sertifika imzalama işlemleri gerçekleştirebilirsiniz:

Desteklenen İmzalama Türleri:

  • CSR (Certificate Signing Request) imzalama
  • Self-Signed sertifika oluşturma
  • Template tabanlı sertifika üretimi
  • JKS (Java KeyStore) formatında sertifika oluşturma

Uç Nokta:

POST /api/generate
bilgi

Sertifika imzalama işlemleri için requestType parametresi kullanılarak işlem türü belirlenir. Detaylı parametre listesi için Swagger dokümantasyonunu inceleyiniz.

2. Sertifika Yükleme ve Dağıtım​

API üzerinden sertifikalarınızı hedef sunuculara ve cihazlara otomatik olarak dağıtabilirsiniz:

Özellikler:

  • Çoklu hedef cihaza dağıtım (F5, Apache, Nginx, IIS, vb.)
  • Virtual host bazlı dağıtım
  • Zamanlı dağıtım desteği
  • Başarısız dağıtımlar için retry mekanizması
  • Dağıtım durumu sorgulama ve izleme

Uç Nokta:

POST /api/deployment

3. Keşif Listesi Yönetimi​

Keşif listelerinizi API üzerinden toplu olarak yönetebilirsiniz:

Özellikler:

  • Keşif listesi oluşturma
  • Toplu domain/IP ekleme
  • Keşif sonuçlarını sorgulama
  • Keşif planlarını zamanlama

Uç Nokta:

POST /api/discoverList

4. Sertifika Envanteri​

Envanterdeki sertifikaları sorgulayabilir ve bilgilerini alabilirsiniz:

Özellikler:

  • Toplu sertifika listesi alma
  • Sertifika detaylarını görüntüleme
  • Sertifika durumu sorgulama

Uç Nokta:

POST /api/getCertificates

API Kullanım Örnekleri​

Kimlik Doğrulama​

Tüm API isteklerinde kimlik doğrulama belirteci kullanmanız gerekmektedir:

curl -X POST https://your-sectrailcm-server/api/endpoint \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Hata Yönetimi​

API, standart HTTP durum kodları kullanır:

  • 200 OK - İstek başarılı
  • 201 Created - Kaynak oluşturuldu
  • 400 Bad Request - Geçersiz istek
  • 401 Unauthorized - Kimlik doğrulama hatası
  • 403 Forbidden - Yetki hatası
  • 404 Not Found - Kaynak bulunamadı
  • 500 Internal Server Error - Sunucu hatası

Swagger Dokümantasyonu​

Tüm uç noktaların detaylı açıklamaları, parametre tanımları ve örnek istek/yanıt yapıları için Swagger arayüzünü kullanın:

https://your-sectrailcm-server/documentation

Swagger arayüzü üzerinden:

  • Tüm uç noktaları keşfedebilir
  • İstek/Yanıt şemalarını görüntüleyebilir
  • API çağrılarını etkileşimli olarak test edebilirsiniz
ipucu

Swagger dokümantasyonunda "Try it out" özelliğini kullanarak API çağrılarınızı doğrudan test edebilir ve sonuçları görebilirsiniz.