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ı (Credentials & Subscriptions, 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 trafiğini uygulamanın kendi typed API Client'ı ile doğrular — bu istemci uygulamayla birlikte otomatik oluşturulur, bkz. aşağıda Credentials & Subscriptions — Kimlik bilgileri. 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 |
| Rejected | Promote isteği reddedilmiş; belgeleri düzeltip yeniden gönderebilirsiniz |
| 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 — Uygulama Detayı
Uygulama detayı iki sekmeden oluşur: Credentials & Subscriptions (Kimlik Bilgileri & Abonelikler) ve Usage (Kullanım). Sekmelerin üstünde ortak, sabit bir başlık kalır: uygulama adı, durum rozeti, açıklama, App Id (Reference Id, kopyala ikonlu) ve Edit düğmesi. Metadata listesi (secret değerler maskeli) ve promote isteği geçmişi bu başlığın altında, varsayılan olarak kapalı iki ayrı panelde durur.
Credentials & Subscriptions — Kimlik bilgileri
TEST | PROD bir düğme grubudur, alt sekme değildir; hangisi seçiliyse kartın altında o ortamın verisi görünür.
Bir uygulamanın TEST ortamında birden fazla API client'ı olabilir. Her client bir akordeon satırıdır: etiket, durum (Taslak / Aktif / Askıda / İptal edildi), aktif secret sayısı. Satırı açtığınızda Client ID düz metin olarak görünür ve yanındaki kopyala düğmesiyle alınır; yazma yetkiniz varsa New secret, ayrıca client aktifse Suspend, askıdaysa Resume düğmesi görünür. Bu düğmeler tek bir client'ı etkiler; uygulamanın tamamının askıya alınması ayrı bir işlemdir (bkz. aşağıdaki "Uygulama Yaşam Döngüsü").
Her client'ın secret tablosu şu kolonlardan oluşur: Label (Etiket), Secret, Status (Pending activation / Active / Grace period / Revoked), Created (Oluşturulma), Expires (Son geçerlilik), Actions (İşlemler).
Secret hücresi her zaman maskeli gelir. Show (Göster) düğmesi değeri istediğiniz anda sunucudan ister ve bu istek sunucu tarafında denetim kaydına (audit) yazılır; hesabınız saatte en fazla 10 kez secret gösterebilir, sınırı aştığınızda hata alırsınız ve bir süre sonra yeniden deneyebilirsiniz. Hide (Gizle) yalnızca ekranı tekrar maskeler, değeri sunucudan yeniden istemez. Gösterilen secret, sayfa açıkken tarayıcı belleğinde kalır; sayfayı kapattığınızda veya yenilediğinizde unutulur ve tekrar Show ile istemeniz gerekir.
- New secret (eski adıyla Rotate) aynı client'a ek bir secret üretir; bir client'ın aynı anda en fazla 5 geçerli secret'ı olabilir. Açılan pencerede isteğe bağlı bir Label (Etiket) yazın ve Expires (Son geçerlilik) listesinden Süresiz, 30 gün sonra, 90 gün sonra veya 1 yıl sonra seçeneklerinden birini seçin; varsayılan 90 gündür. Yeni secret bir kerelik pencerede gösterilir, sonra Show ile tekrar görüntülenebilir. Önceki secret, geçiş (grace) süresi boyunca (varsayılan 24 saat) çalışmaya devam eder; mevcut entegrasyonlar hemen kesilmez.
- Revoke (İptal Et) seçtiğiniz tek bir secret'ı hemen iptal eder ve onay ister. İptal edilen satır soluk görünür; Show ve kopyalama sunulmaz. Client'ın diğer secret'ları etkilenmez ve bu işlem geri alınamaz.
- New API Client (Yeni API Client) uygulamaya yeni bir client ekler. Pencerede yalnız Label (Etiket) alanı vardır. Client ID otomatik üretilir ve client'ın akordeon satırında kopyalanabilir biçimde görünür.
Show, New secret, Revoke ve New API Client (Yeni API Client), uygulamada yazma yetkisi olan üyeler içindir. Salt-görüntüleyici (Viewer) üyeler bu düğmeleri görmez; secret her zaman maskeli kalır.
PROD ortamında liste salt okunurdur: New API Client, New secret, Suspend/Resume ve Revoke bu ortamda yoktur, anahtarları platform ekibi sağlar. Uygulama henüz üretime alınmadıysa Promote to Prod çağrısı, onay bekliyorsa inceleme bilgisi görünür.
Credentials & Subscriptions — Abonelikler
Kimlik bilgileri kartının altında, aynı sekmede kalır. Abonelik ekleme sihirbazı ve kart aksiyonları (Change plan, Unregister) davranışı değişmedi; bkz. aşağıdaki "Create Application ve Abonelik" bölümü.
Secret görünürlüğü
PROD Credentials için geçerlidir; legacy API Key/Secret çifti artık Portalda hiç gösterilmiyor — yukarıdaki nota bakın. API Client secret görünürlüğü yukarıda, Credentials & Subscriptions — Kimlik bilgileri altında anlatılmıştır.
| Veri | Owner / Developer | Viewer |
|---|---|---|
| Client ID (TEST/PROD) | Görünür + kopyala | Görünür + kopyala |
| Secret (TEST) | Maskeli; Show ile görüntülenir ve kopyalanır | Her zaman maskeli, Show görünmez |
| Secret (PROD) | Salt okunur listede görünür | Salt okunur listede görünür |
| App / credential metadata secret | Maskeli | Maskeli |
| Prod management API key (Manager) | Kaydedilir; bir daha gösterilmez | — |
Subscriptions
Her ürün aboneliği satırında plan adı, abonelik durumu, etkin limit profili ve kullanım (tüketilen / limit) salt okunur gösterilir. Limit bu ekrandan değiştirilemez: Subscription Plan'ın varsayılan profili ya da API Manager tarafında tanımlanmış uygulama-özel bir override kullanılır — portal yalnızca sonucu gösterir. Abonelik ekleme, plan değiştirme ve aboneliği sonlandırma aksiyonları için bkz. Create Application ve Abonelik aşağıda.
Platform geneli kota/limit yönetimi Manager tarafında yapılır; bu sekme yalnızca uygulamanın görebildiği sonucu yansıtır.
Bu sürümden itibaren uygulamanın o an Onaylı (Approved) abonelikleri erişimi doğrudan da verir: her onaylı aboneliğin ürününe ait proxy ve API Proxy grup'larının birleşimi, uygulamanın kendi erişimi olarak — halihazırda bir legacy kimlik bilgisi varsa onun erişim listesinin sağladığı erişimin yanında — tutulur. Bu, uygulamanın typed bir API Client'ı olup olmadığından bağımsızdır; plan onayı, plan değiştirme, iptal ve uygulama silme aynı senkronizasyonu her durumda çalıştırır. Aboneliği iptal etmek, isteği reddetmek ya da uygulamayı silmek bu birleşimi daraltır — bir hedefe erişim, onu kapsayan başka hiçbir onaylı abonelik kalmadığı anda sonlanır. Yalnızca bu mekanizmanın kendi yazdığı erişim hakları bu şekilde güncellenir; Manager'da elle tanımlanmış ya da göç etmiş bir kimlik bilgisinden taşınmış erişime dokunulmaz. Bunun sonucu olarak, kendi legacy kimlik bilgisi olmayan bir uygulamaya artık ilk abone olduğunda otomatik olarak bir tane verilmez — typed API Client'ı ve bu erişim hakkı, aboneliğin anlamını zaten karşılar. Ne typed ne legacy — hiçbir kimlik bilgisi taşımayan nadir bir uygulamada, ilk aboneliği onaylandığında onay artık otomatik olarak typed bir API Client verir; bkz. Onay İstekleri API Ürün Uygulama Kaydı.
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; onaylandığında uygulamanın ilk API Client'ı uygulamayla aynı istekte, sunucu tarafında otomatik olarak oluşturulur (istemci üretilemezse uygulama da kaydedilmez, hata gösterilir: "Uygulama oluşturulamadı: ilk API Client üretilemedi") ve client secret'ı yalnızca o an düz metin olarak gösterilir (kopyalama düğmesiyle) — ekrandan ayrıldıktan sonra bir daha gösterilmez, yalnızca Rotate ile yenilenebilir. Prod için detayda Promote to Prod kullanılır.
Bu sihirbaz da, uygulama listesindeki hızlı Yeni Uygulama diyaloğu da artık UUID'li bir legacy API Key (username/password) üretmez; uygulama her iki yoldan da baştan typed bir API Client ile oluşur.
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 Credentials & Subscriptions sekmesinde PROD ortamında.
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.
Usage (uygulama)
Uygulama detayındaki Usage sekmesi KPI, kota, grafikler ve API Traffic’i uygulama kapsamında gösterir. Uygulama Prod ortamındaysa aynı sekmede ayrıca bir Production usage paneli görünür: tarih aralığı seçici, toplam/bloklanan/hatalı istek KPI'ları ve abonelik başına kullanım tablosu (ürün, plan, başarılı/bloklanan/hatalı istek, kota). Prod instance'a tam erişilemediğinde bu panelde bir uyarı görünür. 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