Bu sekmede, seçilen API Proxy ile ilgili genel ayarlar bulunur. 

Genel Bilgi sekmesini içeren görsele aşağıda yer verilmiştir:


Eğer ilgili API Proxy bir Gruba dahilse, API Proxy Grup Etkin (API Proxy Group Enabled) linkine tıklayarak API Proxy'nin ait olduğu Grup ekranına gidilebilir.


Yapılandır (Configure) butonuna tıklayarak açılan dialogu içeren görsele aşağıda yer verilmiştir:


Yapılandırma için kullanılan alanlar aşağıdaki tabloda görülmektedir.

AlanAçıklama
Adı
(Name)		API Proxy'ye kullanıcı tarafından verilen isimdir. Bu değer proje genelinde tekil (unique) olmalıdır.
Açıklama
(Description)		API Proxy'nin açıklama metnidir. Proxy'nin amacı, iş mantığı veya sağladığı fonksiyonlara ilişkin bilgi buraya yazılır.
Gateway'e Doğrudan Erişimi Devre Dışı Bırak
(Disable Direct Access To Gateway)		Bu seçenek etkinleştirildiğinde, Backend servisine doğrudan erişim engellenir. Servise yalnızca API Proxy üzerinden erişilebilir.
Client Route

API'ye gelen isteklerin hangi yoldan, hangi yöntemle ve hangi kriterlere göre yönlendirileceğini belirleyen bölümdür.

Bu bölüm birden fazla alt yapılandırma içerir:

1. Relative Paths
API Proxy için kullanılacak istemci yönlendirme yollarının tanımlandığı alandır. Örneğin:
• /NumberConversion
• /calculator

Her API Proxy için en az bir yol girilmelidir.

2. Methods
Bu Proxy'nin hangi HTTP metodlarını kabul edeceğini tanımlayan alandır. Örnek:
• GET
• POST
• PUT
• DELETE
• Patch
• Any (tümü)

Eğer yöntem belirtilmezse, sistem varsayılan davranış olarak tüm yöntemleri kabul edebilir.

3. Hosts
Bu alanda API Proxy'ye hangi hostlardan erişilebileceği tanımlanabilir. Tanımlı değilse, tüm hostlardan erişim mümkün olabilir. Host tanımlamak, çoklu domain yapılarında veya partner bazlı izolasyonlarda tercih edilir.

4. Headers
İsteklerin yalnızca belirli header koşullarını sağladığında API Proxy'ye kabul edilmesini sağlar. Header bazlı trafik yönlendirme veya ayırma senaryolarında kullanılır.

Detaylı Bilgi İçin Bakınız: API Proxy Client Route Kullanım Kılavuzu

Backend API Versiyon
(Backend API Version)		API Proxy'nin hangi Backend API versiyonuna karşılık geldiğinin girildiği alandır. Bu değer bilgilendirme ve versiyon yönetimi açısından önemlidir.
Kategori Listesi
(Category List)		API Proxy'leri sınıflandırmak için kullanılır. Örneğin:
• Finans
• CRM
• Bildirim
• Entegrasyon

Kategori seçimi API Portal kullanıcılarının API'leri daha kolay bulmasını sağlar.
Kullanım Şekli
(Usage)		API Proxy'nin kullanım tipini belirtir.

Seçenekler:
• Unspecified
• Publisher (Yalnızca üreten taraf)
• Consumer (Yalnızca tüketen taraf)
• Publisher & Consumer (Her iki kullanım da)

Bu değer API'nin proje içindeki rolünü belirtmek için kullanılır.
Paylaşım Tipi
(Sharing Type)		API Proxy'nin proje içinde veya dışında nasıl paylaşıldığını belirleyen alandır.

Seçenekler:
• Unspecified
• External
• Internal
• External and Internal

Örnek Yapılandırma Akışı

  1. Proxy adı ve açıklaması girilir.
  2. Client Route bölümünden yol (Relative Path) tanımlanır.
  3. Gerekirse yöntem, host veya header kısıtları eklenir.
  4. Güvenlik ayarları yapılır (Disable Direct Access To Gateway vb.)
  5. Kategoriler seçilir.
  6. Kullanım ve paylaşım tipi belirlenir.

Proxy Anahtarını Göster (Show Proxy Key)

API Proxy'nin erişim anahtarlarının yönetildiği bölümdür. Erişim anahtarları OAuth2 Kimlik Doğrulama Politikası için kullanılır. 

Client Id ve Client Secret değerleri otomatik olarak oluşturulur ve kullanıcı yenilerinin oluşturulmasını isteyebilir. Yüklenmiş bir API Proxy için anahtarlardan herhangi birisi yeniden oluşturulursa, anahtarların geçerli olabilmesi için API Proxy'nin yeniden yüklenmesi gerekir.


Proxy Anahtarını Göster bölümünü içeren görsele aşağıda yer verilmiştir:


Proxy Anahtarını Göster butonuna tıklandığında açılan dialogu içeren görsele aşağıda yer verilmiştir:


Client ID veya Secret alanlarının yanındaki yenileme butonuna tıklandığında açılan onay dialogu içeren görsele aşağıda yer verilmiştir:

Bu dialog, Client ID veya Secret yenileme işleminin geri alınamaz ve kritik bir işlem olduğunu hatırlatır. İşlemi onaylamak için API Proxy'nin adını yazmanız ve anahtar oluşturma tipini (Automatic veya Manual) seçmeniz gerekir.

Automatic seçeneğinde sistem otomatik olarak yeni değer oluşturur, Manual seçeneğinde ise kendi değerinizi girebilirsiniz.

Yükleme ve Tanım Dosyası Bilgileri (Deployment and Specification Information)

Yükleme bilgileri bölümü, API Proxy'in hangi ortamlara yüklendiğinin ve bu ortamdaki erişim adresinin görüntülendiği bölümdür. Bir API Proxy, aynı anda birden fazla ortama yüklenebilir.

Eğer API Proxy'den bir API Proxy Group oluşturulmuşsa o gruba ait bilgiler de bu alanda görüntülenir.

Yükleme bölümünü içeren görsele aşağıda yer verilmiştir:


Yükleme bölümü konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.

Alan

Açıklama

Ortam

(Environment)

API Proxy'nin yüklenmiş olduğu Ortam bilgisidir.

Erişim Tipi

(Access Type)

API Proxy'nin erişim tipinin bilgisidir.

URL

API Proxy'nin erişim adresidir. Geçit Adresi ve yüklenen Ortamın erişim adresi kullanılarak otomatik olarak üretilir.

Tanım Dosyaları

(Specs)

API Proxy'nin Tanım dosyalarıdır. Her API Proxy için Swagger ve OpenAPI formatlarında tanım dosyaları üretilir. Eğer API Proxy'nin tipi SOAP ise WSDL ve XSD tanım dosyaları da üretilecektir. Herhangi bir ortam için Göster (Show)  bağlantısına tıklandığında, API Proxy'nin o ortam için geçerli olan API Tanım Dosyaları görüntülenir.


Göster (Show) butonuna tıklandığında farklı tip ve formattaki API Proxy tanımlarını gösteren dialoga aşağıda yer verilmiştir:


Eğer ilgili API Proxy bir Gruba dahilse ve API Proxy Grup ekranından API Proxy'lere Direkt Erişimi Engelle seçeneği seçilmiş ise, bu bölümde bir uyarı kutucuğu gelir.

Tanım Dosyalarına API Proxy Üzerinden Erişim

Tanım dosyalarının içeriği, Göster (Show) bağlantısına tıklandığında yukarıdaki şekilde görüldüğü gibi açılır ve buradan kopyalanabilir. Ancak bu yöntem Apinizer platformu üzerinde çalışmakta olan API Geliştirici, API Testçi gibi rollerden kullanıcılar içindir. İstemciler bu arayüzlere erişemez.

İstemciler, tanım dosyalarına erişmek için API Proxy'nin yüklenmiş olduğu Ortamdaki erişim adresini aşağıdaki şekilde kullanabilirler:

Örneğin API Proxy'nin Production Ortamındaki erişim adresi https://demo.apinizer.com/apigateway/petstoreProxy olsun.

Tanım dosyalarına erişim için aşağıdaki adreslere istek gönderilebilir;

Swagger 2.x (JSON)

Swagger 2.x (YAML)

OpenAPI 3.x (JSON)

OpenAPI 3.x (YAML)

WSDL (API Proxy SOAP ise)