API Çağrısı politikası sayesinde API Çağrısı mesajı ve orijinal mesajın herhangi bir noktasında gerekli ayarlamalar yapılarak başka bir API'ye (endpoint'e) bağlanarak akış genişletilebilir, istenirse dönen veriler de akışa dahil edilebilir.

Politika ayarlarını içeren görsele aşağıda yer verilmiştir:

Politika konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

İsim (Name)

Politikanın kullanımını ve yönetimini kolaylaştırmak için isim yazılabilir. Politikaların yönetimi ve seçimi sırasında bu isme ihtiyacınız olacaktır.

Açıklama

(Description)

Politikanın kullanımını ve yönetimini kolaylaştırmak için açıklama yazılabilir.

Çağrı Tipi

(Call Type)

Çağrımın nasıl yapılacağını belirtir. İki tip çağrı yöntemi vardır:

Tek Yönlü Çağrı (One-Way-Call): Tek yönlü çağrı tipinde Apinizer tanımlanmış olan istek bilgisini ilgili endpoint'e gönderir ve bir yanıt beklemeden akışına devam eder. Bu çağrı tipi seçildiğinde İstek (Request) ayarları aktif hale gelir.

Çift Yönlü Çağrı (Two-Way-Call): Çift yönlü çağrı tipinde Apinizer tanımlanmış olan istek bilgisini ilgili endpoint'e gönderir ve buradan dönecek olan yanıtı bekler. Yanıt geldiğinde tanımlı kurallara göre bu yanıtı akışındaki verileri güncellemek için kullanabilir. Bu çağrı tipi seçildiğinde İstek (Request) ve Yanıt (Response) ayarları aktif hale gelir.

İstek Ayarları Bölümü

Belirtilen endpoint'e istek yapılabilmesi için gerekli olan ayarların yapıldığı bölümdür.

Genel itibariyle Test Konsolu ekranı ile aynı olsa da ufak farklar içerir.

Gövdenin Düzenlenmesi 

Gönderilecek olan mesajın gövdesine ait ayarları içeren görsele aşağıda yer verilmiştir:


İstek bölümü üzerindeki gövde ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Kopyalanan Gövde İçeriğini Temizle

(Clear Copied Body Content)

Bu alan API Çağrı isteğinin gövdesini oluşturmak için kullanılır.

Eğer bu seçenek aktif değilse, normal olarak akışta gelen mesaj içeriği olduğu gibi endpoint'e gönderilir.

Eğer bu seçenek aktif ise orijinal mesajdan kopyalanan mesaj gövdesi temizlenir ve yeni mesaj gövdesinin gönderilmesi sağlanır.

Mesaj Şablonu Kullan

(Use Message Template)

Bu alan "Kopyalanan Gövde İçeriğini Temizle" seçeneği aktif edildiğinde görünür.

Yeni Mesaj Gövdesi alanına girilen değerin, orijinal mesajdan gelen gövdenin neresine yerleştirileceğini belirlemek için kullanılır. 

Mesaj Şablonunun İçerik Tipi

(Message Template Content Type)

Yeni Mesaj Gövde alanına girilecek değerin hangi tipte gönderileceği belirlenir. 4 farklı tip bulunur: raw, XML, JSON, x-www-form-urlencoded.

Mesaj Şablonu

(Message Template)

Gönderilmek istenen XML, JSON, düz metin ya da form verisi bu alana girilir.

API Çağrısına ait İstek Gövdesi Verilerini Düzenleme

(API Call Request Body Data Manipulation)

Orijinal mesajın gövdesi üzerinden, yapılacak API çağrısının istek hattına ait verilerin manipüle edilebilir. 2 çeşit veri düzenleme işlemi bulunur; Ekle/Düzenle (add/edit), Sil (delete).

Kaynak (Source) orijinal mesajı ifade ederken Hedef (Target) ise API Çağrısındaki istek hattını ifade eder. Burada Source alanı verinin key değerine, Target değeri value görevi görür.


