API Proxy Listesi

API Proxy listesinin görüntülendiği ve çeşitli işlemler yapmak üzere herhangi birinin seçilebildiği arayüzdür.

Arayüz açıldığında API Proxy listesi aşağıdaki gibi görüntülenir.

Listedeki herhangi bir kaydın Adı (Name) kolonundaki değere tıklanırsa, o API Proxy için biçimlendirme arayüzü açılır. Biçimlendirme detayları için Sekmeler sayfasına bakınız.

Listedeki URL kolonunda, ilgili API Proxy'nin yüklenmiş ve aktif olduğu ortamlar ve adresleri görünür. Herhangi bir adrese tıklanarak gidilebilir ya da yanındaki ikona tıklanarak adres kopyalanabilir.

Her satırın sonunda bir menü ikonu bulunur. Bu ikona tıklanarak açılan menüden çeşitli işlemler yapılabilir.

API Proxy Listesi arayüzünde yapılabilecek işlemler:

API Proxy arama/filtreleme

Varsayılan görünümde listenin hemen üzerinde hızlı filtre alanları bulunur. Varsayılan filtre alanları yeterli gelmezse, şekilde kırmızı ile gösterilen ikona tıklanarak Gelişmiş Filtreleme seçenekleri açılabilir.

Filtre alanlarından herhangi birisine değer yazılması ya da değer seçilmesi durumunda, aşağıdaki liste filtreye uygun olarak güncellenir.

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

Filtre Alanı

Açıklama

API Proxy adına göre ara

(Search by API Proxy name)

Adı bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

API Proxy açıklamasına göre ara

(Search by API Proxy description)

Açıklaması bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

API Tipi

(API Type)

Kayıtları protokol tipi üzerinden filtreler.

Seçilebilecek değerler:

SOAP: SOAP olarak açılmış kayıtlar gelir.
REST: REST olarak açılmış kayıtlar gelir. (Not: Bir SOAP Backend API için oluşturulan API Proxy REST olabilir.)

API Proxy Tipi

(API Proxy Type)

API Proxy oluşturulurken seçilen tip üzerinden filtrelenir.

Seçilebilecek değerler:

Swagger
WSDL
Open API/Swagger 3.0.x
WADL
Fake API
Reverse Proxy
Mirror API
Empty API
KPS
DB-2-API
Script-2-API
Mock API

Kullanım Şekli

(Usage)

Kayıtları kullanım şekli alanı üzerinden filtreler.

Seçilebilecek değerler:

Hepsi (All): Bütün kayıtlar gelir.
Üretici (Publisher): Kurum/Firmanın, dışarıya hizmet vermek için oluşturduğu API Proxy'leri filtreler.
Tüketici (Consumer): Kurum/Firmanın tükettiği, kendisinin ya da başka kurum/firmaların açmış olduğu API'ler için oluşturulan API Proxy'leri filtreler.
Üretici ve Tüketici (Publisher & Consumer): Her iki rolü de üstlenen API Proxy'leri filtreler

Paylaşım Tipi

(Sharing Type)

API Proxy'nin Dış, İç veya Dış ve İç olarak paylaşım tipinin belirtildiği bölümdür.

Kategori

(Category)

Kayıtları kategorileri üzerinden filtreler.

API Proxy adresine göre ara

(Search by API Proxy relative path)

Geçit adresi bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Metot/Uç Nokta adına göre ara

(Search by Method/Endpoint)

Herhangi bir metot/endpoint'inin adı bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Metot/Uç Nokta açıklamasına göre ara

(Search by Method/Endpoint description)

Herhangi bir metot/endpoint'inin açıklaması bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Parametre adına göre ara

(Search by Parameter name)

Herhangi bir metot/endpoint'inin herhangi bir parametresinin adı bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Parametre açıklamasına göre ara

(Search by Parameter description)

Herhangi bir metot/endpoint'inin herhangi bir parametresinin açıklaması bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Router adrese göre ara

(Search by Routing address)

Router adresi bu filtre alanına girilen değeri içeren API Proxy kayıtları gelir.

Büyük küçük harf duyarlılığı yoktur.

Yükleme Durumu

(Deployment Status)

Kayıtları yüklenme durumu üzerinden filtreler.

Seçilebilecek değerler:

Hepsi (All): Bütün kayıtlar gelir.
Yüklenmiş: En az bir Ortam'a yüklenmiş, aktif durumda olanlar gelir.
Yüklenmemiş: Henüz hiç bir ortama yüklenmemiş ya da yüklemesi kaldırılmış olanlar gelir.

Ortam

(Environment)

Kayıtları ortam üzerinden filtreler.

Trace Modu

(Trace Mode)

Kayıtları izleme modu üzerinden filtreler.

