API Referansı
Hazırlayan: Aether365 Ekibi Hedef Kitle: Geliştiriciler ve DevOps mühendisleri Kapsam: Aether365 REST API genel bakışı, temel URL ve yanıt formatı
Aether365 API, tarama verilerine programatik olarak erişmenize, tarama başlatmanıza, tenant'ları yönetmenize ve AI Pilot'u yönlendirmenize olanak tanır: otomatik remediation'ları üretme, inceleme ve uygulama, kimlik riski sinyallerini okuma ve politikaları sıkılaştırma.
Endpoint grupları
| Alan | Kapsadığı işlevler |
|---|---|
| Taramalar | Uyumluluk ve exposure taramalarını tetikle ve listele |
| Sonuçlar | Tek tek tarama bulgularını oku |
| AI Pilot | Otomatik remediation planlarını üret, incele ve uygula |
| Threat Alerts | Kimlik riski sinyalleri ve tek tıkla kullanıcı sınırlama |
| Politikalar | Politika duruşunu oku ve izin listesindeki politikaları sıkılaştır |
| Tenant'lar | Tenant profilini oku ve güncelle |
| Bağlantılar | Bağlı Microsoft 365 tenant'larını yönet |
| Zamanlanmış Taramalar | Yinelenen taramaları otomatikleştir |
Temel URL
https://api.aether365.ioTüm endpoint'ler bu temel URL'ye görelidir.
Kimlik Doğrulama
API, Bearer token kimlik doğrulaması kullanır. Her isteğin Authorization başlığında geçerli bir JWT token ekleyin:
Authorization: Bearer <token>Token'lar Aether365'in kimlik doğrulama sistemi tarafından verilir. Token elde etme hakkında ayrıntılar için Kimlik Doğrulama sayfasına bakın.
Yanıt Formatı
Tüm API yanıtları tutarlı bir JSON yapısı kullanır.
Başarılı Yanıt
json
{
"success": true,
"data": {}
}Liste endpoint'leri için:
json
{
"success": true,
"data": [],
"meta": {
"total": 142,
"page": 1,
"limit": 20
}
}İşlem endpoint'leri (tetikleme, silme) için:
json
{
"success": true,
"data": null
}Hata Yanıtı
json
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Okunabilir açıklama",
"details": {}
}
}HTTP Durum Kodları
| Kod | Anlamı |
|---|---|
200 | Başarılı |
201 | Kaynak oluşturuldu |
400 | Geçersiz istek - eksik veya hatalı parametreler |
401 | Kimlik doğrulama gerekli veya token geçersiz |
403 | Erişim engellendi - tenant izolasyonu ihlali |
404 | Kaynak bulunamadı |
409 | Çakışma - örneğin, bir tarama zaten çalışıyor |
429 | Plan limiti aşıldı |
500 | Sunucu hatası |
Hata Kodları
| Kod | Açıklama |
|---|---|
AUTH_MISSING_TOKEN | Authorization başlığı mevcut değil |
AUTH_INVALID_TOKEN | Token doğrulanamadı |
AUTH_EXPIRED_TOKEN | Token süresi dolmuş |
TENANT_NOT_FOUND | Tenant mevcut değil |
TENANT_NOT_CONNECTED | Microsoft onayı tamamlanmamış |
SCAN_NOT_FOUND | Tarama kimliği mevcut değil |
SCAN_ALREADY_RUNNING | Bu tenant için bir tarama zaten devam ediyor |
SCAN_PLAN_LIMIT_REACHED | Mevcut plan için tarama kotası tükenmiş |
VALIDATION_ERROR | İstek gövdesi veya sorgu parametreleri geçersiz |
INTERNAL_ERROR | Beklenmeyen sunucu hatası |
Hız Sınırları
API, dakikada 120 istekle sınırlıdır. Hız sınırını aşmak 429 Too Many Requests döndürür. Retry-After başlığı, yeniden denemeden önce kaç saniye beklemeniz gerektiğini gösterir.