Uygulama Promote
Ne İşe Yarar?
- Uygulamaların önce Test’te doğrulanıp sonra Prod’a geçmesini zorunlu bir akışa bağlar
- TEST ve PROD credential’larını ayırarak üretim anahtarlarının erken üretilmesini engeller
- Promote isteğinde teknik iletişim, beklenen trafik, egress IP ve istenen belgelerle onay için bağlam sağlar
- Askıya alma ve silme talebiyle promote edilmiş uygulamaların yaşam döngüsünü güvenli yönetir
- Abonelik ekleme sihirbazı ve plan onayı ile ürün erişimini uygulama üzerinden yönetir
Kimler Kullanır?
- Geliştiriciler (Owner/Developer): Uygulama oluşturmak, abone olmak ve Prod’a promote istemek için
- Portal / Platform Yöneticileri: Prod Promotion ayarlarını, belge şablonlarını ve onay sürecini yönetmek için
- Güvenlik / Operasyon: Prod erişiminden önce belge ve ağ gereksinimlerini doğrulamak için
Ekrana Erişim
- Developer Portal: My Apps → uygulama detayı (Configuration, Traffic & Usage)
- Manager ayarı: Portal → Settings → Portal → Prod Promotion
- İlgili ortam URL’leri: Features / API Environments altında Production API base URL ve Sandbox API base URL (tüketiciye gösterilen adres; gateway routing’i değiştirmez)
Neden Promote Var?
Portalda oluşturulan uygulamalar varsayılan olarak Test only durumundadır ve TEST credential ile çalışır. Production anahtarları, onaylı promote sonrasında ayrı prod management bağlantısından okunur; böylece test anahtarları üretim trafiğinde kullanılmaz.
Uygulama promote durumu
| Durum | Anlamı |
|---|---|
| Test only | Yalnız test; PROD credential üretilmemiştir |
| Awaiting prod approval | Promote isteği gönderilmiş, onay bekleniyor |
| Prod active | Onaylanmış; PROD credential’lar kullanılabilir |
Manager — Prod Promotion Yapılandırması
| Alan | Ne işe yarar? |
|---|---|
Enable Prod Promotion (enablePromotion) | Manager’da Prod Promotion yapılandırma alanlarını (bağlantı, belgeler) açar/kapatır |
| Production instance connection | Ayrı Apinizer üretim instance’ı |
| Prod management API URL | Onaylı app/credential’ların okunduğu adres |
| Prod management API key | Şifreli saklanır; kayıttan sonra bir daha gösterilmez (boş bırakmak = değiştirme) |
| Requested documents | Ad, hint, allowed types, Required/Optional belge listesi |
Belge tanımlanmamışsa bilgi notu ile yalnızca onay yeterli olabilir. PROD credential’ların okunması için prod management URL + key bağlantısı gerekir.
enablePromotion portal ayarlarına promotionEnabled olarak iletilir. Mevcut Developer Portal UI, Promote butonunu bu bayrağa göre gizlemez; promote isteği (submitPromote) backend’de de bu bayrağı kontrol etmez. Akış uygulama promote durumuna (Test only → Awaiting prod approval → Prod active) göre yürür. Toggle kapalıyken Manager’da bağlantı/belge form alanları gizlenir.
My Apps — Configuration
Overview: uygulama adı, App Id (Reference Id), açıklama, durum rozeti, metadata (secret değerler maskeli).
Credential sekmeleri
| Sekme | Davranış |
|---|---|
| TEST Credentials | API Key / API Secret (maskeli + göster/gizle + copy), Status, Created, Revoke, Generate |
| PROD Credentials | Test only iken kilitli + Promote to Prod; onay beklerken durum; Prod active iken canlı liste + PROD API address |
Credential metadata (TEST satır altı, salt okunur): Key, Value (secret sürekli maskeli), Secret flag, Include in JWT, Include in Token Response, JWT Claim Name.
Secret görünürlüğü
| Veri | Owner / Developer | Viewer |
|---|---|---|
| API Key | Görünür + copy | Secret erişimi yok |
| API Secret | Maskeli + eye + copy | Görmemelidir |
| App / credential metadata secret | Maskeli | — |
| Prod management API key (Manager) | Kaydedilir; bir daha gösterilmez | — |
Create Application ve Abonelik
New application limiti Portal Settings maxAppCount ile sınırlıdır (varsayılan 3).
Name*, description, OAuth2 Redirect URI (https://; client-credentials için boş bırakılabilir)
Bir veya birden fazla ürün + plan seçimi
Özet; uygulama TEST credential ile oluşur. Prod için detayda Promote to Prod kullanılır.
Add subscription: Product & Plan → Confirm → Subscribe. Manuel onaylı planlarda abonelik admin onayından sonra aktif olur (Onay İstekleri). Kart aksiyonları: Change plan, Unregister.
Abonelik durumları (kart): Active (APPROVED) · Waiting for approval · Rejected · Disabled · Unsubscribed.
Promote to Prod Wizard
Aşamalar: Test → Info & Documents → Approval → Prod active
Zorunlu bağlam alanları:
- Prod technical contact (email)*
- Expected traffic* (
< 1,000/1,000–10,000/> 10,000req/day) - Static egress IPs*
- Documents (Manager’da required/optional tanımlı liste)
Review: test doğrulandı + terms & rate limits kabul → Send for approval → Awaiting prod approval → onay sonrası Prod active → credential’lar PROD Credentials sekmesinde.
Uygulama Yaşam Döngüsü
| Status | Anlamı |
|---|---|
| ACTIVE | Normal kullanım |
| SUSPENDED | Credential’lar disabled; abonelik/analytics korunur → Resume |
| PENDING_DELETION | Silme onayı bekliyor; key’ler revoke edilir, trafik durur |
| ARCHIVED | Arşiv |
Promote edilmiş (PENDING / PROD) uygulamada hard-delete yok → Suspend veya Request deletion. Yalnız Test only uygulamalarda hard-delete mantığı uygulanır.
Traffic & Usage (uygulama)
Uygulama detayındaki Traffic & Usage sekmesi KPI, kota, grafikler ve API Traffic’i uygulama kapsamında gösterir. Platform geneli için Trafik ve Kullanım.
Kullanım Senaryoları
- Partner entegrasyonu önce Test’te tamamlanır; belge paketiyle Prod onayı istenir
- Prod’a geçmiş uygulamada güvenlik olayı sonrası Suspend uygulanır
- Kota gerektiren Prod planına geçmeden önce Expected traffic bilgisi onay ekibine bağlam sağlar
- Viewer üyeler uygulamayı izler ama client secret görmez