Ana içeriğe atla

Çalışma Mantığı

Gelen mesajın öğeleri (başlık, parametre, gövde) seçilen script dili ile işlenip sonucunu istemciye gönderilir.

Okuma ve Yazma Kuralları

Gelen istek mesajın orijinal hali üzerinde değişiklik yapılamaz, bu veriler üzerinde sadece okuma yapılabilir. İstemciye dönecek yanıt ise script içerisinde hazırlanır.

​
Yeni Script-2-API Oluşturma

1

Menüden Script-2-API Sayfasına Gidin

Ana menüde Geliştirme → API Oluşturucu → Script-2-API öğesi seçilir.Script-2-API Oluşturma Ekranı
2

Yeni API Oluşturun

Açılan arayüzde sağ üstteki +Oluştur tuşuna tıklanır.
3

API Bilgilerini Doldurun

Yeni oluşturulacak API için gerekli alanlar doldurularak sağ üstteki →Kaydet ve Devam tuşuna tıklanmasıyla API oluşturma işi başlamış olur.API Bilgilerini Doldurma
4

Endpoint Ekleyin

API kaydedildikten sonra API’ye endpoint tanımlanmasına başlanır. Hiç endpoint yoksa ilk defa eklemek için API içerisinde ekle tuşuna basılır, eğer en az bir tane varsa endpoint’ler bölümünde çıkan ekle tuşuna basılır.Endpoint Ekleme

​
Endpoint Oluşturma

Endpoint tanımlamak için aşağıdaki bilgiler girilir: Endpoint Oluşturma Ekranı Endpoint oluşturma konfigürasyonu için kullanılan alanlar aşağıda kategorilere ayrılarak açıklanmıştır:

HTTP Metot

Alan: HTTP Metot (HTTP Method)REST API’ler için HTTP Metodu seçilir: GET, POST, PUT, HEAD, OPTIONS, DELETE, PATCH, TRACE, ALL

Ad/URL

Alan: Ad/URL (Name/URL)Endpoint erişim adresidir. API Proxy oluşturulduğunda endpointe bu adres üzerinden erişilir.

Açıklama

Alan: AçıklamaAPI endpoint’inin tanım bilgisidir.

Script Tipi

Alan: Script Tipi (Script Type)Yazılacak olan Script’in tipidir. Javascript veya Groovy olabilir.

Script

Alan: Script (Script)Çalıştırılacak olan script bilgisidir.

Değişkenler

Alan: Değişkenler (Variables)İstek ve yanıt hattında erişimi gerçekleştirebilecek read-only ve write-only değişkenlerin listesidir. İlgili değişkene tıklandığında, değişken Script alanında imlecin bulunduğu noktaya eklenir.

Deneme Tuşu

Alan: Deneme Tuşu (Try It)Çalıştırılacak olan scriptin denemesinin yapılabilmesi için yeni bir pencere açılmasını sağlar.

​
Değişkenler (Variables)

Yapılacak olan okuma ve oluşturma işlemleri için mesajın başlık, parametre ve gövde kısımlarına script üzerinde erişim için çeşitli anahtar kelimeler kullanılmıştır.
İstemciden Apinizer’a gelen verilere erişim için kullanılan değişkenler:

Başlık (Header)

Değişken: requestHeaderMapFromClientVeri Tipi: Map<String, String>İşlem: Okumaİstek başlıklarını okumak için kullanılır.

Parametre (URL Parameter)

Değişken: requestUrlParamMapFromClientVeri Tipi: Map<String, String>İşlem: OkumaURL parametrelerini okumak için kullanılır.

Gövde (Body)

Değişken: requestBodyTextFromClientVeri Tipi: Stringİşlem: Okumaİstek gövdesini okumak için kullanılır.

Mesaj Bilgisi (Context)

Değişken: contextValuesVeri Tipi: Stringİşlem: OkumaMesaj bilgilerine erişim için kullanılır.

Özel Değişken

Değişken: customVariableMapVeri Tipi: Map<String, String>İşlem: Okuma, YazmaÖzel değişkenleri okumak ve yazmak için kullanılır.
Apinizer’dan istemciye gönderilecek verileri oluşturmak için kullanılan değişkenler:

Başlık (Header)

Değişken: responseHeaderMapToClientVeri Tipi: Map<String, String>İşlem: YazmaYanıt başlıklarını oluşturmak için kullanılır.

Gövde (Body)

