Sık Sorulan Soruların Kullanımı
Tanımlanan sorular, API Developer Portal üzerinde “Frequently Asked Questions” sayfasında görüntülenir. Kullanıcılar bu alanda sık sorulan soruları kategoriye göre filtreleyebilir, detaylı yanıtları inceleyebilir. Bu yapı sayesinde:- API tüketicileri sık karşılaşılan konularda hızlı çözüm bulur,
- Destek yükü azalır,
- Portalın kullanım kolaylığı ve rehberlik gücü artar.
Liste Ekranı Alanları
| Alan | Açıklama |
|---|---|
| Soru (Question) | İngilizce olarak sık sorulan sorunun metnidir. API Portal’da kullanıcı dil tercihi İngilizce olduğunda bu alan görüntülenir. |
| Cevap (Answer) | Soruya ait yanıt metnidir. Açıklayıcı ve bilgilendirici olmalıdır. |
| Categori (Category) | Soru hangi konuya ait ise burada kategori seçilir. |
| Soru(TR) (Question(TR)) | Çoklu dil desteği aktif olduğunda görüntülenir. Sorunun türkçe versiyonu bu alana girilir. |
| Cevap(TR) (Answer(TR)) | Çoklu dil desteği aktif olduğunda görüntülenir. Sorunun türkçe yanıtı bu alana girilir. |
| Categori(TR) (Category(TR)) | Türkçe kategori adıdır. Portal türkçe dilinde görüntülendiğinde bu değer gösterilir. |
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, 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.).
Yeni Soru Oluşturma
Yeni bir sık sorulan soru oluşturmak için ekranın sağ üst kısmındaki Create (+) butonuna tıklanır. Açılan pencerede (modal) aşağıdaki alanlar doldurularak kayıt işlemi tamamlanır. Zorunlu alanlar (* ile işaretli) doldurulduktan sonra Save butonuna basılarak kayıt sisteme eklenir. Sık Sorulan Sorular ekran detaylarını içeren görsele aşağıda yer verilmiştir:
1
Adım 1: FAQ Liste ekranını açın
Sol menüden Portal Management başlığını genişletin.
FAQ menü öğesine tıklayın.
Mevcut soruların listelendiğini doğrulayın.
2
Adım 2: Yeni FAQ Formunu açın
Sayfanın üst kısmındaki New FAQ butonuna tıklayın.
frequently-asked-questions-update bileşeni modal form olarak açılır.
3
Adım 3: Temel bilgileri girin
Question alanına portal kullanıcılarının göreceği soruyu yazın.
Answer alanına detaylı yanıtı Markdown desteğiyle girin (paragraflar, listeler, linkler kullanılabilir).
Category alanından mevcut kategori seçin veya yeni kategori oluştur seçeneği varsa yeni bir kategori belirleyin.
4
Adım 4: Kaydetme
Zorunlu alanların (Question, Answer, Category) eksiksiz olduğunu kontrol edin.
Save butonuna tıklayın. İstek POST /api/portal/faq (güncellemede PUT) endpointine gönderilir.
Portal Arayüzünde Görünümü
Manager’da kaydettiğiniz her soru, portal tarafındaki FAQ sayfasına otomatik olarak yansır. Portal sayfası açıldığında sistem güncel soruları çekip aşağıdaki ekranda olduğu gibi kategorilere ayırarak akordeon şeklinde gösterir.
- Kategori Sekmeleri: Manager’da seçtiğiniz kategoriye göre portalda üst bölümde sekmeler (
All,Eğitim,Portalvb.) otomatik oluşur. - Akordeon Yapısı: Soru üzerine tıklayan kullanıcı cevabı genişletilmiş olarak görür. Markdown ile girilen içerik kalın metin, liste, link gibi formatları korur.
- Dil Desteği: Portal dilini TR/EN arasında değiştirdiğinizde sadece o dilde oluşturulan FAQ kayıtları listelenir. Farklı dilde görüntü isteniyorsa Manager’da ilgili dil için ayrı kayıt açılmalıdır.
Portal Uygulamasında Veri Akışı Nasıl Çalışır?
Manager → Portal Senkronizasyonu (Kullanıcı Perspektifi)1
Manager'da Kaydet
FAQ kaydını oluşturup
Active bırakarak kaydettiğiniz anda bilgi merkezi veritabanına yazılır.2
Portal Sayfasını Aç
Portal kullanıcısı
FAQ menüsüne girdiğinde ekran o anda kayıtlı tüm aktif soruları otomatik olarak yükler.3
Kategoriler Otomatik Oluşur
Manager’da verdiğiniz kategori isimleri portalda üst sekmeler olarak görünür; kullanıcı hangi sekmeye tıklarsa sadece o kategoriye ait soruları görür.
4
Anında Güncelleme
Manager’da bir soruyu pasife çektiğinizde veya yanıtını değiştirdiğinizde portal sayfası yenilendiğinde yeni içerik hemen yansır. Ekstra bir yayınlama adımına gerek yoktur.
5
Dil Uyumu
Çok dilli portallarda her dil için ayrı kayıt eklemeyi unutmayın. Portal dili değiştirildiğinde o dile ait sorular gösterilir; diğer diller gizlenir.