Değişkenler (Variables)
Değişkenler; mesajın başlık, parametre ya da gövde içerisinden değer almak ve değer göndermek gibi bilgi aktarımında kullanılırlar.
Bu sayfada proje bazlı kullanılmak üzere tanımlar yapılır.
Apinizer Platformu'nda ilk kurulum ile birlikte hazır değişkenler gelmektedir. Yeni bir proje oluşturduğunuz zaman Yönetim menüsü altındaki değişkenler bölümdeki tüm değişkenler ilgili projeye kopyalanır.
Yönetim menüsü altında oluşturulan değişkenler, projelere kopyalanarak kullanıldığından, bu değişkenlerde yapılan güncellenme veya silme işlemleri kullanıldıkları yerlerdeki tanımlamaları etkilemez.
Tüm değişkenler "Globalleştir" seçeneği ile Admin sayfasına taşınarak tüm projelerde kullanılabilir hale gelir ve yönetimi Admin kullanıcısına bırakılır.
Değişken Tipleri
Apinizer'da 5 farklı tipte değişken oluşturulur:
- Başlık (Header)
- Parametre (Parameter)
- Gövde (Body)
- Ortam Değeri (Context Value)
- Özel Değişken (Custom Variable)
Başlık (Header) Tipinde Değişken Oluşturma
Bu tipte değişken oluşturmak için tip (type) olarak Başlık seçimi yapılarak ilgili girdi alanları doldurulur.
Değişken oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Değişken adı ile başlık adı farklı tanımlanabilir. Adı sistem genelinde tekil olan bir tanımdır. Başlık adı iste istemciden (client) beklenen değerdir.
Alan | Açıklama |
|---|---|
Ad (Name) | Değişken tanımının adının girildiği alandır. |
Açıklama (Description) | Oluşturulan değişken ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
Tipi (Type) | Değişkenin mesajın hangi bölümde beklendiğinin girildiği alandır. |
Başlık Adı (Header Name) | İstemciden (client) gelen istekte beklenen başlık adının girildiği alandır.
Eğer bu alan çoklu değer içeriyorsa ilk değer kullanılır. |
Parametre (Parameter) Tipinde Değişken Oluşturma
Bu tipte değişken oluşturmak için tip (type) olarak Parametre seçimi yapılarak ilgili girdi alanları doldurulur.
Değişken oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Değişken adı ile parametre adı farklı tanımlanabilir. Adı sistem genelinde tekil olan bir tanımdır. Parametre adı ise istemciden (client) beklenen değerdir.
Alan | Açıklama |
|---|---|
Ad (Name) | Değişken tanımının adının girildiği alandır. |
Açıklama (Description) | Oluşturulan değişken ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
Tipi (Type) | Değişkenin mesajın hangi bölümde beklendiğinin girildiği alandır. |
Parametre Tipi (Param Type) | Parametrenin istemciden (client) gelen istek tipinin seçildiği alandır. Varsayılan değeri QUERY'dir. Form parametre değeri olarak okunabilecek değerler; x-www-form değerleri ve attached text data part değerleridir. x-www-form değerlerinde ekleme, silme, düzenleme yapılabilir, text data part kısmı sadece okunabilirdir (read-only), ekleme/düzenleme yapılamaz. Okuma işlemi her yerden yapılabilir. Değerleri ekleme/silme/düzenleme ise sadece istek (request) hattı için geçerlidir. |
Parametre Adı (Parameter Name) | İstemciden (client) gelen istekte beklenen parametre adının girildiği alandır.
Parametre Tipi'nin değeri Query ise ve çoklu değer ise ilk değer kullanılır. |
Gövde (Body) Tipinde Değişken Oluşturma
Bu tipte değişken oluşturmak için tip (type) olarak Gövde seçimi yapılarak ilgili girdi alanları doldurulur.
Değişken oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Alan | Açıklama |
|---|---|
Ad (Name) | Değişken tanımın adının girildiği alandır. |
Açıklama (Description) | Oluşturulan değişken ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
Tipi (Type) | Değişkenin mesajın hangi bölümde beklendiğinin girildiği alandır. |
Mesaj Tipi (Message Type) | Mesaj içeriğinin türünün seçildiği alandır. Varsayılan değeri JSON'dır. |
JSON/XML Path | İstemciden (client) gelen isteğin değerini almak için gerekli olan JSON/XPath bilgilerinin girildiği alandır. |
XPath'ın çalışma mantığında bazı farklılıklar bulunmaktadır. Bunu anlamak önemlidir. Bu yüzden bu sayfayı ziyaret ediniz.
Ortam Değerleri (Context Values) Tipinde Değişken Oluşturma
Bu tipte değişken oluşturmak için tip (type) olarak Ortam Değerleri seçimi yapılarak ilgili girdi alanları doldurulur.
Değişken oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Alan | Açıklama |
|---|---|
Ad (Name) | Değişken tanımının adının girildiği alandır. |
Açıklama (Description) | Oluşturulan değişken ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
Tipi (Type) | Değişkenin mesajın hangi bölümde beklendiğinin girildiği alandır. |
Değer (Value) | İstemciden (client) gelen istekte beklenen ön tanımlı değerin seçildiği alandır.
|
Zone ID | Değer olarak Date/Time grubundaki değerlerden herhangi biri seçilmişse bu alan aktifleşir. Örnek değer: "+03:00" veya "Europe/Istanbul". Daha fazlası için burayı ziyaret edebilirsiniz. |
Özel Değişken (Custom Variable) Tipinde Değişken Oluşturma
Bu tipte değişken oluşturmak için tip (type) olarak Özel Değişken seçimi yapılarak sadece isim alanı doldurulur.
Sonrasında bu değişkenin girilen ismi ile Script ve Business Rule politikalarından değer atamak, değerini okumak, değerini değiştirmek mümkün olur.
Daha çok bir politikadan diğerine veri taşınması için kullanılmaktadır.
Değişken oluşturma ayarlarını içeren görsele aşağıda yer verilmiştir:
Alan | Açıklama |
|---|---|
Ad (Name) | Değişken tanımının adının girildiği alandır. |
Açıklama (Description) | Oluşturulan değişken ile ilgili yönetimi kolaylaştırmak için açıklama yazılabilir. |
Tipi (Type) | Değişkenin mesajın hangi bölümde beklendiğinin girildiği alandır. |
Değişkenler ekranında her zaman ilk değer alınır, başlık (header) ve parametre (parameter) değeri çoklu (multiple) geldiğinde dahi ilk değeri kullanılır. Sadece script politikasında çoklu (multiple) değer var ise # ile ayrılarak kullanılabilir.
Log kayıtlarında gösterirken key: val1#val2#val3 şeklinde gösterilir.