Portal Settings (API Portal Ayarları), portal’ın temel ayarlarını, davranışlarını ve içerik sayfalarını kontrol eder. Bu sayfada genel ayarlar, e-posta bildirimleri, güvenlik ayarları, özellikler, yasal düzenlemeler, portal içerik yönetimi (Ana Sayfa, Footer, How It Works, Pending Page, Navigation Menu), SEO ayarları, Login Log (giriş günlükleri veritabanı ve konnektör yapılandırması) ve Danger Zone yapılır.Portal Appearance (Görünüm ve Tema) ise görsel öğeleri (logo, renkler, font) kontrol eder.
Genel Ayarlar
Portal’ın temel konfigürasyon ayarları bu bölümde yapılır.
Portal Ayarları Genel
Portal ayarlarında birden fazla dil seçeneği etkinleştirildiğinde, sistem otomatik olarak Çoklu Dil (Multilanguage) moduna geçer.Eğer Çoklu Dil özelliği Portal Ayarlarından aktif hale getirilmişse, Arayüz ve form alanları etkinleştirilen tüm dillerde görüntülenir ve her dil için ayrı veri girişi yapılabilir. Sistem, sadece Türkçe ve İngilizce ile sınırlı değildir; sistemde tanımlı tüm dilleri destekler (Almanca, Fransızca, İspanyolca, İtalyanca, vb.).Önemli: Her dil için içerik girişi yapılması gerekmektedir. Etkinleştirilen bir dil için içerik girilmezse, o dildeki sayfalar boş görünebilir.
E-Posta Bildirimleri
Portal’dan kullanıcılara gönderilen otomatik e-postalar bu sekmede yapılandırılır. Kullanıcı kayıt, onay, red, API abonelik gibi işlemlerde otomatik e-postalar gönderilir.
E-posta Ayarları
E-posta Şablonları
Portal’dan otomatik olarak gönderilen 8 farklı e-posta tipi vardır. Her birini ayrı ayrı özelleştirilebilir.E-posta Adresinizi Onaylayın
E-posta Adresinizi Onaylayın
Ne Zaman Gönderilir:
- Yeni bir kullanıcı portal’a kayıt olduğunda
- Kullanıcının e-posta adresini doğrulaması gerektiğinde
1
Kullanıcı Kayıt Olur
Portal’da “Register” butonuna tıklar, Kayıt formunu doldurur, “Sign Up” butonuna basar
2
Sistem E-posta Gönderir
“Confirm Email Address” e-postası otomatik gönderilir, E-posta, kullanıcının girdiği adrese ulaşır, Özel onay linki içerir
3
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik, Buton: Ayarladığınız buton metni (örn: “E-postamı Onayla”)
4
Kullanıcı Linke Tıklar
E-postadaki onay linkine/butonuna tıklar, Portal’a yönlendirilir, E-posta adresi doğrulanır
5
Sonraki Adım (Ayara Bağlı)
[Auto Approve Account = AKTIF ise] Hesap otomatik onaylanır, Welcome e-postası gönderilir, Kullanıcı portal’a girebilir[Auto Approve Account = PASIF ise] Yönetici onayı beklenir, “Hesabınız inceleniyor” mesajı gösterilir, Yönetici onayladıktan sonra Welcome e-postası gönderilir
Hoş Geldiniz
Hoş Geldiniz
Ne Zaman Gönderilir:
- Kullanıcının hesabı onaylandığında
- Yönetici tarafından manuel onay sonrası veya otomatik onay durumunda
1
Kullanıcı E-postasını Onaylamıştır
Kullanıcı “Confirm Email Address” mailindeki linke tıklamış, E-posta adresi doğrulanmış
2
Hesap Onaylanır (İki Senaryo)
[SENARYO 1: Auto Approve Account = AKTIF] Hesap otomatik olarak onaylanır, “Welcome” e-postası anında gönderilir[SENARYO 2: Auto Approve Account = PASIF] Yönetici bildirim alır, Yönetici Manager’a girer, Portal Management → Developer Accounts bölümüne gider, Bekleyen kullanıcıyı görür, [Approve] butonuna tıklar, “Welcome” e-postası gönderilir
3
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik, Buton: Ayarladığınız buton metni (örn: “Portal’a Git”)
4
Kullanıcı Portal'a Erişebilir
Artık portal’a giriş yapabilir, API’leri inceleyebilir, Uygulama kaydı yapabilir
Şifre Sıfırlama
Şifre Sıfırlama
Ne Zaman Gönderilir:
- Kullanıcı “Şifremi Unuttum” butonuna tıkladığında
- Yönetici kullanıcı için şifre sıfırlama işlemi başlattığında
1
Kullanıcı Şifresini Unutur
Portal giriş sayfasında “Forgot Password?” linkine tıklar, E-posta adresini girer, “Reset Password” butonuna basar
2
Sistem E-posta Gönderir
“Reset Password” e-postası otomatik gönderilir, E-posta, özel sıfırlama linki içerir, Link belirli süre geçerlidir (örn: 24 saat)
3
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik, Buton: Ayarladığınız buton metni (örn: “Şifremi Sıfırla”)
4
Kullanıcı Linke Tıklar
E-postadaki sıfırlama linkine/butonuna tıklar, Portal’da şifre sıfırlama sayfasına yönlendirilir, Yeni şifresini girer (2 kez)
5
Şifre Güncellenir
Yeni şifre kaydedilir, “Şifreniz başarıyla güncellendi” mesajı, Kullanıcı yeni şifresiyle giriş yapabilir
Hesap Erişimi Reddedildi
Hesap Erişimi Reddedildi
Ne Zaman Gönderilir:
- Yönetici kullanıcının kayıt talebini reddettiğinde
- Manuel onay sürecinde kullanıcı uygun görülmediğinde
1
Kullanıcı Kayıt Olmuş ve E-posta Onaylamıştır
Kullanıcı portal’a kayıt olmuş, E-posta adresini doğrulamış, Manuel onay bekliyor (Auto Approve Account = PASIF)
2
Yönetici Talebi İnceler
Yönetici Manager’a girer, Portal Management → Developer Accounts bölümüne gider, “Pending Approval” filtresi ile bekleyen kullanıcıları görür, İlgili kullanıcıyı inceler
3
Yönetici Talebi Reddeder
[Reject] butonuna tıklar, Red nedeni girerse (opsiyonel), Onaylar
4
Sistem İşlemi Gerçekleştirir
Kullanıcı hesabı pasif edilir veya silinir, “Account Access Rejected” e-postası gönderilir
5
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik
6
Kullanıcı Portal'a Erişemez
Giriş yapmaya çalışırsa hata alır, “Your account is not active” mesajı görür
Hesap Erişimi İptal Edildi
Hesap Erişimi İptal Edildi
Ne Zaman Gönderilir:
- Daha önce aktif olan bir kullanıcının erişimi iptal edildiğinde
- Yönetici tarafından kullanıcı devre dışı bırakıldığında
- Güvenlik veya politika ihlali durumunda
1
Kullanıcı Aktif Bir Hesaba Sahiptir
Kullanıcı daha önce onaylanmış, Portal’ı aktif olarak kullanıyor, API’lere erişimi var
2
İptal Nedeni Oluşur
Güvenlik ihlali tespit edilir, Kullanım politikası ihlal edilir, Sözleşme/üyelik sona erer, Manuel yönetici kararı
3
Yönetici Erişimi İptal Eder
Yönetici Manager’a girer, Portal Management → Developer Accounts bölümüne gider, İlgili kullanıcıyı bulur, [Revoke Access] seçer, İptal nedenini girer (opsiyonel), Onaylar
4
Sistem İşlemi Gerçekleştirir
Kullanıcı hesabı anında devre dışı bırakılır, Tüm aktif oturumlar kapatılır, API key’ler pasif edilir, “Account Access Rejected” e-postası gönderilir
5
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik
6
Kullanıcı Etkileri
Hemen çıkış yapılır (aktif oturum varsa), Tekrar giriş yapamaz, API çağrıları 401 Unauthorized döner, Tüm uygulama kayıtları pasif olur
Uygulama Kaydı Onaylandı
Uygulama Kaydı Onaylandı
Ne Zaman Gönderilir:
- Kullanıcının bir API’ye app kaydı talebi onaylandığında
- Yönetici manuel onay verdiğinde veya otomatik onay durumunda
1
Kullanıcı API'ye Abone Olmak İster
Kullanıcı portal’a giriş yapar, API katalogunu inceler, İlgili API’yi seçer, “Subscribe” veya “Register App” butonuna tıklar
2
Uygulama Bilgilerini Girer
Application Name girer, Description ekler, Plan seçer (Free, Basic, Premium vb.), “Submit” butonuna basar
3
Sistem Talebi İşler (İki Senaryo)
[SENARYO 1: Auto Approve API Subscribe = AKTIF] Kayıt otomatik onaylanır, API key’ler anında oluşturulur, “App Registration Approved” e-postası gönderilir[SENARYO 2: Auto Approve API Subscribe = PASIF] Yönetici bildirim alır, Yönetici Manager’a girer, API Management → Subscriptions bölümüne gider, “Pending Approval” filtresi ile bekleyen talepleri görür, İlgili talebi inceler, [Approve] butonuna tıklar, API key’ler oluşturulur, “App Registration Approved” e-postası gönderilir
4
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik (değişkenlerle zenginleştirilmiş), Buton: Ayarladığınız buton metni (örn: “API Dokümantasyonu”)
5
Kullanıcı API'yi Kullanmaya Başlar
Portal’da “My Apps” bölümüne gider, API key’lerini görür (Client ID, Secret), API dokümantasyonunu okur, İlk API çağrısını yapar, Test eder ve üretim ortamına alır
Uygulama Kaydı Reddedildi
Uygulama Kaydı Reddedildi
Ne Zaman Gönderilir:
- Kullanıcının API’ye app kaydı talebi reddedildiğinde
- Yönetici talebi uygun görmediğinde
1
Kullanıcı API'ye Abone Olma Talebi Yapmıştır
Kullanıcı API’ye subscribe olmuş, Uygulama bilgilerini girmiş, Manuel onay bekliyor (Auto Approve API Subscribe = PASIF)
2
Yönetici Talebi İnceler
Yönetici Manager’a girer, API Management → Subscriptions bölümüne gider, “Pending Approval” filtresiyle bekleyen talepleri görür
3
Yönetici Talebi Reddeder
[Reject] seçer, Red nedeni girer (opsiyonel, kullanıcıya gösterilmez), Onaylar
4
Sistem İşlemi Gerçekleştirir
Subscription talebi reddedildi olarak işaretlenir, API key’ler oluşturulmaz, “App Registration Rejected” e-postası gönderilir
5
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik, Buton: Giriş Yap
6
Kullanıcı Seçenekleri
Portal’da talebin reddedildiğini görür, Farklı bir plan ile tekrar deneyebilir, Destek ile iletişime geçebilir, Başka bir API’ye subscribe olabilir
Uygulama Kaydı İptal Edildi
Uygulama Kaydı İptal Edildi
Ne Zaman Gönderilir:
- Daha önce onaylanmış bir app kaydı iptal edildiğinde
- API kullanım politikası ihlali durumunda
- Yönetici tarafından erişim kaldırıldığında
1
Kullanıcı Aktif Bir Subscription'a Sahiptir
Kullanıcının app kaydı daha önce onaylanmış, API’yi aktif olarak kullanıyor, API key’leri çalışıyor
2
İptal Nedeni Oluşur
API kullanım politikası ihlali, Rate limit aşımları (sürekli), Ödeme sorunları (ücretli planlarda), Güvenlik ihlali tespit edilir, Kötüye kullanım (abuse) tespit edilir, Sözleşme sonlandırması, Manuel yönetici kararı
3
Yönetici Subscription'ı İptal Eder
Yönetici Manager’a girer, API Management → Subscriptions bölümüne gider, Active subscriptions listesinde ilgili subscription’ı bulur, [Revoke] seçer, İptal nedenini girer (opsiyonel), Onaylar
4
Sistem İşlemi Gerçekleştirir
Subscription anında iptal edilir, Tüm API key’ler devre dışı bırakılır, Rate limiter key’leri temizlenir, “App Registration Revoked” e-postası gönderilir
5
Kullanıcı E-postayı Alır
Subject: Ayarladığınız konu, Title: Ayarladığınız başlık, Body: Ayarladığınız içerik, Buton: Giriş Yap
6
Kullanıcı ve API Etkileri
O andan itibaren API çağrıları başarısız olur, HTTP 401 Unauthorized veya 403 Forbidden döner, Kullanıcı portal’da “Revoked” statusünü görür, Application sayfasında “Access Revoked” uyarısı
E-posta adresini onayla, Hoş Geldiniz, Hesap Erişimi Reddedildi, Hesap Erişimi İptal Edildi, Uygulama Kaydı onaylandı, Uygulama kaydı Reddedildi, Uygulama Kaydı İptal Edildi ve Şifre Sıfırlama mailleri için aşağıdaki görselde bulunan template kullanılmalıdır.
E-posta Şablonu
{{developer_fullname}}
- E-posta şablonunda {{developer_fullname}} kullanılırsa → Bildirimi alacak olan kullanıcının adı otomatik olarak o yere yazılır. Bu sayede gönderilen e-postalarda kişiye özel bir hitap sağlanmış olur
{{api_name}} - API ürün adı
{{application_name}} - Geliştiricinin uygulama adı
- E-posta şablonunda {{api_name}} kullanılırsa → Bildirimin ilgili olduğu API ürününün adı otomatik olarak o yere yazılır.
- E-posta şablonunda {{application_name}} kullanılırsa → Bildirimin ilgili olduğu uygulamanın adı otomatik olarak o yere yazılır.
Güvenlik
API Developer Portal tarafında kullanılacak olan gizlilik ayarları, bu ekran üzerinden yönetilir.
Güvenlik Ayarları
Özellikler
API Developer Portal tarafında kullanılacak olan özellikler, bu ekran üzerinden yönetilir.
Özellikler Ayarları
Yasal
API Developer Portal tarafında kullanılacak olan yasal ayarlar, bu ekran üzerinden yönetilir.
Yasal Ayarlar
Portal İçerik Yönetimi
API Portal Ayarları sayfasında, portalın içerik sayfalarını yönetebilirsiniz. Bu bölümde ana sayfa, footer, “Nasıl Çalışır” sayfası, bekleyen sayfa ve navigasyon menüsü ayarlarını yapabilirsiniz.
Portal İçerik Sayfaları Yönetimi
Portal Sayfalarına Genel Bakış
Her portal oluşturulduğunda, sistem otomatik olarak bir dizi varsayılan (default) sayfa oluşturur. Bu sayfalar portalın temel işlevselliğini sağlar ve kullanıcılar tarafından görüntülenebilir. Varsayılan Portal Sayfaları:Sayfa Erişim Durumları
Portal sayfaları, erişim durumlarına göre kategorize edilir:Public (Herkese Açık) Sayfalar
Public (Herkese Açık) Sayfalar
Public sayfalar, giriş yapmamış kullanıcılar dahil herkes tarafından görüntülenebilir:
- Portal Home: Ana sayfa herkese açıktır
- Footer: Tüm sayfalarda görünür
- How It Works: Özellik aktifse herkese açıktır
- Login Page: Giriş sayfası herkese açıktır
- Register Page: Kayıt izni varsa herkese açıktır
- API Catalog: Yayınlanmış API’ler herkese görünür (detaylar için giriş gerekebilir)
Public sayfalar, portalın tanıtımı ve kullanıcı kazanımı için kritik öneme sahiptir.
Private (Özel) Sayfalar
Private (Özel) Sayfalar
Private sayfalar, sadece giriş yapmış ve yetkili kullanıcılar tarafından görüntülenebilir:
- My Apps: Sadece giriş yapmış kullanıcılar kendi uygulamalarını görebilir
- Analytics: Sadece giriş yapmış kullanıcılar kendi istatistiklerini görebilir
- API Details: Bazı API detayları sadece abone olan kullanıcılara açıktır
- Pending Page: Sadece bekleme durumundaki kullanıcılar görür
Conditional (Koşullu) Sayfalar
Conditional (Koşullu) Sayfalar
Conditional sayfalar, belirli koşullara göre görünür veya gizlenir:
- How It Works: Portal Ayarları → Özellikler’de “How It Works” aktifse görünür
- Test Tools: Portal Ayarları → Özellikler’de “Test Tools” aktifse görünür
- Analytics: Portal Ayarları → Özellikler’de “Analytics” aktifse ve kullanıcı giriş yapmışsa görünür
- Jira Integration: Portal Ayarları → Özellikler’de “Jira Integration” aktifse görünür
Conditional sayfalar, portal yöneticisi tarafından özellik ayarlarından kontrol edilir.
Portal Sayfalarının Çalışma Mantığı
1. Sayfa Oluşturma ve Yönetimi: Her portal için sayfalar iki şekilde oluşturulur:- Sistem Tarafından Otomatik Oluşturulan Sayfalar
- Yönetici Tarafından Yönetilen Sayfalar
Otomatik Oluşturulan Sayfalar:
- Portal oluşturulduğunda sistem tarafından otomatik oluşturulur
- İçerikleri varsayılan değerlerle gelir
- İçerikler düzenlenebilir
- Login Page (Giriş Sayfası)
- Register Page (Kayıt Sayfası)
- API Catalog (API Kataloğu)
- My Apps (Uygulamalarım)
Bu sayfalar portalın temel işlevselliğini sağlar ve sistem tarafından yönetilir.
3. Çoklu Dil Desteği:
Portal sayfaları çoklu dil desteği sunar:
- Varsayılan Dil: Portal Ayarları → Genel Ayarlar’dan belirlenir (sistemde tanımlı tüm dillerden seçilebilir)
- Dil Seçenekleri: Sistemde tanımlı tüm dillerden istediğiniz kadarını aktif edebilirsiniz (Türkçe, İngilizce, Almanca, Fransızca, İspanyolca, İtalyanca, vb.)
- İçerik Yönetimi: Her dil için ayrı içerik hazırlanabilir
- Otomatik Yönlendirme: Sistem kullanıcının dil tercihine göre uygun içeriği gösterir
Çoklu dil özelliği aktif olduğunda, Portal Home, Footer, How It Works ve Pending Page için etkinleştirilen her dilde ayrı içerik hazırlanabilir. Sistem sadece Türkçe ve İngilizce ile sınırlı değildir; sistemde tanımlı tüm dilleri destekler.
- Portal Ayarları: Özellik ayarlarından sayfalar aktif/pasif yapılabilir
- Kullanıcı Durumu: Giriş yapmış/yapmamış kullanıcı durumuna göre
- Kullanıcı Rolleri: Kullanıcı rolüne göre (Admin, Developer, Guest)
- API Abonelik Durumu: Bazı sayfalar sadece abone olan kullanıcılara açıktır
Sayfa Yönetimi İşlemleri
Portal sayfalarını yönetmek için aşağıdaki işlemleri yapabilirsiniz:İçerik Düzenleme
Portal Home, Footer, How It Works ve Pending Page içeriklerini HTML editörü ile düzenleyin
Çoklu Dil Yönetimi
Her sayfa için etkinleştirilen tüm dillerde içerik hazırlayın (Türkçe, İngilizce, Almanca, Fransızca, vb.)
Önizleme
Değişiklikleri kaydetmeden önce önizleyin
Görünürlük Kontrolü
Sayfaların görünürlüğünü özellik ayarlarından kontrol edin
Portal Ana Sayfa (Portal Home)
Portal ana sayfası, kullanıcıların portala ilk girdiğinde gördükleri sayfadır. Bu sayfada portalın tanıtım metinleri, yönlendirici açıklamalar, bağlantılar veya görsel içerikler yer alır. Portal Ana Sayfası Özellikleri:Portal Ana Sayfa Ayarları
- Karşılama Başlığı: “Welcome to [Portal Name]”
- Kısa Açıklama: Portal hakkında genel bilgi
- Aksiyon Kartları:
- “How It Works?” - Nasıl çalışır sayfasına yönlendirme
- “Discover Our APIs” - API kataloğuna yönlendirme
- “Register” - Kayıt sayfasına yönlendirme
- “Contact Us” - İletişim sayfasına yönlendirme
Varsayılan içerik, portal yöneticisi tarafından tamamen özelleştirilebilir. HTML editörü ile istediğiniz içeriği ekleyebilirsiniz.
1
Portal Ana Sayfa Sekmesine Git
- API Portal Ayarları sayfasında “Portal Home” veya “Ana Sayfa” sekmesine tıklayın
- Ana sayfa içerik düzenleme ekranı açılır
2
İçerik Düzenleme
Sol tarafta HTML editörü bulunur. Bu editörde:
- HTML kodları yazabilirsiniz
- Markdown formatı kullanabilirsiniz
- Başlıklar, paragraflar, listeler, bağlantılar ekleyebilirsiniz
- Görseller ve tablolar ekleyebilirsiniz
HTML editörü zengin metin düzenleme özellikleri sunar. Kod görünümü ve görsel görünüm arasında geçiş yapabilirsiniz.
3
Çoklu Dil Desteği
Portal ayarlarında çoklu dil aktifse, etkinleştirilen her dil için ayrı sekme görürsünüz:
- Portal Home (TR): Türkçe içerik alanı
- Portal Home (EN): İngilizce içerik alanı
- Portal Home (DE): Almanca içerik alanı (eğer aktifse)
- Portal Home (FR): Fransızca içerik alanı (eğer aktifse)
- Ve diğer etkinleştirilen diller…
4
Önizleme
Sağ tarafta “Preview (Önizleme)” bölümü bulunur:
- Yazdığınız HTML içeriğinin portalda nasıl görüneceğini anlık olarak görebilirsiniz
- Değişiklikler yaparken önizleme otomatik güncellenir
- Mobil ve masaüstü görünümünü kontrol edebilirsiniz
5
İçeriği Kaydetme
- İçeriği hazırladıktan sonra sayfanın üst kısmındaki “Save” butonuna tıklayın
- Değişiklikler kaydedilir ve portal ana sayfasına anında yansır
- Portal kullanıcıları sayfayı yenilediğinde yeni içeriği görür
- Portal karşılama mesajı ve başlığı
- Portal hakkında kısa açıklama
- “How It Works?”, “Discover Our APIs”, “Register”, “Contact Us” gibi aksiyon kartları
- Öne çıkan API’ler veya özellikler
- Kurumsal bilgiler ve bağlantılar
- Görseller, banner’lar veya video içerikleri
- İstatistikler veya başarı hikayeleri
-
Giriş Yapmamış Kullanıcılar:
- Ana sayfayı görüntüleyebilir
- Portal hakkında bilgi alabilir
- “Register” butonuna tıklayarak kayıt olabilir
- “Discover Our APIs” ile API kataloğunu görebilir (sadece yayınlanmış API’ler)
-
Giriş Yapmış Kullanıcılar:
- Ana sayfayı görüntüleyebilir
- “My Apps” menüsüne erişebilir
- API’lere abone olabilir
- Analytics sayfasına erişebilir (özellik aktifse)
-
Yöneticiler:
- Ana sayfayı görüntüleyebilir
- Tüm özelliklere erişebilir
- Portal yönetim işlemlerini yapabilir
Ana sayfa içeriği HTML formatında olduğu için, CSS stilleri ve JavaScript kodları da kullanabilirsiniz. Ancak karmaşık script’ler portal performansını etkileyebilir. Güvenlik açısından sadece güvendiğiniz script’leri kullanın.
Footer (Alt Bilgi)
Footer, portalın en alt kısmında görüntülenen içerik alanıdır. Genellikle iletişim bilgileri, yasal metinler, telif hakkı ifadeleri veya kurumsal bağlantılar burada yer alır. Footer Özellikleri:
Varsayılan Footer İçeriği:
Portal oluşturulduğunda, footer varsayılan olarak boş veya minimal içerikle gelir. Yönetici tarafından özelleştirilmesi gerekir.
Footer Görünürlük Mantığı:
Footer, portalın tüm sayfalarında görünür:
- Ana sayfa (Home)
- API kataloğu (API Catalog)
- API detay sayfaları
- How It Works sayfası
- Login ve Register sayfaları
- Kullanıcı paneli sayfaları (My Apps, Analytics)
Footer içeriği, portalın tüm sayfalarında tutarlı bir şekilde görüntülenir. Bu sayede kullanıcılar her sayfada iletişim bilgilerine ve yasal bağlantılara erişebilir.
1
Footer Sekmesine Git
- API Portal Ayarları sayfasında “Footer” veya “Alt Bilgi” sekmesine tıklayın
- Footer içerik düzenleme ekranı açılır
2
Footer İçeriğini Düzenleme
Sol taraftaki HTML editöründe footer içeriğini hazırlayın:
- İletişim bilgileri (adres, telefon, e-posta)
- Sosyal medya bağlantıları ve ikonları
- Yasal metinler (Kullanım Koşulları, Gizlilik Politikası)
- Telif hakkı (Copyright) bilgisi
- Kurumsal bağlantılar ve linkler
- Logo veya görseller
Footer içeriği HTML formatında olduğu için, tablolar, listeler ve bağlantılar ekleyebilirsiniz.
3
Çoklu Dil Desteği
Çoklu dil aktifse:
- Footer (EN): İngilizce footer içeriği
- Footer (TR): Türkçe footer içeriği
4
Önizleme ve Kaydetme
- Sağ tarafta footer’ın portalda nasıl görüneceğini önizleyebilirsiniz
- Değişiklikleri yaptıktan sonra “Save” butonuna tıklayın
- Footer içeriği portalın alt kısmına anında yansır
- Şirket adı ve logosu
- İletişim bilgileri (adres, telefon, e-posta)
- Sosyal medya ikonları (LinkedIn, Twitter, GitHub vb.)
- Hızlı bağlantılar (Hakkımızda, Destek, Dokümantasyon)
- Yasal bağlantılar (Kullanım Koşulları, Gizlilik Politikası)
- Telif hakkı bilgisi (© 2024 Şirket Adı)
How It Works (Nasıl Çalışır)
“How It Works” sayfası, portal kullanıcılarına sistemin genel işleyişini, API erişim sürecini veya kayıt/adım adım kullanım rehberini anlatan bilgilendirici sayfadır. How It Works Özellikleri:
Varsayılan How It Works İçeriği:
Portal oluşturulduğunda, How It Works sayfası varsayılan içerikle gelir:
- Başlık: “How It Works” veya “Nasıl Çalışır”
- Genel Açıklama: Portal kullanımı hakkında genel bilgi
- Adım Adım Rehber: Temel kullanım adımları
- API Erişim Süreci: API’lere nasıl erişileceği
- Kayıt Süreci: Portal’a nasıl kayıt olunacağı
How It Works sayfası, portal yöneticisi tarafından tamamen özelleştirilebilir. İçeriğe adım adım rehber, görseller, ikonlar ve örnekler eklenebilir.
-
Özellik Aktifse:
- Portal Ayarları → Özellikler → “How It Works” aktifse
- Portal üst menüsünde “How It Works?” linki görünür
- Herkes (giriş yapmış/yapmamış) sayfaya erişebilir
-
Özellik Pasifse:
- Portal üst menüsünde link görünmez
- Sayfa içeriği hazırlanmış olsa bile kullanıcılar erişemez
- Direkt URL ile erişim mümkün olmayabilir
1
How It Works Sekmesine Git
- API Portal Ayarları sayfasında “How It Works” veya “Nasıl Çalışır” sekmesine tıklayın
- How It Works içerik düzenleme ekranı açılır
2
İçerik Hazırlama
Sol taraftaki HTML editöründe içeriği hazırlayın:
- Adım adım kullanım rehberi
- API erişim süreci açıklaması
- Kayıt ve hesap oluşturma adımları
- API kullanım örnekleri
- Sık sorulan sorular
- İkonlar, numaralı listeler ve görseller
How It Works sayfası, kullanıcı deneyimini artırmak ve portalın kullanımını açıklamak için hazırlanır.
3
Çoklu Dil Desteği
Çoklu dil aktifse:
- How It Works (EN): İngilizce içerik
- How It Works (TR): Türkçe içerik
4
Portal Menüsünde Görünüm
- How It Works sayfası, portal üst menüsünde “How It Works?” veya “Nasıl Çalışır?” linki olarak görünür
- Bu linke tıklandığında hazırladığınız içerik gösterilir
- Menüde görünmesi için Portal Ayarları → Özellikler bölümünde “How It Works” özelliğinin aktif olması gerekir
5
Kaydetme
- İçeriği hazırladıktan sonra “Save” butonuna tıklayın
- Değişiklikler kaydedilir ve portal menüsünden erişilebilir hale gelir
- Portal’a kayıt olma adımları
- API’leri keşfetme ve inceleme süreci
- Uygulama kaydı ve API abonelik süreci
- API key’leri alma ve kullanma
- API çağrısı yapma adımları
- Sorun giderme ve destek bilgileri
Pending Page (Bekleyen Sayfa)
Pending Page, kullanıcıların hesap onayı beklerken veya belirli bir işlem tamamlanana kadar görüntüledikleri bekleme sayfasıdır. Bu sayfa, kullanıcılara durumları hakkında bilgi verir ve ne yapmaları gerektiğini açıklar. Pending Page Özellikleri:
Varsayılan Pending Page İçeriği:
Portal oluşturulduğunda, Pending Page varsayılan içerikle gelir:
- Başlık: “Your Account is Pending Approval” veya “Hesabınız Onay Bekliyor”
- Açıklama: Hesap onay süreci hakkında bilgi
- Bekleme Mesajı: “Your account is being reviewed. You will be notified once it’s approved.”
- İletişim Bilgisi: Destek ekibi ile iletişime geçme talimatları
Pending Page içeriği, kullanıcıların durumlarını anlamalarına ve ne yapmaları gerektiğini bilmelerine yardımcı olmalıdır. Güven verici ve bilgilendirici bir ton kullanılmalıdır.
Hesap Onayı Bekleme
Hesap Onayı Bekleme
Senaryo: Kullanıcı kayıt oldu ve e-posta onayladı, ancak hesap henüz yönetici tarafından onaylanmadı.Koşullar:
- Portal Ayarları → Güvenlik → “Auto Approve Account” = PASIF
- Kullanıcı e-posta adresini onaylamış
- Yönetici henüz hesabı onaylamamış
- Kullanıcı giriş yapmaya çalıştığında Pending Page görüntülenir
- “Your account is pending approval” mesajı gösterilir
- Kullanıcı portal içeriğine erişemez
API Abonelik Onayı Bekleme
API Abonelik Onayı Bekleme
Senaryo: Kullanıcı bir API’ye abone oldu, ancak abonelik henüz onaylanmadı.Koşullar:
- Portal Ayarları → Güvenlik → “Auto Approve API Subscribe” = PASIF
- Kullanıcı API’ye abone olmuş
- Yönetici henüz aboneliği onaylamamış
- Kullanıcı API detay sayfasına gittiğinde Pending Page görüntülenebilir
- “Your subscription is pending approval” mesajı gösterilir
- API’yi kullanamaz
Hesap Askıya Alınma
Hesap Askıya Alınma
Senaryo: Kullanıcı hesabı geçici olarak askıya alındı.Koşullar:
- Yönetici kullanıcı hesabını askıya almış
- Hesap tamamen silinmemiş, sadece geçici olarak devre dışı
- Kullanıcı giriş yapmaya çalıştığında Pending Page görüntülenir
- “Your account is temporarily suspended” mesajı gösterilir
- İletişim bilgileri verilir
1
Pending Page Sekmesine Git
- API Portal Ayarları sayfasında “Pending Page” veya “Bekleyen Sayfa” sekmesine tıklayın
- Pending Page içerik düzenleme ekranı açılır
2
Bekleme Sayfası İçeriğini Hazırlama
Sol taraftaki HTML editöründe içeriği hazırlayın:
- Kullanıcıya durum hakkında bilgi veren mesaj
- Ne yapması gerektiğini açıklayan talimatlar
- Bekleme süresi hakkında bilgi
- İletişim bilgileri (sorular için)
- Görsel öğeler (ikonlar, animasyonlar)
Pending Page, kullanıcıların hesap onayı beklerken veya manuel onay sürecinde görüntülediği sayfadır.
3
Çoklu Dil Desteği
Çoklu dil aktifse:
- Pending Page (EN): İngilizce içerik
- Pending Page (TR): Türkçe içerik
4
Ne Zaman Görüntülenir
Pending Page aşağıdaki durumlarda görüntülenir:
- Kullanıcı kayıt oldu ve e-posta onayladı, ancak hesap henüz onaylanmadı (Auto Approve Account = PASIF)
- Kullanıcı API’ye abone oldu, ancak abonelik henüz onaylanmadı (Auto Approve API Subscribe = PASIF)
- Kullanıcı hesabı askıya alındı veya geçici olarak devre dışı bırakıldı
5
Kaydetme
- İçeriği hazırladıktan sonra “Save” butonuna tıklayın
- Değişiklikler kaydedilir ve bekleme durumundaki kullanıcılar bu sayfayı görür
- “Hesabınız onay bekliyor” mesajı
- Onay süreci hakkında bilgi
- Bekleme süresi tahmini
- İletişim bilgileri (sorular için destek ekibi)
- Durum kontrolü için talimatlar
- Güven verici mesajlar
Navigation Menu (Navigasyon Menüsü)
Navigation Menu, portalın üst kısmında görünen menü yapısını yönetmenizi sağlar. Bu menüde hangi sayfaların görüneceğini, sıralamasını ve görünürlüğünü kontrol edebilirsiniz. Navigation Menu Özellikleri:
Varsayılan Menü Öğeleri:
Portal oluşturulduğunda, aşağıdaki varsayılan menü öğeleri otomatik olarak oluşturulur:
Varsayılan menü öğeleri sistem tarafından otomatik oluşturulur ve silinemez. Ancak görünürlükleri ve sıralamaları değiştirilebilir.
- Her Zaman Görünür
- Özellik Aktifse Görünür
- Giriş Yapmış Kullanıcılar İçin
Sistem Menü Öğeleri:
- Home: Her zaman görünür (silinemez)
- APIs: Her zaman görünür (silinemez)
Navigasyon Menüsü Yönetimi
1
Navigation Menu Sekmesine Git
- API Portal Ayarları sayfasında “Navigation Menu” veya “Navigasyon Menüsü” sekmesine tıklayın
- Navigasyon menü yönetim ekranı açılır
2
Menü Öğelerini Yönetme
Navigasyon menüsünde aşağıdaki işlemleri yapabilirsiniz:Menü Öğeleri:
- Home: Ana sayfa linki
- APIs: API kataloğu sayfası
- How It Works: Nasıl Çalışır sayfası (özellik aktifse görünür)
- Test Tools: Test araçları sayfası (özellik aktifse görünür)
- My Apps: Kullanıcının uygulamaları sayfası (giriş yapmış kullanıcılar için)
- Analytics: Analytics sayfası (özellik aktifse ve kullanıcı giriş yapmışsa)
- Görünürlük: Menü öğesinin görünür olup olmayacağını belirleyin
- Sıralama: Menü öğelerinin sırasını değiştirin (sürükle-bırak veya sıra numarası)
- Etiket: Menü öğesinin görünen adını değiştirin
- Bağlantı: Menü öğesinin yönlendireceği sayfayı belirleyin
3
Menü Öğesi Ekleme
Yeni bir menü öğesi eklemek için:
- ”+ Add Menu Item” veya ”+ Menü Öğesi Ekle” butonuna tıklayın
- Menü öğesi formu açılır
- Etiket: Menüde görünecek adı girin
- Bağlantı: Yönlendirilecek URL’i girin (iç veya dış bağlantı)
- Sıra: Menüdeki konumunu belirleyin
- Görünürlük: Hangi kullanıcılar için görünür olacağını seçin (Tümü, Sadece Giriş Yapmış, Sadece Misafir)
- “Save” butonuna tıklayın
4
Menü Öğesi Düzenleme
Mevcut bir menü öğesini düzenlemek için:
- Menü öğesinin yanındaki “Edit” veya düzenleme ikonuna tıklayın
- Menü öğesi formu açılır
- Değişiklikleri yapın
- “Save” butonuna tıklayın
5
Menü Öğesi Silme
Bir menü öğesini silmek için:
- Menü öğesinin yanındaki “Delete” veya silme ikonuna tıklayın
- Onay dialogunda “Yes” deyin
- Menü öğesi menüden kaldırılır
6
Menü Sıralamasını Değiştirme
Menü öğelerinin sırasını değiştirmek için:
- Menü öğesini sürükleyip istediğiniz konuma bırakın (drag & drop)
- Veya sıra numarası alanından sırayı değiştirin
- Değişiklikler anında önizlenir
7
Kaydetme
- Tüm değişiklikleri yaptıktan sonra sayfanın üst kısmındaki “Save” butonuna tıklayın
- Menü yapısı kaydedilir ve portal üst menüsünde anında görünür
Navigasyon menüsü, portalın kullanıcı deneyimini doğrudan etkiler. Menü yapısını kullanıcıların ihtiyaçlarına göre düzenleyerek daha iyi bir deneyim sunabilirsiniz.
Portal İçerik Yönetimi Özeti
Portal Sayfalarının Yönetim Mantığı: Portal içerik yönetimi, aşağıdaki prensiplere göre çalışır: 1. Varsayılan Sayfalar:- Her portal oluşturulduğunda sistem tarafından otomatik oluşturulur
- Varsayılan içeriklerle gelir
- İçerikleri özelleştirilebilir
- Portal Ayarları → Portal İçerik Yönetimi bölümünden yönetilir
- HTML formatında içerik eklenebilir
- Çoklu dil desteği vardır
- Önizleme özelliği bulunur
- Public Sayfalar: Herkese açık (giriş yapmamış kullanıcılar dahil)
- Private Sayfalar: Sadece giriş yapmış kullanıcılar
- Conditional Sayfalar: Özellik ayarlarına göre görünür/gizlenir
- Portal Ayarları → Genel Ayarlar’da çoklu dil aktifse
- Her sayfa için Türkçe ve İngilizce içerik hazırlanabilir
- Sistem kullanıcının dil tercihine göre uygun içeriği gösterir
- İçerik değişiklikleri anında portala yansır
- Sayfa yenileme (refresh) yeterlidir
- Tarayıcı cache’i temizlenmesi gerekebilir
SEO
API Developer Portal tarafında kullanılacak olan SEO ayarları, bu ekran üzerinden yönetilir.
SEO Ayarları
Login Log
Login Log sekmesi, API Portal Ayarları üst çubuğunda SEO ile Danger Zone arasında yer alır. Bu sekmede portal kullanıcılarının giriş denetim kayıtlarının MongoDB’ye yazılıp yazılmayacağı ve tanımlı konnektörlere (Elasticsearch, Kafka, Webhook vb.) iletilip iletilmeyeceği yönetilir; ayarlar portala özeldir.
Olay tipleri, JSON örneği ve konnektör ekleme adımları için bkz. Login Log Konnektör Yapılandırması (Portal bölümü). Giriş kayıtlarını görüntüleme ve filtreleme için bkz. API Portal Giriş Kayıtları.
Danger Zone (Tehlikeli Bölge)
Danger Zone, portal için kritik ve geri alınamaz işlemlerin yapıldığı bölümdür. Bu bölümde portal silme gibi kalıcı işlemler yer alır.
Danger Zone - Kritik İşlemler
Portal Silme
Portal silme işlemi, portalı ve tüm verilerini kalıcı olarak siler. Bu işlem geri alınamaz.1
Danger Zone Sekmesine Git
- API Portal Ayarları sayfasında “Danger Zone” veya “Tehlikeli Bölge” sekmesine tıklayın
- Kritik işlemler listelenir
2
Portal Silme Butonuna Tıklama
- “Delete Portal” veya “Portali Sil” butonuna tıklayın
- Onay dialogu açılır
3
Portal Adını Onaylama
- Onay dialogunda portal adını tam olarak yazmanız istenir
- Portal adını doğru girdiğinizden emin olun
- Bu adım yanlışlıkla silmeyi önlemek içindir
4
Silme İşlemini Onaylama
- Portal adını doğru girdikten sonra “Yes, Delete” veya “Evet, Sil” butonuna tıklayın
- Portal kalıcı olarak silinir
- Tüm veriler (kullanıcılar, API’ler, içerikler, istatistikler) silinir