Genel Bilgi Sekmesi
Bu sekmede, seçilen API Proxy ile ilgili genel ayarlar bulunur.
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ırma
Yapılandır (Configure) butonuna tıklayarak açılan dialog ekranında API Proxy’nin temel bilgileri yapılandırılabilir.
Yapılandırma Alanları
| Alan | Açıklama |
|---|---|
| Adı | API Proxy’ye kullanıcı tarafından verilen isimdir. Bu değer proje genelinde tekil (unique) olmalıdır. |
| Açıklama | 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. Detaylı bilgi için Client Route sayfasına bakabilirsiniz. |
| 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 |
Detaylı Bilgi İçin Bakınız: API Proxy Client Route Kullanım Kılavuzu
Örnek Yapılandırma Akışı
- Proxy adı ve açıklaması girilir.
- Client Route bölümünden yol (Relative Path) tanımlanır.
- Gerekirse yöntem, host veya header kısıtları eklenir.
- Güvenlik ayarları yapılır (Disable Direct Access To Gateway vb.)
- Kategoriler seçilir.
- Kullanım ve paylaşım tipi belirlenir.
Proxy Anahtarını Göster
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.
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:
| Alan | Açıklama |
|---|---|
| Ortam | API Proxy’nin yüklenmiş olduğu Ortam bilgisidir. |
| Erişim Tipi | 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ı | 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. |