Başlığın Düzenlenmesi

Gönderilecek olan mesajın başlığına ait ayarları içeren görsele aşağıda yer verilmiştir:


İstek bölümü üzerindeki başlık(lar) ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Orijinal Mesajdan Gelen Başlıkları Sil

(Delete All Copied Headers)

Bu alan seçilmediğinde orijinal mesajdan gelen tüm başlıklar olduğu şekliyle istek mesajına kopyalanır. Eğer seçilirse hiçbiri kopyalanmaz. 

Silinecek Başlık

(Headers To Be Deleted)

Bu alan "Orijinal Mesajdan Gelen Başlıkları Sil" alanı pasif iken gözükür.

Kopyalanan mesajlardan sadece buraya eklenen başlıklar kaldırılır.

Yeni Başlıklar

(New Headers)

İstek mesajında gönderilmek istenen mesaj başlıklarının girilmesi için kullanılır. 


Parametrelerin Düzenlenmesi

Gönderilecek olan mesajın parametrelerine ait ayarları içeren görsele aşağıda yer verilmiştir:


İstek bölümü üzerindeki parametre(ler) ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Orijinal Mesajdan Gelen Parametreleri Sil

(Remove All Copied Parameters)

Bu alan seçilmediğinde orijinal mesajdan gelen tüm parametreler olduğu şekliyle istek mesajına kopyalanır. Eğer seçilirse hiçbiri kopyalanmaz. 

Silinecek Parametre

(Parameters To Be Deleted)

Bu alan "Orijinal Mesajdan Gelen Parametreleri Sil" alanı pasif iken gözükür.

Kopyalanan mesajlardan sadece buraya eklenen parametreler kaldırılır.

Yeni Parametreler

(New Parameters)

İstek mesajında gönderilmek istenen parametrelerin girilmesi için kullanılır.


Önbellek Ayarlarının Düzenlenmesi 

Bu ayar, seçilen değişkenin değerine göre isteğin sonucunun önbellekten getirilmesini sağlar. Böylece gereksiz istek atılmasının önüne geçilir.

Önbelleğe ait ayarların düzenlenmesini içeren görsele aşağıda yer verilmiştir:


İstek bölümü üzerindeki önbellek ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Önbelleği Aktifleştir

(Enable Cache)

Önbellek ayarlarını aktif/pasif hale getirir.

Uygula

(Apply by)

Belirli bir değişken üzerinden bu politikanın çalışması için değişken seçilebilir.

Opsiyoneldir.

Kapasite

(Capacity)

Önbellekte saklanabilecek maksimum yanıt sayısıdır.

TTL

Önbelleğe alınan yanıtın, önbellekte kalacağı süredir. Saniye cinsinden verilir. 

Boş Yanıtları Önbelleğe Alın

(Cache Null Responses)

Boş değerlerin de önbelleğe alınması isteniyorsa işaretlenir.


Ayarlar Sekmesi

Ayarlar konfigürasyonunu içeren görsele aşağıda yer verilmiştir:


İstek bölümü üzerindeki ayarlar ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Zaman Aşımı

(Timeout)

İsteğin ne kadar süre sonra zaman aşımına uğrayacağı bilgisidir. Zorunludur.

Sertifika Devre Dışı/Aktif

(Certificate Disabled/Enabled)

İstekle birlikte sertifikanın gidip gitmeyeceği yönetilir. 

Sertifika

(Certificate)

Sertifika aktif edildiyse bu alan zorunludur. Eğer sertifika listesinde istenilen değer yoksa (Sertifika Ekle) Add Certificate linkinden yeni bir tane oluşturulabilir.


Yanıt Ayarları Bölümü

Belirtilen endpoint'e isteğin yapılması sonrası dönen sonucun işlenmesi için gerekli ayarların yapıldığı bölümdür.

Gövdenin Düzenlenmesi

Dönen mesajdan sonra orijinal mesajın gövdesine ne yapılacağına ait ayarları içeren görsele aşağıda yer verilmiştir:


