İçindekiler

Genel Bakış

Portal App (Uygulama), API Portal kullanıcılarının API ürünlerine erişmek için oluşturdukları uygulamalardır. Her uygulama:

  • Bir portal hesabına (Portal Account) bağlıdır
  • Benzersiz bir referans ID'ye sahiptir
  • Bir veya birden fazla API Key'e sahip olabilir
  • Bir veya birden fazla API Product'a kayıt olabilir

Portal App Kullanım Amaçları

  • API'lere güvenli erişim sağlamak
  • API kullanımını uygulama bazında izlemek ve raporlamak
  • API Key'lerini yönetmek
  • API Product aboneliklerini yönetmek

API Manager'da Portal App Yönetimi

API Manager'da, yöneticiler tüm portal uygulamalarını görüntüleyebilir ve yönetebilir.

Yeni Portal App Oluşturma


AdımAçıklama/ İşlev
Adım 1

Portal App listesi sayfasında sağ üstteki "+ Create" butonuna tıklayın

Adım 2

Açılan dialog'da aşağıdaki bilgileri doldurun:

  • Account: Açılır listeden uygulamanın bağlanacağı portal hesabını seçin (Zorunlu)
  • Name: Uygulama adı (Zorunlu, Max: 255 karakter)
  • Reference ID: Uygulamanın benzersiz ID'si (Zorunlu, otomatik UUID üretilir)
  • Description: Uygulama açıklaması (Opsiyonel)
Adım 3

"Save" butonuna tıklayın

Adım 4

Başarılı mesajı görüntülenir ve liste güncellenir

Portal App Detay Sayfası

BölümBilgiAçıklama/ İşlev

Üst Bilgi Bölümü

Sayfanın üst kısmında kart şeklinde bilgiler görüntülenir

  • Account: Hesap adı (tıklanabilir link, hesap detayına gider)
  • Name: Uygulama adı
  • Reference ID: Benzersiz uygulama ID'si
  • Description: Uygulama açıklaması
  • Created Date: Oluşturulma tarihi (dd/MM/yyyy HH:mm:ss formatında)
  • Edit Butonu: Uygulama bilgilerini düzenlemek için

API Keys (API Anahtarları) Bölümü


Bu bölümde uygulamaya ait tüm API Key'ler listelenir.

  • API Key : Credential'ın username'i (API çağrılarında kullanılır)
  • Enabled: Aktif/Pasif durumu (yeşil/kırmızı nokta ile)
  • Created Date: Key'in oluşturulma tarihi
  • Expire Date: Key'in geçerlilik süresi (yoksa "Never Expire")
  • Actions: Revoke (İptal) butonu

API Key Oluşturma: 

  1. Tablo başlığındaki "Generate Key" butonuna tıklayın
  2. Sistem otomatik olarak:
    • Benzersiz bir username (UUID) üretir
    • Benzersiz bir password (UUID) üretir
    • Credential'ı aktif durumda oluşturur
    • Uygulamanın account ve organization bilgilerini atar
  3. Yeni key tabloya eklenir

API Key İptal Etme (Revoke):

  1. İptal etmek istediğiniz key'in satırındaki "Revoke" butonuna tıklayın
  2. Key'in durumu pasif olur (enabled = false)
  3. Bu key artık API çağrılarında kullanılamaz

API Products (API Ürünleri) Bölümü


Bu bölümde uygulamanın kayıt olduğu API Product'lar listelenir.

API Product: Ürün adı
Description: Ürün başlığı/açıklaması
Plan: Seçilen plan detayları (Free, Subscription, Metered, Tiered)
Status: Kayıt durumu (APPROVED, WAITING, REJECTED, UNSUBSCRIBED)
Actions: Unregister (Kaydı İptal) butonu

API Producta eklenene API Product ın durumları için 

🟢 APPROVED: Onaylanmış, aktif kullanımda

🟡 WAITING: Onay bekliyor

🔴 REJECTED: Reddedilmiş

⚫ UNSUBSCRIBED: Kaydı iptal edilmiş

durumları Onay İstekleri sayfasında anlatılmıştır.

API Product Kaydını İptal Etme:

  • İptal etmek istediğiniz ürünün satırındaki "Unregister" butonuna tıklayın
  • Kayıt durumu UNSUBSCRIBED olarak güncellenir
  • Uygulama artık bu API Product'a erişemez

Not: Bu işlem API Manager'dan yapılır. Portal kullanıcıları detay sayfasında kayıtlarını iptal edemez.

API Portal'da Arayüzünde Uygulamalarım

API Portal'da kullanıcılar sadece kendi uygulamalarını görebilir ve yönetebilir.

Portal'den Uygulama Oluşturma

SenaryoAdımİşlev

Senaryo A: Hiç Uygulaması Olmayan Kullanıcı

Adım 1 : Uygulamalarım sayfası açıldığında boş liste kartı ve "Henüz uygulamanız bulunmuyor" mesajı görünmesi durumunda:

"+ Create" butonuna tıklayın

Açılan dialog'da bilgileri doldurun

Adım 2:

"Save" butonuna tıklayın. Kayıt tamamlandığında otomatik olarak oluşturulan ilk uygulamanız listeye eklenir ve ilk API Key'iniz hazırlanır.


Senaryo B: Mevcut Uygulamaları Olan Kullanıcı



Adım 1: Liste sayfasında mevcut uygulamalar kart/tabloda listelenmesi durumunda:

Sağ üst köşedeki "+ Create" butonu her zaman görünür; bu butona tıklayarak yeni uygulama eklenebilir.

Adım 2:App ve plan seçilip register olunur.

Kayıt işlemi tamamlandıktan sonra API Product'ın durumuna göre yapılacak adımlar için Onay İstekleri sayfasındaki API Ürünü Erişim Ayarları bölümünde detaylı olarak anlatılmıştır.

API Portal arayüzünde uygulama oluşturmanın bir diğer yöntemi de “Uygulamalarım” sayfası üzerinden işlem yapmaktır. Bu sayfa; yeni uygulama oluşturma, mevcut uygulamaları düzenleme veya silme gibi tüm yönetim adımlarının yapıldığı merkezi alandır.

API Product detay ekranında ise yalnızca mevcut bir uygulamanın ilgili API Product’a eklenmesi mümkündür; uygulama düzenleme veya silme işlemleri burada gerçekleştirilmez.

Ek olarak; API Manager tarafında uygulama oluşturulurken Account / Developer bölümü girilmesi gerekir. Ancak Portal tarafında kullanıcı zaten kimliği doğrulanmış şekilde giriş yaptığı için, Portal üzerinden oluşturulan uygulamalar otomatik olarak ilgili kullanıcıya ait olacak şekilde kaydedilir.

Aşağıda, Portal Uygulamalarım sayfasının arayüzü örnek olarak gösterilmektedir.

API Portal Arayüzünde API Key (Credential) Yönetimi

API Key Yapısı

Her API Key aşağıdaki özelliklere sahiptir:

ÖzellikAçıklama
UsernameAPI çağırılarında kullanılan anahtar (UUID formatında)
PasswordSecret key (UUID formatında)
App IdAit olduğu uygulama ID'si
Account IdAit Oluduğu hesap ID'si
Organization IdAit olduğu organizasyon ID'si
EnabledAktif/Pasif durumu (true/false)
CreatedOluşturulma tarihi
Expire DateGeçerlilik süresi (opsiyonel)
Account CredentialHesap bazlı credential olup olmadığı (true/false)

API Key Oluşturma ve İptal Etme Akışı


API Key Oluşturma Akışı

API Key İptal Etme Akışı

1-Kullanıcı "Generate Key" butonuna tıklar

1-Kullanıcı "Revoke" butonuna tıklar


2-Sisteme UUID formatında username üretilir

2-Credential nesnesi güncellenir:

  • enabled: false (pasif)
  • Diğer bilgiler aynı kalır
3-Sisteme UUID formatında password üretilir

3-CredentialUpdateDTO oluşturulur

4-Credential nesnesi oluşturulur:

  • username: UUID
  • password: UUID
  • appId: [Uygulama ID]
  • accountId: [Hesap ID]
  • organizationId: [Organizasyon ID]
  • enabled: true

4-Backend'e PUT isteği gönderilir


5-CredentialUpdateDTO oluşturulur:

  • credential: [Credential nesnesi]
  • accessControlList: []
  • accountCredential: true


5-Başarılı yanıt alınır

6-Backend'e POST isteği gönderilir

6-Credential listesi yenilenir

7-Başarılı yanıt alınır7-Key pasif durumda görünür (kırmızı nokta)
8-Credential listesi yenilenir
9-Kullanıcıya başarı mesajı gösterilir

API Product Kaydı Durumları

Status Açıklamaları:

StatusAçıklamaBadge RengiKullanım
WAITINGOnay bekliyorSarıKayıt oluşturuldu, admin onayı bekleniyor
APPROVEDOnaylandıYeşilUygulama API'leri kullanabilir
REJECTEDReddedildiKırmızıKayıt reddedildi, uygulama kullanamaz
UNSUBSCRIBEDKaydı iptal edildiGriKullanıcı veya admin kaydı iptal etti

Kullanım Senaryoları

SenaryoAdım

Senaryo 1: Yeni Bir Uygulama Oluşturma (Portal Kullanıcısı)

  1. Kullanıcı Portal'a giriş yapar
  2. Menüden "Uygulamalarım" sayfasına gider
  3. "+ Create" butonuna tıklar
  4. Formu doldurur:
    • App Name: "Mobile iOS App"
    • App Id: Otomatik UUID
    • Description: "iOS uygulaması için API erişimi"
  5. "Save" butonuna tıklar
  6. Sistem otomatik olarak:
    • Uygulamayı oluşturur
    • İlk API Key'i üretir
    • Kullanıcıya başarı mesajı gösterir
  7. Kullanıcı yeni uygulamayı listede görür

Sonuç:

  • Uygulama hazır
  • İlk API Key kullanıma hazır
  • API Product'lara kayıt olunabilir

