API Ürünü
Ne İşe Yarar?
- Gateway’deki API’leri portal vitrininde ürün olarak sunar
- Birden fazla proxy/proxy group’u tek üründe paketler
- Free / Flat rate / Metered / Tiered planlarla kota, rate limit ve onay politikası tanımlar
- Görünürlükle keşfedilebilirliği; plan onayıyla erişimi ayırır
- Abonelikleri org’a ait uygulamalar üzerinden izler
Kimler Kullanır?
-
Portal / Ürün Yöneticileri: Ürün oluşturmak, paketlemek, plan tanımlamak ve yayınlamak için
-
Geliştiriciler: Portalda ürünü keşfedip uygulama+plan ile abone olmak için
-
Destek / Operasyon: Abonelik ve kullanım özetini doğrulamak için
bilgi
Paketleme envanteri (hangi proxy hangi üründe?) → API Katalog.
Uygulama yaşam döngüsü / Unregister → Uygulama Yönetimi.
Test→Prod → Uygulama Promote.
Canlı kota/trafik → Trafik ve Kullanım.
:::
Ekrana Erişim
- Manager: Portal → API Products
- Developer Portal vitrin: üst menü API’ler (APIs)
- Yetki: Portal ürün yönetimi rollerine bağlıdır
Model
API Catalog (proxy / proxy group)
│ Select APIs from the Catalog
▼
API Product (proxyRefs + OpenAPI + Plans)
│ subscribe
▼
Portal App (organizasyon) + Plan → ApiProductAppRegister
│
▼
App credential + ACL (paketlenmiş proxy’ler)
- Abonelik = (uygulama, bu ürün, seçilen plan)
- Kota abonelik başına uygulanır
- Aynı proxy birden fazla üründe yer alabilir
- Canlı WAITING/APPROVED abonelik varken paketten API çıkarılamaz; yalnızca eklenebilir
Oluşturma (sihirbaz)
Yayınlanmamış ürün oluşturur. Tipik adımlar: General → APIs → API Spec → Plans → Environment → Summary.
| Konu | Kod gerçeği |
|---|---|
| API seçimi | Catalog’dan 1..n proxyRefs (proxy ve/veya group birlikte olabilir) |
| Spec | Ürüne yüklenen OpenAPI (JSON/YAML). Çoklu proxy’de tek proxy swagger’dan türetme yok |
| Yayın | Create sonrası Unpublished; ayrıca publish gerekir |
Manager detay sekmeleri
API Specification ve test konsol
Dökümantasyon yönetimi
| Sekme | Ne içerir |
|---|---|
| API Specification | Ürün OpenAPI / endpoint görünümü |
| Documentation | Portal doküman sayfaları |
| Files | İndirilebilir dosyalar |
| Plans | Active/Retired planlar; Duplicate; fiyat/onay; kota ve hız limiti doğrudan plan üzerinde sayı olarak girilir ve sistem bu sayılardan gateway'in uyguladığı limit profilini kendisi üretir — bkz. Abonelik Planı Limit Profilleri |
| Subscriptions (N) | Salt okunur: org → app → plan + durum + kullanım özeti |
| Security | Paketlenen proxy’lerde tutarlı ACL-managed auth; hazır değilse publish engeli |
| Visibility | Keşfedilebilirlik (erişim/onay planlarda) |
| Danger Zone | Unpublish / Delete |
Manuel plan onayları ürün Subscriptions özetinde yapılmaz; API Product App Registers / Onay İstekleri tarafındadır.
Bu Subscriptions panelindeki kullanım özeti, trafiği yalnızca eski kullanıcı adı/parola credential'ı taşıyan uygulamalara değil, kimliği tipli bir API İstemcisi (client id, trafik satırının username/key alanıyla eşleşir) olan uygulamalara da atfeder.
Plan tipleri
| UI (EN) | Anlam |
|---|---|
| Free | Ücretsiz |
| Flat rate | Sabit ücret (eski “Subscription” adı değil) |
| Metered | Kullanım bazlı |
| Tiered | Kademeli |
Her abonelikte tüketici tek plan seçer. Onay: plan seviyesinde Auto approval / Approval Required. Ürün seviyesinde auto-approve alanı deprecated’tir; dokümanda öğretilmez.
Plan editöründe aşım davranışı için Engelle (429) ve Devam et ve ücretlendir seçenekleri sunulur. Metered (Kullanım başına) ve Tiered (Kademeli) fiyatlama tiplerinde her çağrı zaten faturalandığı için Engelle seçeneği ekranda pasiftir ve seçilemez — bu fiyatlama tiplerinde aşımda istek reddedilmez, yalnızca sayılır. Planın fiyatlama tipini Metered veya Tiered'a değiştirdiğinizde, önceden Engelle seçili olsa bile aşım seçimi otomatik olarak Devam et ve ücretlendir'e döner.
Plan limitlerinin uygulanabilmesi için gereken kimlik doğrulama
Plan limitleri isteği yapan tüketiciye göre sayılır. Bu nedenle ürüne bağlı her proxy'nin, isteğin kimin adına geldiğini belirleyebilmesi gerekir. Proxy tüketiciyi tanıyamazsa istek anonim kabul edilir, planın kotası ve rate limiti hiç uygulanmaz ve aşımda 429 dönmez.
Bir proxy şu durumda tüketiciyi tanır:
| Proxy'deki durum | Plan limiti uygulanır mı |
|---|---|
| Aktif Basic / Base64 / Digest / mTLS kimlik doğrulama politikası | Evet |
| Aktif JWT veya OAuth2 politikası, token'ı üçüncü taraf üretiyor | Evet |
| Aktif JWT veya OAuth2 politikası, token'ı Apinizer üretiyor, grant type password ve sağlayıcı Secret Manager (ACL) | Evet |
| Aktif JWT veya OAuth2 politikası, token'ı Apinizer üretiyor, grant type password ama sağlayıcı LDAP / Veritabanı / API | Hayır — yalnızca imza doğrulanır, tüketici çözülmez |
| Aktif JWT veya OAuth2 politikası, token'ı Apinizer üretiyor ve grant type client_credentials | Hayır — yalnızca imza doğrulanır, tüketici çözülmez |
| Aktif JWT veya OAuth2 politikası, kimlik kaynağı bir OIDC kimlik sağlayıcısı ve token isteğin anında bu sağlayıcıya doğrulatılıyor (onay türü password dışında) | Sağlayıcıda Eşleşen Consumer Zorunlu Olsun açıksa Evet, kapalıysa Hayır — token doğrulanır ama isteğe bir Consumer bağlanmaz |
| Kimlik doğrulama politikası var ama pasif | Hayır |
| Hiç kimlik doğrulama politikası yok | Hayır |
| Yalnızca OIDC oturum doğrulaması | Hayır |
| Yalnızca JOSE Uygulama politikası | Hayır — JOSE Uygulama imzalar/şifreler, kimlik doğrulamaz; kimlik doğrulama politikası yokmuş gibi değerlendirilir |
Kimlik doğrulama politikası doğrudan proxy'de değil, aktif bir Politika Grubu'nun içinde de olabilir; bu durumda politika grubun içinden de sayılır. Politika grubunun kendisi pasifse içindeki hiçbir politika çalışmaz — grup içindeki kimlik doğrulama politikası aktif olsa bile tüketici tanınmaz. Bu kural hem yukarıdaki tabloya hem Security sekmesindeki tüketici kimliği kolonuna aynı şekilde uygulanır (Apinizer 2026.09.4).
Politikayı etkinleştirmek tek başına yeterli değildir: değişiklik proxy yeniden yüklenene (redeploy) kadar ağ geçidine ulaşmaz.
Bu durum artık üç yerde uyarı olarak gösterilir:
- Manager > API Product > Planlar ve Abonelikler sekmelerinin üstünde sarı uyarı. Metin, tüketiciyi tanımayan proxy'lerin nedenine göre değişir: tanımayan proxy'lerin tümünde tek sebep pasif bir kimlik doğrulama politikasıysa politikayı etkinleştirip yeniden yüklemeniz istenir; tanımayan proxy'lerin tümünde sebep token'ın yalnızca imzayla doğrulanması ya da kimlik doğrulama şemasının tüketiciyi hiç tanımlamamasıysa onay türünü ya da kimlik sağlayıcıyı değiştirmeniz istenir; sebepler karışıksa ya da tanımayan proxy'lerden birinde hiç kimlik doğrulama politikası yoksa nedeni Security sekmesinden görmenizi isteyen genel bir uyarı gösterilir. Bağlı proxy'lerin hepsi tüketiciyi tanıyor ama en az biri henüz yeniden yüklenmediyse, bunun yerine yalnızca yeniden yükleme gerektiğini belirten ayrı bir uyarı görünür (Apinizer 2026.09.4).
- Manager > API Product > Security sekmesindeki proxy tablosunda Tüketici kimliği kolonu: her proxy için "Tanınıyor" / "Tanınmıyor" ve tanınmama nedeni.
- Developer Portal ürün sayfası > API Specification: kimlik doğrulama tipi pasif bir politikadan geliyorsa tipin yanında (pasif) etiketi ve altında tüketiciye yönelik uyarı.
Uyarı proxy'nin tüketiciyi tanımadığını söylüyorsa, bu trafiğin portalın Pano ve Trafik sayfalarında da görünmeyeceğini belirtir.
JWT politikası ACL'den Yönet modundaysa portal ürün sayfası token adresini /auth/jwt yerine /credential/jwt ile gösterir ve proxy anahtarlarını göstermez. Portal test ekranı ve portal MCP token aracı aynı adresi ve tüketicinin credential'ını kullanır.
Abonelik Planı Limit Profilleri
Plan ekranında girdiğiniz hız limiti ve kota değerleri, gateway'in fiilen uyguladığı limitlerdir. Kaydettiğinizde sistem bu sayılardan plana ait bir İstek Hızı limit profili üretir, yürürlüğe koyar ve planın onaylı tüm aboneliklerini bu profile bağlar. Sayıları değiştirdiğinizde profil yeni değerlerle güncellenir; sayıları tamamen kaldırdığınızda profil bu abonelik planından ayrılır: ona zaten bağlı aboneliklere uygulanmaya devam eder, yeni aboneliklere limit uygulanmaz ve profil katalogda düzenlenebilen sıradan bir plana dönüşür.
Bu profil kataloğa da yazılır ama düzenlemeye kapalıdır ve varsayılan olarak listede görünmez — tek düzenleme noktası plan ekranıdır. Ayrıntı: Limit Planları.
Hız limiti ve kota en az 1 çağrıya izin vermelidir. 0 (ya da negatif bir sayı) girilerek kaydedilen bir plan, kaydedilmeden önce reddedilir ve hangi kutunun düzeltilmesi gerektiğini söyleyen bir uyarı gösterilir — sıfır limit hiçbir trafiğe izin vermez ve gateway'in uygulayabileceği bir profile dönüştürülemez. Bir planı hız limitsiz ya da kotasız bırakmak için sıfır yazmak yerine ilgili kutucuğun işaretini kaldırın.
İşaretli bir kutucuğun yanındaki sayıyı boş bırakmak da "limit yok" anlamına gelmez: Hız Limiti ya da Kota kutucuğu işaretliyken sayı zorunludur, kutunun altında bir uyarı çıkar ve sayı girilene kadar Kaydet düğmesi pasif kalır. O limiti kapatmak için kutucuğun işaretini kaldırın.
Dışa/içe aktarma ile — ya da bir portal kopyalamasıyla — gelen bir plan, limit profilini içe aktarmanın bir parçası olarak alır ve sayılarını hemen uygular; ayrıntı: Dışa/İçe Aktarma.
Eski bir sürümde oluşturulmuş bir planda, hiçbir profilin karşılamadığı bir hız limiti ya da kota görünüyorsa plan ekranı bu limitlerin gateway'de uygulanmadığını bildiren bir uyarı gösterir. Değerleri kontrol edip planı kaydedin; profil kaydetme sırasında oluşturulur ve uyarı kaybolur.
Plan ekranında katalogdan profil seçilmez. Gateway her zaman planın kendi sayılarından üretilen profili uygular. Önceki bir sürümden kalan katalog İstek Hızı profilini kullanan plan, bir sonraki kayıtta kendi profilini alır.
Bir plan, ekranın önceki bir sürümünde seçilen bir AI token bütçesi limit planını hâlâ kullanabilir. Plan ekranı bu bütçeyi AI token bütçesi bölümünde gösterir. Kaldır, bütçeyi kaydettiğinizde plandan kaldırır. Bütçe kaldığı sürece ekran yalnız bütçeyle uyumlu aşım seçeneğini sunar.
Değişiklik Etki Önizlemesi
Kayıtlı bir planda bazı değişiklikler kaydetmeden önce bir onay penceresi açar: aşım davranışının değişmesi, AI token bütçesinin kaldırılması ya da katalog İstek Hızı profilinin yerini kendi profilinin alması. Pencere, değişiklikten etkilenecek abonelik ve uygulama sayısını gösterir. Pencere yalnız planın onaylı aboneliği varsa açılır. Onaylamadan devam edilirse değişiklik kaydedilmez.
Tipli Limit Bağlama
Bir abonelik onaylandığında, seçilen plandaki Limit Profili referansları o abonelik sahibi uygulama için uygulama seviyesinde bir bağlama (binding) doğurur; bu bağlama uygulamanın tüm trafiğine uygulanır.
- Plan değişikliği aynı bağlamayı yeni plana taşır, sayaç sıfırlanmaz.
- Abonelik sona erdiğinde bağlama, aynı uygulamanın başka bir aktif aboneliğine devredilir (varsa); yoksa bağlama da sona erer.
- Aynı uygulama ve aynı plan ailesi için her zaman tek bir bağlama bulunur. İki farklı abonelik aynı aile için farklı bir profil istiyorsa, mevcut bağlama korunur; onay ekranında bu durum bir uyarıyla bildirilir ve profili değiştirmek isteyen operatör Profili Değiştir eylemiyle bilinçli bir geçiş yapar (bkz. Onay İstekleri).
- Birden çok projede kullanılan portal uygulamalarının bağlaması admin projesi altında tutulur.
Sürüm Yükseltmesi
Sürüm yükseltmesi elle bir işlem gerektirmez. Yükseltmede, kota/hız limiti değeri girilmiş her ürün planı için otomatik bir İstek Hızı limit profili oluşturulur (önceki sürümde oluşturulmuş otomatik profiller varsa yenisi açılmaz, mevcut olan devralınır), plan bu profile bağlanır ve onaylanmış aboneliklerin uygulama seviyesindeki bağlamaları da aynı adımda kurulur. Limit taşımayan planlar Kapalı kalır.
Aynı adımlar her gece yeniden çalışır; bir plan herhangi bir nedenle profilsiz kalırsa (içe aktarma, ortam terfisi, elle veri düzeltmesi) en geç ertesi gün kendiliğinden düzelir. Bağlama var olduğunda ne yaptığı için Limit Planları sayfasındaki Limitlerin Uygulanması bölümüne bakın.
Görünürlük
| Tip | Anlam |
|---|---|
| Public | Herkese keşfedilebilir |
| Only logged in Organizations | Oturum açmış kurumlara |
| Authorized Organizations | Yetkili kurum listesine |
Görünürlük = keşif. Abone olma onayı plan ayarındadır.
Danger Zone
- Unpublish: Vitrinden gizler; mevcut abonelikler çalışmaya devam edebilir
- Delete: Aktif abonelik varken engellenir
Developer Portal ürün sayfası
| Sekme | Koşul |
|---|---|
| Overview | Açıklama + plan kartları |
| API Specification | Auth özeti, endpoint, Try It |
| Documentation | Yayınlı doküman; unpublished ise kilit |
| Applications & Plans | Giriş şart — app bazında Register / + Add plan / Unregister |
| Dashboard & Traffic | Giriş + Features Analytics açık — dashboard + trafik tablosu |
| Files | Dosya listesi |
Abonelik consumer tarafında (ürün veya My Apps sihirbazları) başlar. Manager uygulama editinde yalnızca Unregister vardır.
Yayınlama kontrol listesi
- Catalog’dan API’leri paketle
- OpenAPI yükle
- En az bir Active plan tanımla (kota/rate/onay)
- Security hazır olsun — bağlı proxy'lerde aktif ve tüketiciyi tanıyan bir kimlik doğrulama politikası bulunsun, aksi halde plan limitleri uygulanmaz (ayrıntı)
- Visibility ayarla
- Publish
- Gerekirse API Katalog ile paketleme durumunu doğrula