Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt

Use this file to discover all available pages before exploring further.

Bu dokümanda API Portal menüsüne nasıl erişilebileceği ve **API Portal’**de görüntülenecek olan API Proxy ve API Proxy Group’ları nasıl API Product olarak tanımlayabileceğiniz adım adım açıklanacaktır.

​
Portal Menüsüne ve API Product Tanımlama Ekranına Erişim

Apinizer API Portal ile API/Web Servisler merkezi bir yerden vitrin haline getirip API Kullanıcılarının kullanımına sunabilir, plan tanımlamalarınıza özel quota veya throttling politikalarıyla kullanıcıların sahip oldukları plana göre API tüketimini yönetebilirsiniz. Bir API Proxy’i API Portal üzerinden yayınlamak için API Product tanımlaması yapılması gerekmektedir. Portal menüsüne sadece admin menüleri üzerinden ve uygun yetkilerle erişim vardır. Portal Menüsü “Portal” menüsü içerisinde bulunan “API Products” menüsüne girilerek sağ üstte bulunan Create butonuna tıklayarak yeni API Product tanımlaması için gerekli bilgilerin girişi gerçekleştirilir.
Burada seçeceğiniz API Proxy / API Proxy Group’un bir güvenlik politikası ile korunuyor olmasını, güvenlik politikası bulunmayan API Proxy / Proxy Group’un Portal kullanımına güvenlik sebebiyle açılmamasını tavsiye ediyoruz.
Burada seçilen aktif kullandığınız API Proxy / API Proxy Group’u direk yayınlamamanızı, farklı bir projede ilgili API Proxy / API Proxy Group’un bir replikasını API Portal üzerinde yayınlanmanızı tavsiye etmekteyiz. Bu sayede bu API product’ınıza gelecek trafiği diğerinden yalıtarak, daha kontrollü bir ortam oluşturabilirsiniz.
API Product tanımlamaya başlamadan önce API Product tanımlı API Product’ları yönetmeyi kolaylaştıran Category ve Responsible Unit tanımlamaları yaparak onların da kullanımını görmek gerekir:

​
Responsible Unit / Category Tanımlama

Sol menüde Portal altında bulunan “Definitions” sekmesi altından “Responsible Units” ve “Categories” menüleri içerisinden yeni Responsible Units ve Category tanımlaması yapabilir, var olan Responsible Unit ve Categoryleri görüntüleyebilir, düzenleyebilirsiniz. Definitions Menüsü

​
Responsible Unit Tanımlama

Portal menüsü altında bulunan Definitions bölümünden Responsible Unit sayfasına girerek mevcut Responsible Unit’lerinizi görüntüleyebilir, güncelleyebilir veya bir yenisini ekleyebiliriz. Responsible Unit, API Product’lardan sorumlu birimi temsil eder. Yeni bir Responsible Unit tanımlamak veya var olanları görüntülemek, düzenlemek için Portal sekmesi altında bulunan Definitions menüsü içerisinden Responsible Unit’e tıklanır. Responsible Unit Menüsü Açılan sayfada Responsible Unitleri görüntüleyebilir, güncelleyebilir ve yeni bir tane oluşturabiliriz. Responsible Unit Listesi Yeni bir Responsible Unit oluşturmak için sağ üstte bulunan Create butonu tetiklenir. Responsible Unit Oluşturma Save butonu tetiklendikten sonra açılan sayfadaki alanlar doldurarak yeni bir Responsible Unit tanımlaması gerçekleştirilir. Responsible Unit Formu
Parent Unit, ilgili Responsible Unit’in bağlı olduğu birimi referans göstermektedir. Burada alt birim - üst birim ilişkisi kurularak Responsible Unit tanımlaması gerçekleştirilmesi tarafımızca tavsiye edilir. listeleme ekranında üst birimleri ilgili birim tanımlamalarının yanında görüntüleyerek yönetimini gerçekleştirebilirsiniz.

​
Category Tanımlama

Category tanımlaması, API Product’ları kategorilere dahil ederek API Portal üzerinden arama yapıldığında kategoriye göre filtrelenerek gelişmiş arama yapılabilmesini sağlar. Yeni Category tanımlaması yapmak için Portal menüsü içerisinden Definitions sekmesi altından Categories sayfasına gitmemiz gerekir. Categories Menüsü Categories sayfası içerisinde daha önce tanımlanmış Category’leri görüntüleyebilir, güncelleyebilir veya yeni bir tane ekleyebilirsiniz. Categories Listesi Create butonu tetiklenerek yeni bir Category tanımlaması gerçekleştirilebilir. Category Oluşturma Tanımlanmak istenen Category’nin ismini girerek save tuşu tetiklenir. Category Formu Category Kaydedildi Categories sayfası içerisinde listeleme ekranında yeni eklemiş olduğumuz Category’i görüntülüyor olacağız. Categories Listesi Güncellendi

​
API Product Tanımlama Ve Tanımlanan API Product’ın API Portal Üzerinde Yayınlanması

Aşağıdaki görsellerde bulunan ekran üzerinden gerekli alanları doldurarak API Product tanımlaması yapabiliriz.
API Product tanımlamayla ilgili alanları daha detaylı olarak API Ürünleri sayfasından inceleyebilirsiniz.
Örnek bir tanımlamaya aşağıdaki ekran görüntülerinde yer verilmiştir. API Product Formu - 1 API Product Formu - 2 API Product Formu - 3 Visibility ve Plan & Monetization alanları API Product tanımlaması için fazlasıyla önem arz etmektedir.
İlgili alanlar hakkında daha detaylı bilgi edinmek için API Ürünleri sayfasını inceleyebilirsiniz.
Public: API Product, API Portal’a üye olan / olmayan herkesçe görüntülenebilir. Only Logged In Organizations: API Product’ı sadece giriş yapan kurumlar görebilir. Authorized Organizations: API Product için yetkilendirilmiş kurumlar görüntüleyebilir. Visibility Seçenekleri Free: Ücretsiz bir şekilde API Product’ın tüketilmesini sağlar Subscription: Aylık veya yıllık abonelik sistemi üzerine çalışır. Tüketim aşım durumunda ek ücretlendirmeler veya durdurma işlemleri gerçekleştirilebilir. Metered: İstek başına ücretlendirme uygulanır. Tiered: Katmanlı bir ödeme planı oluşturulur. Plan Tipleri Plan Konfigürasyonu
İhtiyaca göre quota veya throttling hangi plan seçilirse seçilsin uygulanabilir.
Plan seçim adımında Enable Throttling veya Enable Quota seçenekleri aktif edilerek API Product’ın istek akışı limitlendirilebilir. Aşağıdaki görselde Free plan seçimi yapılmış ve dakikada 50 istek sınırı olacak şekilde Throttling uygulaması gerçekleştirilmiştir. Free Plan Throttling Save butonuna basarak API Product tanımlaması tamamlanır. API Product Kaydedildi API Product tanımlamasından sonra API Portal tarafında API Product’ın yayınlanabilmesi için sağ üst köşede bulunan “unpublished” butonunun tetiklenmesi ve açılan popup üzerinden publish edillmesi gerekir. Yayınlama Popup'ı Yayınlama Onayı Yukarıdaki adımları tamamladıktan sonra API Products liste ekranında yayınlanan API Product’ı published statüsüne sahip bir şekilde görüntüleyebiliyor olacağız. API Products Listesi - Yayınlanmış