SOAP Metod Konfigürasyonu
Bu sekmede, seçilen API Proxy için politikalar, protokol dönüşümü ayarları ve SOAP metod yönetimi işlemleri yapılabilir.
SOAP Metod İşlemleri
Her API Proxy, önüne koyulduğu Backend API’nin metodları için vekil olarak çalışan kendi metodlarına sahiptir. Eğer API Proxy, WSDL dosyasının adresi verilerek ya da böyle bir dosya yüklenerek oluşturulmuşsa, bu dosyada var olan metodların her birisi için API Proxy’de aynı adlı bir metod otomatik olarak oluşturulur.
- Backend API’ye bir ya da daha fazla yeni metod eklenmesi
- Backend API’den bir ya da daha fazla metod silinmesi
- Backend API’deki bir ya da daha fazla metod’un adının istemcilerden saklanmak istenmesi
- Backend API’deki bir ya da daha fazla metod’un istemcilerin erişimine tamamen ya da geçici bir süreyle kapatılmak istenmesi
SOAP Metod Seçme
Metod listesinde, herhangi bir metodun adına tıklandığında o metod seçilmiş olur ve arayüz buna göre güncellenir.- Listede, seçilmiş olan metod’u belli edecek şekilde renk değişir.
- Üst orta bölümde seçilmiş olan metod’un hangisi olduğu gösterilir.
- Alt orta bölümde ise bu metod için yapılabilecek işlemlerin bağlantıları görüntülenir.
- Sağ tarafta ise seçilen metod’un Backend API’nin hangi metod ile ilişkili olduğu görünür.
SOAP Metod Ayarları Güncelleme
SOAP tipindeki API Proxylerde sadece metod güncelleme işlemi yapılabilir. SOAP tipindeki API Proxy’nin metodları için yapılabilecek ayarlar REST tipindeki ayarlardan farklı olup bu ayarları içeren görsele aşağıda yer verilmiştir:
SOAP Metod Ayarları Alanları
| Alan | Açıklama |
|---|---|
| SOAP Action (SOAP Action) | WSDL dosyası ayrıştırıldığında metod için belirtilmiş olan SOAPAction değeri otomatik elde edilir. Fakat herhangi bir sebepten dolayı farklı bir değer kullanmak için bu alandaki değer değiştirilebilir. |
| İndirmeyi Etkinleştir (Enable Download) | API Metodundan/Endpointinden dönen sonuç Byte Array tipinde ise sonucun dosya olarak ele alınması için bu seçenek işaretlenir. Aksi halde içerik encoded text olarak istemciye döner. Sonucun Byte Array olup olmadığına karar vermek için ise Content Type Header değerinin sistem ayarlarındaki “Byte Array Tipleri” listesinde yer alıp almadığına bakılır. Eğer bu listede yer alıyorsa sonucun Byte Array tipinde olduğuna karar verilir. |
| Aktifleştirildiğinde, compressed yanıt için (Accept-Encoding başlık değerine göre) Base64 Encoded Text kullanılır, varsayılan değeri Byte Array’dir. (If enabled, Base64 Encoded Text is used For Compressed Response(by Accept-Encoding header value), default value is Byte Array) | Bu metoddan dönecek olan yanıt mesajının sıkıştırılmış olduğuna Accept-Encoding değeri içinde gzip, deflate veya br değerleri var mı diye bakılarak karar verilir. Eğer bu değerlerden birisi varsa yanıt mesajının durumu sıkıştırılmış (compressed)‘tır. Dönen mesaj sıkıştırılmış durumda ise ve yanıt Byte Array tipinde ise ve: • Metodun bu seçeneği aktif ise, dönen mesaj Byte Array olarak sıkıştırılarak istemciye döndürülür. • Metodun bu seçeneği pasif ise, dönen mesaj Base64 ile encode edilip text’e çevrildikten sonra text hali sıkıştırılarak istemciye döner. |
| Re-Parse’da Yoksay (Skip for Re-Parse) | Bu alan işaretlendiğinde, API Proxy “re-parse” işlemine tabi tutulduğunda bu metodun güncellenmemesi gerektiğini belirtir. Örneğin tanım dosyasından bu method silinmiş ise dahi re-parse işlemi sonrası silinmeden kalır. |
| WSA Ayarı (WSA Settings) | Bu kısım sayesinde WS-Security Addressing ayarları her metod için ayrı ayrı aktifleştirilebilir. Aktif hale getirildiğinde ilgili WSA değerleri SOAP mesajına eklenir. |
| Anlaşılmalı (Must Understand) | “Must Understand” değerinin ayarı yapılır. |
| Versiyon (Version) | Kullanılacak olan WSA versiyonu seçimi yapılır. |
| Ön Tanımlı Aksiyonu Ekle (Add Default Action) | SOAP mesajına WSDL dosyası ayrıştırılırken belirlenmiş ön tanımlı aksiyonun eklenmesini sağlar. Aktif hale getirildiğinde aşağıdaki aksiyon ifadesi kaybolur. |
| Aksiyon (Action) | SOAP mesajına özelleştirilmiş aksiyon eklenmesi için bu alan kullanılır. |
| Ön Tanımlı Kime Bilgisi Ekle (Add Default To) | SOAP mesajına WSDL dosyası ayrıştırılırken belirlenmiş ön tanımlı kime bilgisinin eklenmesini sağlar. Aktif hale getirildiğinde aşağıdaki kime ifadesi kaybolur. |
| Kime (To) | SOAP mesajına özelleştirilmiş kime bilgisi eklenmesi için bu alan kullanılır. |
| Yanıt Kime (Reply To) | SOAP mesajına özelleştirilmiş yanıt kime bilgisi eklenmesi için bu alan kullanılır. |
| Mesaj ID Üret (Generate Message ID) | SOAP mesajına her mesaj için farklı üretilmiş Mesaj ID eklenmesi için bu alan aktif hale getirilir. |
| Mesaj ID (Message ID) | SOAP mesajına her mesaj için sabit bir Mesaj ID eklenmesi için bu alan aktif hale getirilir. |
| Kimden (From) | SOAP mesajına özelleştirilmiş kimden bilgisi eklenmesi için bu alan kullanılır. |
| Hata Kime (Fault To) | SOAP mesajına özelleştirilmiş hata kime bilgisi eklenmesi için bu alan kullanılır. |
| Hata İlişkisi (Relates To) | SOAP mesajına özelleştirilmiş hata ilişkisi bilgisi eklenmesi için bu alan kullanılır. |
| Hata İlişki Tipi (RelationShip Type) | SOAP mesajına özelleştirilmiş hata ilişki tipi bilgisi eklenmesi için bu alan kullanılır. |
| Önbellek Ayarları (Cache Settings) | Bu ayar aktifleştirilirse metot/endpoint bazlı önbellek ayarları aktifleştirilmiş olur. |
| Önbellek Key Tipi (Cache Key Type) | Önbellek Anahtar Tipi için iki seçenek vardır: • Query Parametreleri Kullan (Use Query Params): Önbelleğe alma işlemi için oluşturulacak olan anahtarın istekteki HTTP Query parametrelerine göre belirlenmesi için kullanılır. Örneğin sorgu parametresi /metodAdı?param1=value1¶m2=value2 şeklinde olduğunda önbellekte tutulacak anahtar param1=value1¶m2=value2 değerinden oluşur, ve bir daha istek bu şekilde geldiğinde önbellekteki sonuç döner.• Özel Anahtar Oluştur (Create Custom Key): Önbelleğe alma işlemi için oluşturulacak olan anahtarın istekteki seçilecek alanlar ile oluşturulması için kullanılır. Bu değer seçildiğinde “Değişken Listesi” tablosunda belirtilecek alanlar ile anahtar oluşturulur. |
| Değişken Listesi (Variable List) | Önbellek Key Tipi olarak “Özel Anahtar Oluştur (Create Custom Key)” seçilirse bu alan aktifleşir. Bu seçenek ile oluşturulacak olan önbellek anahtarının istek mesajının başlık, parametre veya gövde bölümlerinden belirtilecek alanların kombinasyonu ile yapılması sağlanır. Variable kullanarak özel anahtar oluşturulabilir. |
| Kapasite (Capacity) | Önbellekte saklanabilecek maksimum yanıt sayısıdır. |
| Önbellek Geçersizleme İçin Yetki Gerekir (Invalidation Requires Authn) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa seçilir. |
| Yetkisiz İsteklerin Ele Alınması (Handling Action) | Önbelleği geçersiz kılmak için yetkilendirme gerekiyorsa yetkisiz istekler için yapılacak işlem seçilir: • DEVAM ET (Continue): Bu seçenek seçilirse, Cache-Control başlık bilgisinde no-cache, no-store veya max-age=0 değerlerinden biri gönderildiğinde eğer gönderen kişi yetkilendirilmemiş ise bu değer gönderilmemiş gibi çalışmasına devam eder.• DUR (Stop): Bu seçenek seçilirse, Cache-Control başlık bilgisinde no-cache, no-store veya max-age=0 değerlerinden biri gönderildiğinde eğer gönderen kişi yetkilendirilmemiş ise akışı durdurur ve hata mesajı döner.Bu alan “Önbellek Geçersizleme İçin Yetki Gerekir” seçeneği işaretlendiğinde aktif hale gelir. |
| TTL (saniye) (TTL (seconds)) | Önbelleğe alınan yanıtın geçerli olacağı süre saniye olarak girilir. |
| Null/Boş Değerleri Önbelleğe Al (Cache Null Value) | Boş değerlerin de önbelleğe alınması isteniyorsa işaretlenir. |
SOAP Metod Silme
Metodu Sil (Delete Method) bağlantısına tıklanır. Onay işleminden sonra metod silinir.SOAP Metod Geçici Olarak Kullanımdan Kaldırma
Bir metod’un silinmeden erişime kapatılması mümkündür. Bunun için Metodu Devre Dışı Bırak (Disable Method) bağlantısına tıklanır. Bağlantıya tıklandığında metod kullanımdan kaldırılmış olur ve bununla birlikte arayüzde aşağıdaki değişiklikler gerçekleşir.- Metod’un yanındaki simge, metod’un kullanım dışı olduğunu gösterecek şekilde değişir.
- Metodu Devre Dışı Bırak (Disable Method) bağlantısı kaybolur. Bunun yerine Metodu Etkinleştir (Enable Method) bağlantısı gelir.
