API Portal
Portal Settings (Portal Ayarları), API Developer Portal'ınızın temel konfigürasyonlarını, güvenlik ayarlarını, e-posta bildirimlerini, özellikleri ve yasal düzenlemelerini yönettiğiniz merkezi ayarlar sayfasıdır. Bu sayfadaki değişiklikler portal'ın genel davranışını ve kullanıcı deneyimini doğrudan etkiler.
Portal Settings, portal'ın temel ayarlarını ve davranışlarını kontrol eder. Portal Appearance ise görsel öğeleri (logo, renkler, HTML içerik) kontrol eder.
İçindekiler
Genel Ayarlar
Portal Ayarlarını içeren görsele aşağıda yer verilmiştir:
Portal Ayarları konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama | Portal Arayüzündeki Kullanımı |
|---|---|---|
Ad | Sistem içinde API Portal'ı tanımlamak için kullanılır. Teknik tanımlayıcı olarak kullanılır. Sistem loglarında ve raporlarda portal tanımlanır. Zorunlu, benzersiz alandır. örn: <şirketAdı>-developer-portal | Portal içinde teknik kimlik; doğrudan arayüzde görülmez fakat loglar ve raporlarda bu değer yer alır. |
Görünen Ad (Display Name) | Portal'a daha anlaşılır ve kullanıcı dostu bir isim verilir. Pazarlama ve iletişimde kullanılır. Kullanıcıların portal'ı daha kolay hatırlamasını sağlanılır. Opsiyonel, kullanıcı dostu. örn: <şirketAdı> API Developer Portal | Portal üst menüsünde ve e-posta şablonlarında görünen başlık olarak kullanılır. |
Size Özel Portal URL'si (Custom Portal URL) | API Portal'a erişim adresi olarak kullanılır. E-posta bildirimlerindeki linklerde, API key aktivasyon linklerinde, Tüm portal URL'lerinin base adresi olarak belirlenir, Kurumsal domain kullanılır. Tam URL formatında olmalı (http:// veya https://) | Tüm portal linklerinin temel adresi; kayıt/onay mailindeki butonlar, “Forgot Password” gibi yönlendirmeler bu URL’ye göre oluşturulur. |
Varsayılan Dil | Kullanıcı ilk kez API Portal'a girdiğinde varsayılan dil olarak gösterilir.
| Portal girişinde otomatik dil seçimi; dil switcher bileşeninde hangi seçeneklerin listeleneceğini belirler. |
İngilizce dil seçeneğini etkinleştir (Enable the English language option) | Bu özellik etkinleştirildiğinde, İngilizce dil seçeneği aktif olur. Portal'da dil seçici (language switcher) olarak kullanılır. İngilizce içeriklerin gösterilip gösterilmeyeceği belirlenir. Çoklu dil özelliğini kontrol edilir. | İngilizce içeriklerin gösterilip gösterilmeyeceği belirlenir. |
Türkçe dil seçeneğini etkinleştir (Enable the Turkish language option) | Bu özellik etkinleştirildiğinde, Türkçe dil seçeneği aktif olur. Portal'da dil seçici (language switcher) olarak kullanılır. Türkçe içeriklerin gösterilip gösterilmeyeceği belirlenir. Çoklu dil özelliğini kontrol edilir. | Türkçe içeriklerin gösterilip gösterilmeyeceği belirlenir. |
Tanım (Description) | Sistem yöneticileri için açıklayıcı bilgi olarak tanımlanır. Portal'ın amacını ve kapsamını açıklamak için kullanılır. Diğer yöneticiler için bilgi notu bırakılır. örn: Bu portal, dış partner şirketlerimizin API'lerimize erişmesi için oluşturulmuştur. Müşteri verilerine erişim gerektiren tüm API'ler burada yayınlanmaktadır. Portal, GDPR ve ISO 27001 standartlarına uygun olarak yapılandırılmıştır. | Yalnızca yönetsel not; Portal kullanıcı arayüzünde gösterilmez. |
Portal ayarlarında hem Türkçe Dil Seçeneği hem de İngilizce 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ı hem İngilizce hem Türkçe olarak görüntülenir, her dil içinde ayrı veri girişi yapılabilir.
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.
Email Ayarlarını içeren görseller ve açıklamalara aşağıda yer verilmiştir:
Email Ayarları için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
API Portalı'nın e-posta göndermek için kullandığı e-posta sunucusunun adresi. Önceden tanımlanmış e-posta sunucu ayarları seçilir. Connection Config Email listesinden seçim yapılır. Bu ayar, SMTP sunucu bilgilerini içerir. | |
Görünen Ad | E-posta iletilerinin hangi isimle gönderileceğini belirler. Kullanıcılar bu ismi görerek e-postanın nereden geldiğini anlar |
Gönderen E-postası | API Portalı'ndan gönderilen e-postaların hangi adres üzerinden gönderileceğini belirtir. Örneğin, "no-reply@apinizer.com". Bu adresten e-postalar gönderilir. |
Kullanıcı "Yanıtla" butonuna bastığında gidecek adres belirtilir. Örnek: "support@acmecorp.com" Gerçek bir destek e-postası olmalıdır. |
E-posta Şablonları
Portal'dan otomatik olarak gönderilen 8 farklı e-posta tipi vardır. Her birini ayrı ayrı özelleştirilebilir.
Şablonlar ve kullanım amaçları tablodaki açıklanmıştır.
| Şablon | Ne Zaman Gönderilir | Portal'e etkisi | E-Posta Tetikleme Adımları | E-posta |
|---|---|---|---|---|
E-posta Adresinizi Onaylayın | Yeni bir kullanıcı portal'a kayıt olduğunda Kullanıcının e-posta adresini doğrulaması gerektiğinde | Kullanıcı bu e-postadaki linke tıklayana kadar hesabı aktif olmaz. E-posta onaylanmadan portal'a giriş yapılamaz (ayara bağlı) | ADIM 1: Kullanıcı Kayıt Olur, Portal'da "Register" butonuna tıklar, Kayıt formunu doldurur, "Sign Up" butonuna basar ADIM 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 ADIM 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") ADIM 4: Kullanıcı Linke Tıklar, E-postadaki onay linkine/butonuna tıklar, Portal'a yönlendirilir, E-posta adresi doğrulanır ADIM 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 | Kullanıcının hesabı onaylandığında Yönetici tarafından manuel onay sonrası veya otomatik onay durumunda | Kullanıcıya hesabının aktif olduğunu bildirir Portal'a giriş yapabilir hale geldiğini söyler | ADIM 1:Kullanıcı E-postasını Onaylamıştır, Kullanıcı "Confirm Email Address" mailindeki linke tıklamış, E-posta adresi doğrulanmış ADIM 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 ADIM 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") ADIM 4: Kullanıcı Portal'a Erişebilir, Artık portal'a giriş yapabilir, API'leri inceleyebilir, Uygulama kaydı yapabilir |
|
| Şifre Sıfırlama | Kullanıcı "Şifremi Unuttum" butonuna tıkladığında Yönetici kullanıcı için şifre sıfırlama işlemi başlattığında | Kullanıcı bu e-postadaki linke tıklayarak yeni şifre belirler Link belirli bir süre sonra geçersiz olur (güvenlik) | ADIM 1: Kullanıcı Şifresini Unutur, Portal giriş sayfasında "Forgot Password?" linkine tıklar,E-posta adresini girer, "Reset Password" butonuna basar ADIM 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) ADIM 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") ADIM 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) ADIM 5: Şifre Güncellenir, Yeni şifre kaydedilir, "Şifreniz başarıyla güncellendi" mesajı, Kullanıcı yeni şifresiyle giriş yapabilir |
|
Hesap Erişimi Reddedildi | Yönetici kullanıcının kayıt talebini reddettiğinde Manuel onay sürecinde kullanıcı uygun görülmediğinde | Kullanıcı portal'a giriş yapamaz Hesap oluşturulmaz veya silinir | ADIM 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) ADIM 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 ADIM 3: Yönetici Talebi Reddeder,[Reject] butonuna tıklar, Red nedeni girerse (opsiyonel), Onaylar ADIM 4: Sistem İşlemi Gerçekleştirir, Kullanıcı hesabı pasif edilir veya silinir, "Account Access Rejected" e-postası gönderilir ADIM 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. ADIM 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 | 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 | Kullanıcı artık portal'a giriş yapamaz Mevcut oturumlar kapatılır API key'ler devre dışı bırakılır | ADIM 1:Kullanıcı Aktif Bir Hesaba Sahiptir, Kullanıcı daha önce onaylanmış, Portal'ı aktif olarak kullanıyor, API'lere erişimi var ADIM 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ı ADIM 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 ADIM 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 ADIM 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. ADIM 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ı | Kullanıcının bir API'ye app kaydı talebi onaylandığında Yönetici manuel onay verdiğinde veya otomatik onay durumunda | Kullanıcı API'yi kullanmaya başlayabilir API key'ler aktif hale gelir Kullanıcı API dokümantasyonuna erişebilir | ADIM 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 ADIM 2: Uygulama Bilgilerini Girer, Application Name girer, Description ekler, Plan seçer (Free, Basic, Premium vb.), "Submit" butonuna basar ADIM 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 ADIM 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") ADIM 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 | Kullanıcının API'ye app kaydı talebi reddedildiğinde Yönetici talebi uygun görmediğinde | Kullanıcı o API'yi kullanamaz API key'ler oluşturulmaz Kullanıcı tekrar başvuru yapabilir | ADIM 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) ADIM 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 ADIM 3: Yönetici Talebi Reddeder,[Reject] seçer, Red nedeni girer (opsiyonel, kullanıcıya gösterilmez), Onaylar ADIM 4: Sistem İşlemi Gerçekleştirir, Subscription talebi reddedildi olarak işaretlenir, API key'ler oluşturulmaz, "App Registration Rejected" e-postası gönderilir ADIM 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 ADIM 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 | 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 | Kullanıcının API erişimi kesilir Mevcut API key'ler devre dışı bırakılır API çağrıları başarısız olur (401 Unauthorized) | ADIM 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 ADIM 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ı ADIM 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 ADIM 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 ADIM 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 ADIM 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.
Tüm E-posta Şablonlarında:
{{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
Uygulama Kaydı Onaylandı , Uygulama Kaydı Onaylandı ve Uygulama Kaydı İptal Edildi E-posta şablonlarında:
{{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.
Bu sayede kullanıcı, kendisine gelen bildirimin hangi API için olduğunu görür. Birden fazla uygulaması varsa, hangi uygulamayla ilgili bildirim geldiğini kolayca anlar.
E-posta Ayarları konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
E-posta bildirimi aktif | E-posta bildiriminin aktif olup olmadığını belirler. Eğer aktifse, kullanıcıya e-posta gönderimi yapılır. Her bir mail için bu ayar özelleştirilebilir. |
Konu | E-postanın konu satırında görünecek metni belirtir. Genellikle e-posta içeriğini özetleyen bir başlık olur. |
Başlık | E-posta içeriğinin başlığını belirtir. Kullanıcıya e-postada görünen başlık metnidir. |
İçerik | E-posta içeriği. Kullanıcıya gönderilecek mesajın detaylı metnini içerir. E-posta şablonlarında yer tutucularla (örneğin, {{developer_fullname}}) kişiselleştirilebilir. |
Buton etiketi | E-posta içeriğinde bulunan butonun üzerinde görünecek metni belirtir. Kullanıcılar bu butona tıklayarak işlem yaparlar. Örneğin, "Confirm your email address" gibi. |
Güvenlik
API Developer Portal tarafında kullanılacak olan gizlilik ayarları, bu ekran üzerinden yönetilir.
Güvenlik Ayarlarını içeren görseller ve açıklamalara aşağıda yer verilmiştir:
Güvenlik Ayarları konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama | Portal Arayüzündeki Kullanımı |
|---|---|---|
| Geliştiricilerin kendi hesaplarını oluşturmalarını etkinleştirin (Activate developers to create their own accounts) | Security sekmesi → Enable Account Register Portal'a yeni kullanıcı kaydını açmak veya kapatmak, Self-service kayıt özelliğini kontrol etmek amamcı ile kullanılır. Aktif olması durumunda Kullanıcılar portal'a kendi kendilerine kayıt olabilir, "Kayıt Ol" butonu görünür, Kayıt formu erişilebilir. | Portal giriş sayfasındaki “Sign Up/Register” butonunun görünürlüğünü belirler; pasifse self-signup kapalıdır. |
Hesapları/Geliştiricileri Otomatik Onaylayın (Auto Approve Account/Developers) | Security sekmesi → Auto Approve Account Kullanıcı onay sürecini otomatikleştirmek veya manuel hale getirmek, güvenlik seviyesini ayarlamak, erişim kontrolü sağlamak amacı ile kullanılır. Aktif olması durumunda kullanıcı kayıt olduğunda otomatik olarak onaylanır, E-posta onayından sonra hemen portal'a girebilir, Yönetici müdahalesine gerek yok, Welcome e-postası otomatik gönderilir. | Kayıt sonrası e-posta onaylayan kullanıcıların otomatik aktif olup olmayacağını belirler; pasifse Manager’dan manuel onay gerekir. |
Kurum Yöneticisinin Kendi Hesaplarını Yönetmesine İzin Verin (Allow Organization Administrator to Manage their own Accounts) | Security sekmesi → Organization Manager Account Manage Account/Developer menüsü üzerinden yeni kayıt oluştururken Organization Manager rolü atama imkanının olup olmamasını yönetir. Bu atama, hesap/geliştirici'nin API Portal tarafında kendi hesap/geliştirici oluşturulmasına imkan verir. Aktif olması durumunda sadece portal yöneticileri (admin) kullanıcı yönetimi yapabilir, organizasyon yöneticileri sadece kendi hesaplarını görebilir, merkezi kontrol sağlanır. | Organizasyon yöneticilerinin Portal içinde kullanıcı/hesap yönetip yönetemeyeceğini kontrol eder (Portal → Accounts ekranındaki yetkiler etkilenir). |
Hesapların/Geliştiricilerin API'lere Abone Olmasına Otomatik İzin Verin (Auto allow accounts to subscribe to APIs) | Security sekmesi → Auto Approve API Subscribe Bir geliştirici veya hesap API portalına kaydolduğunda, API’lere otomatik olarak abonelik izni verilir. Yani manuel olarak bir yönetici tarafından onaylanmasına gerek kalmaz. Aktif olması durumunda kullanıcı bir API'ye app kaydı yaptığında otomatik olarak onaylanır, API key'ler hemen oluşturulur ve aktif olur, kullanıcı anında API'yi kullanmaya başlayabilir, app Registration Approved e-postası otomatik gönderilir. | Kullanıcı Subscribe/Register App yaptığında planın otomatik onaylanıp API key’lerin hemen tanımlanmasını sağlar; pasifte Manager’da manuel onay akışı çalışır. |
Hesapların Kendi Kimlik Bilgilerini Yönetmesine İzin Ver (Allow Accounts to Manage their own Credentials) | Security sekmesi → Enable Credential Manage Kullanıcılara kendi API key'lerini yönetme izni vermek veya vermemek, güvenlik politikası gereği credential yönetimini sınırlandırmak amacı ile kullanılır. Aktif olması durumunda kullanıcılar kendi API key'lerini görebilir, yeni credential oluşturabilir, mevcut credential'ları silebilir veya yenileyebilir, API secret'larını görebilir. | Portal’daki My Apps bölümünde geliştiricilerin client ID/secret üretme, yeniden oluşturma veya silme yetkisini açar/kapatır. |
Özellikler
API Developer Portal tarafında kullanılacak olan özellikler, bu ekran üzerinden yönetilir.
Özellikler Ayarlarını içeren görseller ve açıklamalara aşağıda yer verilmiştir:
Özellik Ayarlarının konfigürasyonu için kullanılan alanlar aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Nasıl kullanılır menüsünü aktifleştir (Activate the How to use menu) | Features sekmesi → Enable How It Works Nasıl kullanılır menüsü kullanıcılara görünür. Portal'da kullanıcılara rehberlik edecek bir sayfa göstermek veya gizlemek amacı ile kullanılır. Aktif olması durumunda Menüde "How It Works" / "Nasıl Çalışır" linki görünür, Portal Appearance'ta tanımlanan How It Works HTML içeriği gösterilir, kullanıcılar bu sayfaya erişebilir. |
Test araçları menüsünü aktifleştir (Activate the Test Tools menu) | Features sekmesi → Enable Test Tools Test araçları menüsünü kullanıcılara görünür. Kullanıcıların API'leri portal üzerinden test etmelerini sağlamak, Swagger UI benzeri test arayüzü sunmak amacı ile kullanılır. Aktif olması durumunda API dokümantasyonunda "Try It" butonu görünür, kullanıcılar portal üzerinden API çağrısı yapabilir, Request/Response preview aktif olur. |
Jira ile API Portal Entegrasyonunu tanımlama (Define Your API Portal Integration with Jira) | Features sekmesi → Enable Jira Integration Jira Entegrasyonu menüsü görünür. Portal üzerinden Jira ticket'ları oluşturma özelliği sağlamak, Destek sürecini otomatikleştirmek amacı ile kullanılır. Aktif olması durumunda Kullanıcılar portal'dan Jira ticket açabilir, "Report Issue" veya "Request Feature" butonları görünür, Jira entegrasyonu çalışır. |
MCP (Model Context Protocol) Özelliğini Etkinleştir | Features sekmesi → Enable MCP AI asistanları ve araçlar sistemin bağlam verilerine ulaşabilir ve onları kullanabilir. Aktif olamsı durumunda MCP özellikleri kullanılabilir. |
Hesapların Analytcis bilgilerini görüntülemesine izin ver (Allow accounts to view their Analytics information) | Features sekmesi → Enable Analytics Hesaplar kendi analitik bilgilerini görüntüler. Kullanıcılara API kullanım istatistiklerini göstermek, Dashboard'ları aktif etmek amacı ile kullanılır. Aktif olması durumunda Analytics dashboard kullanıcılara görünür, API call istatistikleri gösterilir, Grafikler ve raporlar aktif durumunda olur. |
API Performans Metriklerinizi Tanımlayın (Define your API Performance Metrics) | Features sekmesi → Performance Metrics Bu bölümde, aşağıdaki alanlara ait yapılandırmalar yapılır;
|
Yasal
API Developer Portal tarafında kullanılacak olan yasal ayarlar, bu ekran üzerinden yönetilir.
Yasal Ayarlarını içeren görseller ve açıklamalara aşağıda yer verilmiştir:
Yasal Ayarlarının konfigürasyonu için kullanılan alan aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
Yasal Dosya (Define your API Portal Legal Agreement) | API Portalını kullanırken geçerli olan kullanım koşulları, gizlilik politikası ve yasal yükümlülüklerin belirtildiği bir belgedir.
|
SEO
API Developer Portal tarafında kullanılacak olan SEO ayarları, bu ekran üzerinden yönetilir.
SEO Ayarlarını içeren görseller ve açıklamalara aşağıda yer verilmiştir:
SEO Ayarlarının konfigürasyonu için kullanılan alan aşağıdaki tabloda görülmektedir.
Alan | Açıklama |
|---|---|
SEO | Arama motoru botlarına sitenizde hangi sayfaları tarayıp indeksleyebileceklerini veya hangi sayfalara erişemeyeceklerini söyleyen bir metin dosyasıdır. Bu sayede site sahipleri, arama motorlarının sitelerini daha verimli ve kontrollü bir şekilde taramasını sağlar. |