API Erişimi

Konsolda yaptığınız işlemleri — yapılandırma okuma/güncelleme, kural yönetimi, IP engelleme, önbellek temizleme, kullanım raporları — HEIMWALL REST API’si ile programatik olarak da yapabilirsiniz. CI/CD boru hatları, izleme sistemleri ve kendi panelleriniz için tasarlanmıştır.

Detaylı API dokümanına erişim

1. https://cloud.heimwall.net/ adresinden konsola giriş yapın.

2. Konsol → WAF → [alan adı] → API Anahtarları sayfasını açın.

3. Sayfadaki “API Dökümanını aç” bağlantısına tıklayın. Panel içinde API Dokümanı görüntüleyicisi açılır: tüm endpoint’ler, parametreler, istek/yanıt şemaları ve hata kodları burada belgelidir. İsterseniz “Ham spec (OpenAPI)” bağlantısıyla makine tarafından okunabilir OpenAPI dosyasını da indirebilirsiniz.

Bayi (reseller) hesapları için aynı doküman Bayi Paneli → Entegrasyonlar altındaki API Dokümanı bağlantısından açılır.

API anahtarı oluşturma

1. Konsol → WAF → [alan adı] → API Anahtarları sayfasında yeni anahtar oluşturun.

2. Anahtara bir isim verin ve ihtiyaç duyduğu kapsamları (scope) işaretleyin — her anahtar yalnızca seçtiğiniz işlemleri yapabilir.

3. İsteğe bağlı olarak IP kısıtlaması ekleyin (anahtar yalnızca belirttiğiniz IP/CIDR’lerden çalışır) ve bir son kullanma tarihi belirleyin.

4. Oluşturulan anahtar yalnızca bir kez gösterilir — hemen kopyalayıp parola yöneticinizde veya gizli deposunda (vault) saklayın. Anahtarlar sunucuda geri döndürülemez şekilde özetlenerek (hash) tutulur; kaybederseniz iptal edip yenisini oluşturursunuz.

Bir alan adı için en fazla 20 aktif anahtar tanımlanabilir. Anahtarları aynı sayfadan iptal edebilir, adını ve kapsamlarını güncelleyebilirsiniz.

Kapsamlar (scopes)

Her anahtar, en az yetki ilkesiyle yalnızca gerektiği kadar kapsam almalıdır:

Kapsam	İzin verdiği işlemler
config:read	Yapılandırmayı, kuralları ve koruma ayarlarını okuma
config:write	Yapılandırma ve kural değişiklikleri, IP engelleme
usage:read	Trafik ve kullanım verilerini okuma
cache:purge	Önbellek temizleme

Örnek: CI/CD anahtarı

Deploy sonrası yalnızca önbellek temizleyen bir anahtar için sadece cache:purge kapsamını verin ve IP kısıtlamasına deploy sunucunuzun adresini yazın. Anahtar sızsa bile yapılabilecek tek şey önbellek temizlemek olur.

Güvenlik ve kullanım notları

• Kimlik doğrulama Bearer token ile yapılır; anahtarınızı Authorization başlığında gönderirsiniz. Ayrıntılı biçim panel içi dokümanda gösterilir.
• Hız limiti uygulanır; yanıtlardaki X-RateLimit-Limit ve X-RateLimit-Remaining başlıklarından kalan kotanızı izleyebilirsiniz. Limit aşımında 429 ve Retry-After döner.
• Denetim kaydı: API ile yapılan her değişiklik, anahtarın adıyla Denetim Kaydına işlenir — kim, neyi, ne zaman değiştirdi her zaman izlenebilir.
• Anahtarları düzenli aralıklarla yenileyin: yenisini oluşturun, sistemlerinizi geçirin, eskisini iptal edin.
• Anahtarı asla istemci tarafı koduna, depo (repo) içine veya loglara koymayın.

İlgili sayfalar

WebhooksOlayları API'yi beklemeden sistemlerinize anında iletin.

Önbelleği TemizlemeAPI ile cache temizleme senaryosu dahil.

Denetim KaydıAPI anahtarlarıyla yapılan değişikliklerin izi.

Kesintisiz DağıtımCI/CD deploy akışı için ayrı deploy hook'ları.