Yanıt bölümü üzerindeki gövde ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Mesaj Şablonu İşlem Tipi

(Message Template Operation Type)

Orijinal mesajdaki gövdeye hangi işlemin uygulanacağı seçilir. Üç tip seçenek vardır:

Değiştirme (Not Change): Orijinal Gövde, API Çağrısından öncekiyle aynı olacaktır.

Gövdeyi, API Çağrı Yanıtıyla Değiştir (Replace Original Body with API Call Response)

API Çağrısından sonra Orijinal Gövdeyi Temizle (Clear Original Body after API Call)

Mesaj Şablonu Kullan

(Use Message Template)

Bu alan API Çağrısından sonra Orijinal Gövdeyi Temizle (Clear Original Body after API Call) seçeneği aktif edildiğinde görünür.

Orijinal mesaj gövdesine ait yeni bir mesaj gövdesi oluşturulmak istenirse aktifleştirilir.

Mesaj Şablonunun İçerik Tipi

(Message Template Content Type)

Yeni mesaj gövdesinin değeri, hangi tipte gönderileceği belirlenir. 2 farklı tip bulunur; XML, JSON.


Yeni Mesaj Gövdesi

(Message Template)

Gönderilmek istenen veri seçilen içerik tipine göre XML ya da JSON olarak bu alana girilir.

Orijinal Mesaj Verilerini Düzenleme

(Original Message Data Manipulation)

API Çağrı yanıtına ait gövde üzerinden, orijinal gövdenin manipüle edilmesini sağlar. Gövde üzerinden Ekle/Düzenle (Add/Edit) ve Sil (Delete) işlemleri mevcuttur.

Kaynak (Source) API Çağrısındaki yanıt (response) hattını ifade ederken Hedef (Target) ise orijinal mesajı ifade eder.

Başlıkların Düzenlenmesi

Dönen mesajdan sonra orijinal mesajın başlıklarına ne yapılacağına ait ayarları içeren görsele aşağıda yer verilmiştir:


Yanıt bölümü üzerindeki başlıklar(ler) ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Orijinal Mesajdan Gelen Başlıkları Sil

(Delete All Original Headers)

Bu alan seçildiğinde orijinal mesajdaki tüm mesaj başlıkları silinir.  

Silinecek Başlık

(Headers To Be Deleted)

Bu alan "Orijinal Mesajdaki Başlıkları Sil" alanı pasif iken gözükür. Orijinal mesaj başlıklarını kaldırmak için kullanılır.

Yeni Başlıklar

(New Headers)

İstek mesajında politikanın işletilmesi sonrası yeni bir başlık gönderilmek istenirse burası kullanılır. Değeri, isteğin yanıtından alınabileceği gibi sabit değer de olabilir.


Parametrelerin Düzenlenmesi

Dönen mesajdan sonra orijinal mesajın varsa parametrelerine ne yapılacağına ait ayarları içeren görsele aşağıda yer verilmiştir:


Yanıt bölümü üzerindeki parametre(ler) ile ilgili konfigürasyon için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Orijinal Mesajdan Gelen Parametreleri Sil

(Delete All Original Parameters)

Bu alan seçildiğinde orijinal mesajdaki tüm sorgu (query) parametreleri silinir.  

Silinecek Parametre

(Parameters To Be Deleted)

Bu alan "Orijinal Mesajdan Gelen Parametreleri Sil" alanı pasif iken gözükür. Orijinal mesaj parametrelerini kaldırmak için kullanılır.

Yeni Parametreler

(New Parameters)

İstek mesajında politikanın işletilmesi sonrası yeni bir parametre gönderilmek istenirse burası kullanılır. Değeri, isteğin yanıtından alınabileceği gibi sabit değer de olabilir.


Koşullar ve Hata Mesajı Özelleştirme panellerinin açıklamasını görüntülemek için Politikalar (Policies) sayfasını ziyaret edebilirsiniz.