Politikalar (Policies)

Bu bölümde politikaların genel özellikleri anlatılmaktadır. Herhangi bir politikaya ve konfigürasyonunun nasıl yapılacağına ilişkin detaylı bilgi için ilgili politikanın kendi sayfasına bakılabilir.

API’ye gelen ya da API’den dönen mesajlar için güvenlik, performans iyileştirme ve kullanım kolaylığı sağlama gibi amaçlarla bir takım kurallar, kısıtlamalar ve dönüşümler tanımlamak için kullanılan varlıklar genel olarak politika olarak adlandırılır.

Politika, kod geliştirmeye ihtiyaç duymadan API davranışının 'programlanmasını' sağlar. API'ler için ortak yönetim gereksinimlerini kolay ve güvenilir bir şekilde karşılamak için tasarlanmıştır.

Güvenlik, hız sınırlama, dönüşüm ve aracılık yetenekleri gibi özellikler sunar ve bu işlevler için kod yazılması ve bakım/idamesinin yapılması yükünden kurtarır. Her bir politika, belirli bir fonksiyonu uygulayan ve davranışı konfigürasyonla özelleştirilebilen ayrı bir modül gibi çalışır.

Politika Türleri

Apinizer Platformunda sunulan politikalar, işlevsel açıdan kabaca aşağıdaki şekilde gruplanabilir: 

Güvenlik (Security) Politikaları 

• Plain-Text Kimlik Doğrulama (Plain-Text Authentication)
• Basic Kimlik Doğrulama (Basic (Base64) Authentication)
• Digest Kimlik Doğrulama (Digest Authentication)
• JWT Kimlik Doğrulama
• OAuth2 Kimlik Doğrulama
• JOSE Doğrulama
• JOSE Gerçekleştirim
• mTLS Kimlik Doğrulama (mTLS Authentication)
• Backend API Kimlik Doğrulama (Backend API Authentication)
• SAML Doğrulama
• Şifreleme (Encryption)
• Dijital İmzalama  (Digital Signature)
• Şifre Açma (Decryption)
• Dijital İmza Doğrulama (Digital Signature Verification)
• WS-Security (Giden Mesaj)
• WS-Security (Gelen Mesaj)
• WS-Security STS Token
• Yetkilendirme (Authorization)

Erişim Denetimi (Access Control) Politikaları

• Yasaklı IP Listesi (Blocked IP Address List)
• İzin Verilen IP Listesi (Allowed IP Address List)
• Zaman Kısıtlaması (Time Restriction)
• API Bazlı Kota (API Based Quota)
• API Bazlı Daraltma (API Based Throttling) 

Veri İşleme (Data Manipulation) Politikaları

• JSON Mesaj Dönüşümü (JSON Message Transformation)
• XML Mesaj Dönüşümü (XML Message Transformation)
• Veri Düzenleme (Redaction)

Tehdit Koruması (Threat Protection) Politikaları

• İçerik Filtreleri (Regular Expression Message Filters)
• JSON Şema Doğrulama (JSON Schema Validation)
• XML Şema Doğrulama (XML Schema Validation)
• Maksimum Mesaj Uzunluğu (Max Message Size) 
• Minimum Mesaj Uzunluğu (Min Message Size)

Diğer Politikalar

• Script
• API Çağrısı (API Call)
• İş Kuralı (Business Rule)

Politika Uygulama Noktaları

Politikalar üç farklı noktada uygulanabilir.

1. API Proxy Grupları: Bir API Proxy Grup üzerinde bir politika uygulandığı zaman, o gruptaki bütün API Proxy'ler için bu politika işletilir. 
2. API Proxy: Bir API Proxy üzerinde bir politika uygulandığı zaman, o API Proxy'nin bütün metot/endpoint'leri için bu politika işletilir.
3. Metot/Endpoint: Bir metot/endpoint üzerinde uygulanan politika, yalnızca o metot/endpoint için işletilir, diğer metot/endpoint'leri etkilemez.

Farklı noktalara politikaların uygulanması ve bu politikaların işletilme sırasına ilişkin detaylı bilgi için Geliştirme Sekmesi bölümüne bakılabilir.

Politika Görünüm Sayfası Genel Yapısı

Politikalar için özel olarak tasarlanmış bir "Politika Görünüm Sayfası" bulunmaktadır. Bu sayfa, kullanıcıların politika detaylarını incelemesine ve düzenleme yapmadan mevcut yapılandırmayı görmesine olanak sağlar.