Değişken: responseBodyTextToClientVeri Tipi: Stringİşlem: YazmaYanıt gövdesini oluşturmak için kullanılır.

Durum Kodu (Status Code)

Değişken: statusCodeToClientVeri Tipi: Integerİşlem: YazmaHTTP durum kodunu ayarlamak için kullanılır.

Mesaj Bilgisi (Context)

Değişken: contextValuesVeri Tipi: Stringİşlem: OkumaMesaj bilgilerine erişim için kullanılır.

Özel Değişken

Değişken: customVariableMapVeri Tipi: Map<String, String>İşlem: Okuma, YazmaÖzel değişkenleri okumak ve yazmak için kullanılır.
Script tipi Groovy ise:
  • Mesaj gövdesi JSON olan durumda JsonSlurper
  • Mesaj gövdesi XML olan durumda XMLSlurper
kullanılması mesaj işleme işlemini oldukça kolaylaştırır.

​
Script-2-API’den API Proxy Oluşturma

API’nin tanımlamaları bittikten sonra sıra bu API’yi API Proxy olarak açmaya gelir.
Script-2-API’den API Proxy oluşturmak için Script-2-API ile oluşturulan API’nin en az bir tane endpoint’i olmalıdır.
Script-2-API’yi API Proxy olarak erişime açabilmek için aşağıdaki görselde Proxy Oluştur (Create Proxy) tuşuna basılır. Proxy Oluştur Butonu Gelen ekranda API Proxy için gerekli alanları girerek Kaydet butonuna tıklayarak API Proxy oluşturulur. API Proxy Oluşturma Ekranı Bu adımdan sonra yapılabilecekler API Proxy dokümanı ile aynıdır. Detaylı bilgi için API Proxy Oluşturma sayfasını inceleyebilirsiniz.
Bir Script-2-API için birden fazla API Proxy oluşturabilirsiniz.

​
Yükle (Deploy)/Yeniden Yükle (Redeploy)

Script-2-API ile oluşturulan API Proxy’leri, API Proxy’ler sayfasından veya Script-2-API sayfasında ilgili API’yi seçerek yükleme durumunu yönetebilirsiniz. Script-2-API sayfasından yönetmek için sayfanın üstünde yer alan API Proxy’leri Yönet (Manage API Proxies) linkine tıklanınca açılan pencereden faydalanılır. Açılan pencerede bu API’den oluşturulan API Proxy’ler için Yükleme (Deploy), Yeniden Yükleme (Redeploy) ve Kaldırma (Undeploy) işlemlerini yapabilirsiniz. Bu konuyla ilgili daha detaylı bilgi almak için Revizyon, Yükleme, Yeniden Yükleme, Kaldırma sayfalarımızı ziyaret edebilirsiniz. API Proxy'leri Yönetme Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yükleme işlemiyle ilgili bilgileri oluşturup (Yükle) Deploy butonuna tıklanır. Yükleme Onay Ekranı
Script-2-API’ye yeni bir endpoint eklendiğinde veya endpoint içinde değişiklik yapıldığında değişikliğin geçerli olabilmesi için bu API’den oluşturulan tüm API Proxy’lerin yeniden yüklenmesi gerekir.
Yeni bir endpoint eklediğinizde ve ya mevcut bir endpoint’i güncellediğinizde aşağıdaki gibi bir bilgilendirme gelecektir. Yeniden Yükleme Bilgilendirmesi Yeniden Yükle (Redeploy) diyerek değişikliklerin API Proxy’lere uygulanması sağlanır. Yeniden Yükleme Onay Ekranı Yukarıdaki işlemden sonra onaylama yapmak gereklidir. Yeniden yükleme işlemiyle ilgili bilgileri oluşturup (Yeniden Yükle) Redeploy butonuna tıklanır. Script-2-API sayfasından API Proxy’nin ismine tıklanarak API Proxy’e gidilir. Script-2-API Sayfasından API Proxy'ye Gitme Benzer şekilde, API Proxy sayfasından Script-2-API sayfasına gitmek için aşağıdaki gibi API Proxy’deki Script-2-API ismine tıklayarak gidilir. API Proxy Sayfasından Script-2-API'ye Gitme

​
Script-2-API Silme

Bir Script API silindiğinde ona bağlı olan tüm API Proxy’ler önce kaldırılır (undeploy) sonra silinir. Script-2-API Silme Uyarısı