Seçilebilecek değerler:

Aktif
Pasif

Uygulama Log Durumu
(Application Log Status)

Kayıtları uygulama log durumu üzerinden filtreler.

Seçilebilecek değerler:

Aktif
Pasif

Daha önce dışa aktarılmış (export) bir API Proxy listesini içe aktarma (import)

Dışa aktarılmış API Proxy'lerin içe aktarılabilmesi (importing) için, API Proxy Listesi arayüzündeki API Proxy'leri İçe Aktar (Import API Proxies) bağlantısına tıklanır.

API Proxy'leri İçe Aktar hakkında detaylı bilgi için tıklayınız.

API Proxy listesini Excel dosyası olarak indirme

Arayüzde görüntülenen API Proxy'ler, bir filtre varsa sadece filtrelenmiş elemanları içerecek şekilde bir Excel dosyası olarak indirilebilir. Bunun için arayüzün sağ üst köşesindeki Excel simgesine tıklamak yeterlidir.

Yeni API Proxy oluşturma

Yeni bir API Proxy oluşturmak için, arayüzün sağ üst köşesindeki +Create tuşuna tıklanır. Oluşturma detayları için API Proxy Oluşturma sayfasına bakabilirsiniz.

API Proxy bazında işlemler

Aşağıdaki işlemler, herhangi bir API Proxy kaydının en sağındaki menü simgesine tıklandığında açılan menüden seçilerek yapılabilir.

Bir API Proxy'i güncellemek için açma

Bir API Proxy kaydının adına tıklandığında, o API Proxy için güncelleme ve biçimlendirme arayüzü açılır.

Aynı arayüze, API Proxy kaydına ait popup menüdeki Düzenle (Edit) seçeneği ile de gidilebilir.

Bir API Proxy'i silme

API Proxy kaydına ait popup menüdeki Sil (Delete) seçeneğine tıklandığında bir onay penceresi açılır. Onay verilirse API Proxy silinir.

Bir API Proxy'i yeniden ayrıştırma

Bir API Proxy, URL belirtilerek, tanım dosyası yüklenerek ya da Apinizer üzerinde hazırlanmış olan bir tanım dosyası seçilerek oluşturulabilir. Bu kaynaklarda API Proxy oluşturulduktan sonra yapılan değişiklikler (örneğin yeni bir metot/endpoint ekleme, olanı silme, adres değişikliği), API Proxy tarafından bilinemez. Bu değişikliklerin API Proxy tarafından bilinir olması için manuel olarak API Proxy üzerinde güncelleme yapılabileceği gibi, Yeniden Ayrıştır (Reparse) seçeneği kullanılarak da bu işlem gerçekleştirilebilir.

HTTP metotları ve metot/endpoint adları aynı olsa bile metodun/endpoint'in açıklamaları, parametreleri, örnek mesajları, soap action vb. bilgileri yeni tanım dosyasındaki olacak şekilde güncellenir. Fakat daha önce ayarlanan politikalar ve API Proxy ayarların değişmez.

Bir API Proxy yeniden ayrıştırıldığında, var olan ad, açıklama ve metot/endpoint'ler karşılaştırılarak değişiklikler görüntülenir.

Yeni API'yi Etkinleştir (Apply New API) tuşuna tıklanırsa, orijinal API Proxy üzerindeki ayarlar yeniden ayrıştırma ile oluşturulacak yeni API Proxy'nin üzerine taşınır ve yeni oluşan API Proxy, orijinalinin yerine geçer.

Ayrıştırma sırasında parametre bazındaki farklar ekranda görüntülenmez. Parametre ya da tanım dosyasındaki farklılıklar Yeni API'yi Etkinleştir (Apply New API) tuşuna tıklandığında API Proxy'e uygulanır.

Bir API Proxy'i klonlama

Bir API Proxy'nin klonlanabilmesi mümkündür. Böylece klonlanan API Proxy'nin var olan ayarlarını başlangıç kabul eden yeni bir API Proxy oluşturulmuş olur. Versiyon oluşturmak ya da aynı API'yi farklı istemcilere, farklı adresler üzerinden ve belki az miktarda farklı ayarlarla açmak gibi amaçlar için, klonlama büyük kolaylık sağlar. Bir API Proxy'i klonlamak için API Proxy kaydının popup menüsündeki Kopyala (Duplicate) seçeneğine tıklanır.

Kopyalama ile oluşturulacak yeni API Proxy için kullanıcıdan yeni bir ad ve yeni bir geçit adresi girmesi istenir.

Bir API Proxy'i dışa aktarma

Seçilen API Proxy'i zip formatında indirme imkanı verir. Export butonuna tıklandığında API Proxy için indirme işlemi başlatılır.