Sayfanın genel yapısı aşağıdaki bölümlerden oluşmaktadır:

Politika Genel Bilgileri:

• Adı (Name): Politikanın benzersiz adı.
• Durumu (Status): Aktif veya Pasif olarak belirtilir.
• Açıklama (Description): Politika hakkında kısa bir bilgi verir.
• Global: Politikanın global olup olmadığını belirtir.

Politika Ayarları:

Bu bölüm, politikanın çalışma şekli ile ilgili teknik ayarları içerir. Örneğin:

• Kimlik doğrulama yöntemleri.
• Kullanılan parametreler, algoritmalar ve gerekli teknik yapılandırmalar.

Koşullar (Conditions):

• Politikanın hangi durumlarda çalışacağını belirten kurallar.

Hata Mesajı Özelleştirme:

Politikayla ilgili hata durumlarında dönen mesajların yönetilmesini sağlar.

• Dönen HTTP kodlarını.
• Hata kodlarını.
• Orijinal ve özelleştirilmiş hata mesajlarını görebilir ve düzenleyebilir.

Actions:

Kullanıcılara, mevcut politikayı düzenleme, durumu değiştirme veya dışa aktarma gibi seçenekler sunar.

• Edit, politika üzerinde değişiklik yapmak gerektiğinde kullanılır.
• Deactivate, politikayı geçici olarak devre dışı bırakmak ve herhangi bir kuralın çalışmasını durdurmak için kullanılır.
• Export, politikayı yedeklemek veya başka bir projeye taşımak için kullanılır.
• Back, kullanıcıyı listeleme ekranına veya önceki sayfaya döndürerek gezinme kolaylığı sağlar.

Kullanıcı, bu bilgiler sayesinde bir politikanın nasıl çalıştığını kolaylıkla anlayabilir ve hata durumlarını yönetebilir.

Politika Kullanım Tipleri

Politikalar yerel (local) ya da genel (global) olabilir.

Yerel Politika

Bir yerel politika, yalnızca eklenmek istendiği API Proxy'nin Geliştirme Sekmesi üzerinde oluşturulabilir ve sadece bu API Proxy tarafından kullanılabilir, API Proxy silindiğinde onunla birlikte silinir. 

Global Politika

Global politikalar API Proxy'lerden bağımsız olarak Global Politikalar arayüzlerinden ya da bir API Proxy'nin Geliştirme Sekmesi içinden oluşturulabilir. Bir global politika sıfır ya da daha fazla API Proxy tarafından kullanılabilir. Bir API Proxy silindiğinde, o API Proxy tarafından kullanılan global politikalar bundan etkilenmez. Bununla birlikte, global politikada yapılan herhangi bir güncelleme, o politikayı kullanan bütün API Proxy'leri etkiler.

Politika Yapısı

Politikalar, tanımlı oldukları özel işlev açısından farklılaşan konfigürasyon bilgileri dışında yapısal olarak aynıdırlar ve bir takım ortak veri alanları içerirler.

Ortak Veri Alanları

Bütün politikalar için ortak olan bu veri alanları aşağıdaki tabloda görülmektedir.

Koşul Tanımlama

Politikaya belirli koşullar eklenerek sadece tanımlanan koşullar sağlandığı durumlarda çalışması sağlanır. Aşağıdaki görselde, seçilmiş olan politikaya uygulanabilecek koşullar gösterilmiştir:

Aşağıdaki görselde, seçilmiş olan politikanın yalnızca "status" parametresinin değeri "pending" ise çalışması istendiği bir örnek koşul görülmektedir.

Koşul değer kıyaslama operatörü olarak "listede olsun" veya "listede olmasın" seçeneği seçildiğinde, liste değerlerinin ayrımı için # işareti kullanılmalıdır. Örneğin user1#user2#user3 gibi.

Hata Mesajı Özelleştirme (Error Message Customization)

Hata mesajındaki HTTP Durum Kodu, Hata Kodu ve Hata Mesajı alanları özelleştirilebilir. Politika tanımlama arayüzünde o politika özelinde hata kodları ve mesajları özelleştirilebileceği gibi, platform genelinde de hata özelleştirme yapılabilir.

Hata Mesajını Özelleştirme alanları aşağıdaki tabloda görülmektedir.