Senaryo 2: API Product'a Kayıt ve Kullanım

  1. Kullanıcı "API Products" sayfasına gider
  2. İstediği API Product'ı seçer
  3. Bir plan seçer (Free, Subscription, vb.)
  4. Uygulamasını seçer
  5. "Subscribe" butonuna tıklar
  6. Kayıt oluşturulur (Status: WAITING)
  7. Admin kaydı onaylar (Status: APPROVED)
  8. Kullanıcı uygulama detay sayfasında kaydı görür
  9. API Key'ini kullanarak API çağrıları yapar

Sonuç:

  • Uygulama API'ye erişebilir
  • Throttling/Quota limitleri uygulanır
  • Kullanım izlenir ve raporlanır

Senaryo 3: API Key Yönetimi ve Rotasyon

  1. Kullanıcı uygulama detay sayfasına gider
  2. Mevcut API Key'leri görür
  3. Güvenlik nedeniyle key değiştirmeye karar verir
  4. "Generate Key" ile yeni key oluşturur
  5. Yeni key'i kodunda günceller
  6. Test eder ve çalıştığını doğrular
  7. Eski key'i "Revoke" ile iptal eder

Sonuç:

  • Güvenlik artırıldı
  • Eski key geçersiz kılındı
  • Yeni key aktif olarak kullanılıyor

Senaryo 4: Uygulama Silme ve Temizlik

  1. Kullanıcı artık kullanmadığı bir uygulamayı silmeye karar verir
  2. "Uygulamalarım" sayfasına gider
  3. Silinecek uygulamanın menü butonuna (⋮) tıklar
  4. "Remove" seçeneğine tıklar
  5. Onay dialog'unda uygulamayı kontrol eder
  6. "Delete" butonuna tıklar
  7. Sistem:
    • Uygulamayı siler
    • Tüm API Key'leri iptal eder
    • API Product kayıtlarını kaldırır
  8. Başarı mesajı gösterilir

Sonuç:

  • Uygulama tamamen silinir
  • İlgili tüm kaynaklar temizlenir
  • API çağrıları başarısız olu

Senaryo 5: Admin Tarafından Uygulama Yönetimi

  1. Admin API Manager'a giriş yapar
  2. Portal Management > Portal Apps sayfasına gider
  3. Tüm kullanıcıların uygulamalarını görür
  4. Bir uygulamayı seçerek detay sayfasına gider
  5. API Product kayıtlarını kontrol eder
  6. Gerekirse:
    • Yeni API Key oluşturur
    • Mevcut key'leri iptal eder
    • API Product kaydını onaylar/reddeder
    • Kaydı iptal eder (unregister)
  7. Uygulama bilgilerini düzenler
  8. Değişiklikler kaydedilir

Sonuç:

  • Admin merkezi yönetim yapabilir
  • Kullanıcı uygulamaları izlenir
  • Gerekli müdahaleler yapılır

Sık Sorulan Sorular

Hakkında

SoruCevap

Portal App Hakkında

Portal App nedir ve neden gereklidir?  Portal App, API'lere erişmek için oluşturulan bir uygulamadır. Her API çağrısı bir uygulamaya ait API Key ile yapılır, bu sayede kullanım izlenebilir ve kontrol edilebilir.
Bir kullanıcı kaç uygulama oluşturabilir?

 Bir kullanıcı istediği kadar uygulama oluşturabilir. Limit yoktur.

Aynı isimde iki uygulama oluşturabilir miyim? Evet, aynı hesap altında aynı isimde birden fazla uygulama olabilir. Reference ID her durumda benzersizdir.
API Key HakkındaAPI Key password'unu unutursam ne olur?Password bir kez gösterilir ve sistemde saklanmaz. Unutulursa key iptal edilip yeni bir key oluşturulmalıdır.
Bir uygulamada kaç API Key olabilir? Bir uygulamada istediğiniz kadar API Key oluşturabilirsiniz. Limit yoktur.
 İptal edilen bir key'i tekrar aktif yapabilir miyim?

Hayır, iptal edilen bir key tekrar aktif edilemez. Yeni bir key oluşturulmalıdır.

API Product Kayıtları HakkındaBir uygulama birden fazla API Product'a kayıt olabilir mi?

Evet, bir uygulama istediği kadar API Product'a kayıt olabilir.

WAITING durumundaki kaydım ne zaman onaylanır? Kayıtlar genellikle admin tarafından manuel onaylanır. Onay süresi sistem politikalarına göre değişir.
Reddedilen (REJECTED) bir kaydı tekrar başvurabilir miyim? Evet, kaydı silebilir ve tekrar oluşturabilirsiniz. Ancak ret nedenini öğrenmek için admin ile iletişime geçmeniz önerilir.
Yönetim ve Güvenlik HakkındaAPI Manager ve API Portal arasındaki fark nedir?API Manager yöneticilerin tüm uygulamaları yönettiği yerdir. API Portal kullanıcıların sadece kendi uygulamalarını yönettiği yerdir.
Admin benim uygulamama müdahale edebilir mi

Evet, admin tüm uygulamaları görüntüleyebilir, düzenleyebilir ve silebilir.