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; kota/rate limit/onay/fiyat; aşımda Block 429 veya Continue & charge |
| 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.
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.
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
- Visibility ayarla
- Publish
- Gerekirse API Katalog ile paketleme durumunu doğrula