API Ürünleri
API Ürünü veya API Product Nedir?
API Product, bir veya daha fazla API'nin birleştirilmesiyle oluşturulan bir üründür. Bu API'ler, farklı kaynaklardan veya sistemlerden veri alışverişinde bulunarak birleştirilebilir ve son kullanıcılara bir arayüz olarak sunulabilir.
API Product'lar, API'lerin kullanımını ve yönetimini kolaylaştırırken, geliştiricilerin farklı API'leri bir arada kullanarak kendi uygulamalarını veya hizmetlerini geliştirmelerine de yardımcı olur.
API Developer Portal'da yayınlanan ya da taslak aşamasında olan tüm API Ürünleri, bu ekrandan yönetilir.
Listeleme ekranının iki farklı görünümü bulunmaktadır; grafik ve liste.
Grafik görünümü ekran detaylarını içeren görsele aşağıda yer verilmiştir:
Liste görünümü ekran detaylarını içeren görsele aşağıda yer verilmiştir:
Yeni Bir API Ürünü Oluşturma
Bir API Ürünü, API Proxy ya da API Proxy Grup'dan oluşturulabilir. Bu işlemde, üç aşama bulunur; API Ürün Bilgileri, Görünürlük ve Plan & Monetization.
API Ürün Bilgileri Paneli
API Ürün bilgilerini içeren görsele aşağıda yer verilmiştir:
API Ürün bilgileri konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Ad (Name) | API Ürününün Portal'da gözükeceği ad bilgisidir. |
Resim (Image) | API Ürününün Portal'da gözükecek olan avatar resmidir. |
Başlık (Title) | API Ürününün Portal'da gözükecek olan genel amacının yer aldığı açıklama bilgisidir. |
Kategoriler (Categories) | API Ürünü bir kategoriye dahil edilebilir. Böylelikle, Portal üzerinde arama yapıldığında kategoriye göre filtrelenebilir. |
Sorumlu Birim (Responsible Unit) | API Ürününü oluşturulan sorumlu birimin girildiği alandır. |
Uygulamalardan gelen erişim istekleri (Access requests from applications) | Bu seçenek aktifleştirilirse, uygulamalardan gelen erişim istekleri onay gerektirmeden direkt olarak API Ürüne abone olabilir. |
API Proxy/API Proxy Grup (API Proxy/API Proxy Group) | API Ürünü ile bağdaştırılacak, API Proxy/API Proxy Group ayarlarının yapıldığı bölümdür. |
Dokümanlar (Documents) | API Ürününü kullanıcılar ile paylaşmak için eğitim gibi ekstra belgelerin yönetildiği bölümdür. |
Açıklama (Description) | API Ürününün Portal'da gözükecek olan ve API ürününe ait detaylı bilgi, Portal üzerinde görüntülenebilecek şekilde dinamik HTML formatında eklenir. |
Görünürlük Paneli
API Ürününün Görünürlük ayarlarını içeren görsele aşağıda yer verilmiştir:
Görünürlük ayarları için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Herkes görüsn (Public) | API Ürününü herkes görebilir. |
Sadece giriş yapanlar (Only logged in Organizations) | API Ürününü sadece API Portal'e giriş yapan kurumlar görebilir. |
Sadece Yetkili Kurumlar (Authorizated Organizations) | API Ürününü sadece burada tanımlanmış yetkili kurumlar görebilir. |
Plan & Monetization Paneli
API Ürününün yayımlanması için en az bir tane plan&monetization bulundurmalıdır. 4 farklı plan bulunmaktadır; Free, Subscription, Metered ve Tiered.
Free Plan
Bu plan seçilirse, ücretsiz bir şekilde API Ürünü tüketilebilir. Daraltma (throttling) ve kota (quota) eklenebilir.
Free plan seçeneklerini içeren görsele aşağıda yer verilmiştir:
Free plan konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Daraltmayı Etkinleştir (Enable Throttling) | Her saniye/dakika bazında, API'ye belirli bir süre içinde gidecek istek sayısı sınırlandırılabilir. |
Kotayı Etkinleştir (Enable Quota) | Her saat/gün/ay bazında, API'ye belirli bir süre içinde gidecek istek sayısı sınırlandırılabilir. |
Subscription Plan
Bu plan seçilirse, aylık veya yıllık olarak ödeme planı oluşturulur. Tüketim aşım durumunda ise yeni ücretlendirme ya da durdurma yöntemi uygulanabilir.
Subscription plan seçeneklerini içeren görsele aşağıda yer verilmiştir:
Subscription plan konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Daraltmayı Etkinleştir (Enable Throttling) | Her saniye/dakika bazında, API'ye belirli bir süre içinde gidecek istek sayısı sınırlandırılabilir. |
Kotayı Etkinleştir (Enable Quota) | Her saat/gün/ay bazında, API'ye belirli bir süre içinde gidecek istek sayısı sınırlandırılabilir. |
Hacim-bazlı Ücret (Volume-based Fee) | Yapılan ayarlamalar, aylık ya da yıllık olarak uygulanır. |
Para Birimi (Currency) | Para birimi türk lirası, dolar, euro olarak belirlenebilir. |
Fatura Dönemi (Billing Period) | Fatura dönemi aylık (monthly) veya yıllık (annually) olarak seçilebilir. |
Aşıldığında Devam Et (Continue on Exceed) | Belirlenen ödeme planı aşıldığı durumda kullanıma devam etme seçeneği seçilir. Eğer aktif değilse, belirlenen istek hacmi aşıldığında tüketim durdurulur. |
Aşıldığında Ücret (Fee on Exceed) | Ödeme planı aşıldıktan sonraki kullanımlar için ücret belirlenir. |
Metered Plan
Bu plan seçilirse, istek başına ücretlendirme uygulanır.
Metered plan seçeneklerini içeren görsele aşağıda yer verilmiştir:
Metered plan konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Arama Ücreti (A Call Fee) | Bir isteğin ücreti girilir. |
Para Birimi (Currency) | Para birimi türk lirası, dolar, euro olarak belirlenebilir. |
Fatura Dönemi (Billing Period) | Fatura dönemi aylık (monthly) veya yıllık (annually) olarak seçilebilir. |
Tiered Plan
Bu plan seçilirse, katmanlı bir ödeme planı oluşturulur. Örneğin; ilk 1-10 arası istek başına 10 lira, 10-50 arası istek başına 5 lira, 50-100 arası istek başına 1 lira ... vs. şeklinde farklı aralıklara farklı ücretler belirlenebilir.
Tiered plan seçeneklerini içeren görsele aşağıda yer verilmiştir:
Tiered plan konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Calls From | Katmanın ilk değeri belirlenir. |
Calls To | Katmanın son değeri belirlenir. |
Fee | Belirlenen katman aralığındaki ücret belirlenir. |
Fatura Tipi (Billing Type) | Katman ücretlendirmesi, toplam katman bazında belirlenmek isteniyorsa Volume-based ya da katmandaki her bir istek için ücretlendirme yapılacak ise Transaction-based seçimi yapılır. |
Para Birimi (Currency) | Para birimi türk lirası, dolar, euro olarak belirlenebilir. |
Fatura Dönemi (Billing Period) | Fatura dönemi aylık (monthly) veya yıllık (annually) olarak seçilebilir. |
Aşıldığında Devam Et (Continue on Exceed) | Belirlenen ödeme planı aşıldığı durumda kullanıma devam etme seçeneği seçilir. Eğer aktif değilse, belirlenen istek hacmi aşıldığında tüketim durdurulur. |
Aşıldığında Ücret (Fee on Exceed) | Ödeme planı aşıldıktan sonraki kullanımlar için ücret belirlenir. |
API Ürününü Yayınlama (Publish)
API Ürününün yayınlanması için sağlanması gereken 2 durum vardır: Bir planı ve API Proxy'nin Security Manager tipinde bir Kimlik Doğrulama Politikası olmalı.
Bu iki şart sağlandığı takdirde API Ürünü Katalogda yayınlanmak için hazır demektir. API Ürününü yayına almak için Yayınla (Publish) butonuna basılır ve API Ürünü katalogda gözükmeye başlar.
API Product yayınladıktan sonra, bu tanımı silmeden sadece API Katalog'da gözükmesini engellemek için yayından geri alınabilir (unpublished).
API Ürününü Silme
API Ürününü tamamen silmek için, ilgili ürünün düzenleme sayfasına gidilir. Sayfanın en altında API Ürünü Sil (Delete API Product) başlığı yer alır.
API Ürünü silmek istediğini onaylamak için ilgili ürünün adının yazılması istenen bir onay kutusu açılır. Ürün adı doğru bir şekilde yazılıp Sil (Delete) butonuna tıklandığında Ürün tamamen silinmiş olur.
API Ürünü Sil butonuna tıklandığında açılan onay kutusunu içeren görsele aşağıda yer verilmiştir:
