API Ürünü

Adım 1: API Products Sayfasına Giriş

Adım 3: Create Butonuna Tıklama

• Sağ üstteki "+ Create" butonuna tıklayın

Sistem Kontrolleri:

1. Name alanı dolu mu?
2. Name benzersiz mi? (Aynı isimde başka API Product var mı?)
3. Kategori seçilmiş mi?

Başarılı Oluşturma:

• Başarı mesajı gösterilir
• API Product düzenleme sayfasına yönlendirilirsiniz
• Artık tablar (API Specification, Files, Documentation, Visibility and Plan) görünür hale gelir.

API Specification Yapılandırması (Zorunlu)

Hangi API Proxy veya Proxy Group'un kullanılacağını belirleyin

Environment seçin

API Spec kaynağını ayarlayın 

Documentation Ekleme (Önerilir)

Kullanıcılar için dokümantasyon sayfaları oluşturun

Örnek kullanımlar ekleyin

Visibility ve Plan Ayarlama (Zorunlu)

Görünürlük tipini belirleyin (Public/Private/Authorized)

Fiyatlandırma planları oluşturun

Yayınlama (Son Adım)

Tüm yapılandırmalar tamamlandıktan sonra Publish yapın

API Products Listesi

Erişim:

• Manager → Administration → Portal → API Products

Görünüm Seçenekleri:

1. Grid View (Kart Görünümü)

• Varsayılan görünüm
• Her API Product bir kart olarak gösterilir
• Görsel, ad, açıklama ve durum bilgileri görünür

2. List View (Liste Görünümü)

• Tablo formatında görünüm
• Daha fazla detay görünür
• Sıralama yapılabilir

Filtreleme ve Arama

Mevcut Filtreler:

1. Search by API Product

• API Product adına göre arama
• Real-time arama (yazdıkça filtreler)

2. Search by API Proxies

• Belirli bir API Proxy kullanılan ürünleri filtreler
• Dropdown'dan API Proxy seçilir

3. Search by API Proxy Groups

• Belirli bir Proxy Group kullanılan ürünleri filtreler
• Dropdown'dan Proxy Group seçilir

4. Search by Status

• Published: Yayınlanmış ürünler
• Unpublished: Yayınlanmamış (taslak) ürünler
• All: Tümü

Sıralama

Sıralama Seçenekleri:

• Name (A-Z, Z-A)
• Created Date (Yeni → Eski, Eski → Yeni)
• Status (Published → Unpublished)

Nasıl Sıralanır:

• Kolon başlıklarına tıklanır
• Her tıklamada sıralama yönü değişir (ASC/DESC)

Detay Sayfasına Erişim

Yöntem 1: Liste'den tıklama

• API Products listesinde bir ürüne tıklayın

Yöntem 2: Düzenleme butonu

• Üç nokta menüsünden "Edit" seçin

Yöntem 3: Direct URL

• /admin/api-product/{id}/edit

Detay Sayfası Bileşenleri (Üst Kısım:)

1. Başlık ve Görsel

• API Product görseli (sol tarafta büyük ikon)
• API Product adı
• API Product başlığı/açıklaması

2. Hızlı Bilgiler

• Store: Portal'da Store'da gösterilip gösterilmeyeceği
• Automatically approve: Otomatik onay durumu
• Try It active: Try It özelliği aktif mi

3. İşlem Butonları

• Configure: Genel ayarları düzenle
• Back to List: Liste sayfasına dön
• Published/Unpublished: Yayın durumu (toggle butonu)

4. Bilgi Kartları 4 adet kart halinde özet bilgiler:

• Define your API Spec: API Spec kaynağı
• Files: Dosya sayısı
• Add Documentation: Dokümantasyon sayısı
• Visibility: Görünürlük tipi

Tablar (Sekmeler)

1-API Specification (Varsayılan aktif tab)

• API kaynağı bilgileri
• Environment bilgileri
• API operations (endpoints) listesi

2. Files

• Yüklenmiş dosyalar
• Dosya ekleme/çıkarma

3. Documentation

• Özel dokümantasyon sayfaları
• Sayfa ekleme/düzenleme

4. Visibility and Plan

• Görünürlük ayarları
• Fiyatlandırma planları
• Authorized Organizations

5. Danger Zone

• Kritik işlemler
• API Product silme

Adım 1: API Specification Tab'ına Giriş

API Product detay sayfası → API Specification 

Eğer henüz yapılandırılmamışsa: "Define your API Spec" kartı

Yapılandırılmışsa: API bilgileri ve operations listesi

Adım 2:Configure Butonuna Tıklama

"Configure" butonuna tıklayın (sağ tarafta, kart üzerinde)

"API Configuration" dialog açılır

Adım 3: API Source Type Seçimi

Adım 4: API Proxy/Group Seçimi

Adım 5: Environment Seçimi

Environment dropdown'ı otomatik olarak doldurulur

Seçilen API Proxy/Group'un deploy edildiği ortamlar listelenir

Bir environment seçilir.

Sadece deploy edilmiş ortamlar listelenir

Eğer API henüz deploy edilmemişse, önce API Manager'dan deploy yapılmalı

Portal kullanıcıları seçtiğiniz environment'taki API'yi kullanır

Adım 6: API Specification Source Seçimi

İki Seçenek:

1. Get from API (Önerilir)

• API'den otomatik olarak OpenAPI/Swagger spec alınır
• Real-time güncel spec kullanılır
• API'de yapılan değişiklikler otomatik yansır

Ne Zaman Kullanılır:

• API'nizde OpenAPI/Swagger spec varsa
• Spec'i manuel olarak güncellemek istemiyorsanız

2. Upload spec source

• Manuel olarak spec dosyası yüklenir (JSON/YAML)
• Statik spec kullanılır
• Güncellemeler manuel yapılır

Ne Zaman Kullanılır:

• API'de spec yoksa
• Özel spec kullanmak istiyorsanız
• Spec'i düzenleyerek özelleştirmek istiyorsanız

Nasıl Yüklenir:

1. "Upload spec source" seçeneğini seçin
2. "+ Add Spec File" butonuna tıklayın
3. Dosya seçin:
   • Format: JSON veya YAML
   • Maksimum Boyut: 8 MB
   • Desteklenen Spec: OpenAPI 2.0, OpenAPI 3.0, Swagger
4. (Opsiyonel) Çoklu dil desteği varsa Türkçe spec de yükleyin

Adım 7: Save/Update

• "Save" veya "Update" butonuna tıklanır.

Adım 1: Files Tab'ına Giriş

• API Product detay sayfası → Files

Adım 2: Add Butonuna Tıklama

"+ Add File" butonuna tıklayın

"Add File" dialog açılır

Adım 3: Dosya Bilgilerini Doldurma

Adım 4: Save

 Dosya İndirme

Dosya Düzenleme

Dosya Silme

Adım 1: Documentation Tab'ına Giriş

API Product detay sayfası → Documentation tab

Adım 2: Add Page Butonuna Tıklama

"+ Add Page" butonuna tıklayın

"Add Documentation Page" dialog açılır

Adım 3: Sayfa Bilgilerini Doldurma

1. Name Zorunlu

• Sayfa adı
• Portal'da menüde görünür
• Örnek: "Getting Started", "Authentication Guide"

2. Slug Zorunlu

• URL'de kullanılacak kısa ad
• Otomatik oluşturulur (name'den)
• Özel karakter içermemeli
• Örnek: "getting-started", "authentication-guide"

3. Content Zorunlu

• Sayfa içeriği
• Desteklenen Formatlar:
  • Markdown: Önerilir
  • HTML: Zengin içerik için

Adım 5: Save

"Save" butonuna tıklayın

Dokümantasyon Sayfası Düzenleme

Documentation tab'ında sayfayı bulun

Üç nokta menüsünden "Edit" seçin

Değişiklikleri yapın

"Save" butonuna tıklayın

Dokümantasyon Sayfası Silme

Documentation tab'ında sayfayı bulun

Üç nokta menüsünden "Delete" seçin

Onay dialogunda "Yes" deyin

Adım 1: Visibility and Plan Tab'ına Giriş

API Product detay sayfası → Visibility and Plan tab

Adım 2: Configure Visibility

"Configure" butonuna tıklayın (Visibility kartında)

"Configure Visibility" dialog açılır

Adım 3: Visibility Type Seçimi

PUBLIC Seçimi:

1. "PUBLIC" seçeneğini seçin
2. Başka ayar gerekmez
3. "Save" butonuna tıklayın

PRIVATE Seçimi:

1. "PRIVATE" seçeneğini seçin
2. Başka ayar gerekmez
3. "Save" butonuna tıklayın

AUTHORIZED_ORGANIZATIONS Seçimi:

1. "AUTHORIZED_ORGANIZATIONS" seçeneğini seçin
2. "Save" butonuna tıklayın
3. Ana sayfada "+ Add Organization" butonu görünür
4. Bu butonla organizasyonları seçin

Adım 4: Authorized Organizations Ekleme

1. FREE PLAN (Ücretsiz Plan)

Ücretsiz kullanım

Belirli limitler dahilinde

Throttling ve/veya Quota içerebilir

2. SUBSCRIPTION PLAN (Abonelik Planı)

Dönemsel sabit ücret (aylık/yıllık)

Belirli kullanım limitleri dahilinde

Limit aşımında devam edip etmeyeceği seçilebilir

3. METERED PLAN (Ölçümlü Plan)

Kullanım bazlı ücretlendirme

Her API çağrısı için sabit ücret

Pay-as-you-go modeli

4. TIERED PLAN (Kademeli Plan)

Kullanım arttıkça birim fiyat değişir

Farklı kullanım aralıkları için farklı fiyatlar

Volume discount (hacim indirimi)

Adım 1: Add Plan Butonuna Tıklama

Visibility and Plan tab → "+ Add Plan" butonu

Adım 2: Plan Type Seçimi

Dropdown'dan plan tipini seçin:

• Free
• Subscription
• Metered
• Tiered

Seçilen plan tipine göre form alanları görünür

Adım 3: Plan Detaylarını Doldurma

FREE PLAN için:

1. Enable Throttling (İsteğe Bağlı)

   • Checkbox'ı işaretleyin
   • Throttling Count: Sayı girin (örn: 10)
   • Throttling Interval: Zaman aralığı seçin (Per Second, Per Minute)

2. Enable Quota (İsteğe Bağlı)

   • Checkbox'ı işaretleyin
   • Quota Count: Sayı girin (örn: 1000)
   • Quota Interval: Zaman aralığı seçin (Per Hour, Per Day, Per Month)

SUBSCRIPTION PLAN için:

1. Fee (Zorunlu)

   • Abonelik ücretini girin (örn: 50)

2. Currency (Zorunlu)

   • Para birimini seçin (USD, EUR, TRY)

3. Billing Period (Zorunlu)

   • Ödeme dönemini seçin (Monthly, Annually)

4. Throttling (İsteğe Bağlı)

   • Free Plan'deki gibi

5. Quota (İsteğe Bağlı)

   • Free Plan'deki gibi

6. Continue on Exceed (İsteğe Bağlı)

   • Checkbox: Quota aşıldığında devam edilsin mi?
   • Eğer evet ise Fee on Exceed girin

METERED PLAN için:

1. Fee (Zorunlu)

   • Çağrı başına ücret (örn: 0.01)

2. Currency (Zorunlu)

   • Para birimi

3. Billing Period (Zorunlu)

   • Faturalama dönemi

TIERED PLAN için:

1. Billing Type (Zorunlu)

   • Volume Based veya Transaction Based

2. Currency (Zorunlu)

   • Para birimi

3. Billing Period (Zorunlu)

   • Faturalama dönemi

4. Tiers (Kademeler) (Zorunlu)

   • "+ Add Tier" butonuyla kademe ekleyin
   • Her kademe için:
     • Calls From: Otomatik doldurulur
     • Calls To: Bitiş sayısı girin
     • Fee: Bu kademenin birim fiyatı

5. Continue on Exceed (İsteğe Bağlı)

   • Son kademe sonrası devam?

6. Fee on Exceed (İsteğe Bağlı)

   • Son kademe sonrası fiyat

Adım 4: Save Plan

"Save" butonuna tıklayın

Plan doğrulaması yapılır

Plan kaydedilir

Plan listesine eklenir

Publish Butonuna Tıklama

API Product detay sayfası → Sağ üst → "Publish" butonu (yeşil)

 Onay Verme

"Evet, Yayınla" butonuna tıklayın

Yayınlama

published durumu true yapılır.

Durum badge'i "Published" (yeşil) olur

 Unpublish Butonuna Tıklama

API Product detay sayfası → Sağ üst → "Unpublish" butonu (gri)

 Onay Verme

"Evet, Yayından Kaldır" butonuna tıklayın

 Yayından Kaldırılma

published durumu false yapılır

Durum badge'i "Unpublished" (gri) olur

• Zengin biçimli ürün açıklaması (getDescription() sanitize edilerek).
• Tüm plan kartlarının listesi (Free/Subscription/Metered/Tiered).
• Varsa sorumlu birim bilgileri (adı, iletişim kişisi, e-posta ve harici bağlantı).

• Kimlik doğrulama özeti (Auth türü, kullanıcı adı/şifre header alanları, JWT parametreleri).
• Endpoint listesi Accordions yapısında; parametre tablosu, request/response içerikleri, örnekler.
• Kod örnekleri (Shell, Python, JavaScript, Go, Java, C#, Node, Ruby) ve kopyalama butonları.
• “Authorize” ve “Try It” aksiyonlarıyla canlı test.

• Yayınlanmış portal doküman sayfaları markdown/HTML olarak gösterilir.
• Ürün yayınlanmamışsa kilit ikonlu uyarı çıkar.

• Kaç Portal App’in hangi planlara abone olduğunu listeler.
• Her abonelik satırında planın throttling/quota/fiyat bilgileri özetlenir.
• Onay bekleyen, reddedilen veya aktif abonelik durumları ikonlarla gösterilir.
• Aynı alandan yeni abonelik başlatılabilir veya uygun durumdaysa “Unsubscribe” yapılabilir.

• jhi-api-product-analytics bileşeni dashboard ve trafik grafiklerini getirir.

• Ürüne bağlı dosya listesi tablo halinde gösterilir; indirme butonları bulunur.

• Ürün detayında API Specification sekmesini açın.

• Sol taraftan bir operasyon (GET/POST vb.) seçtiğinizde detay kartı açılır.

• Kartın en altında “Kod Örnekleri” alanını göreceksiniz.

• Sekmeler Shell, Python, JavaScript, Go, Java, C#, Node ve Ruby olarak sıralanır.

• Kullanmak istediğiniz dili tıklayın; seçtiğiniz dilin örnek kodu otomatik oluşturulur.

• Her dilde Apinizer tarafından önerilen en yaygın HTTP kütüphanesi kullanılır (örneğin Python için requests, Java için HttpClient).

• Kod parçacığı, o endpoint’in HTTP metodu, URL formatı, path parametreleri, query/header parametreleri ve varsa örnek gövdesiyle birlikte hazır gelir.

• Parametreler OpenAPI spesifikasyonundaki örneklere göre doldurulduğu için dokümantasyonla daima uyumludur.

• Kod kutusunun sağ üstündeki kopyalama ikonuna basarak örneği panoya alabilirsiniz.

• Panoya başarıyla kopyalandığında portal kısa bir bildirim gösterir.

• Kod örnekleri temel iskeleti sağlar.

• Gerekirse kimlik doğrulama bilgilerinizi ekleyin, parametre değerlerini ihtiyacınıza göre değiştirin ve uygulamanıza yapıştırın.

API Product ile API Proxy arasındaki fark nedir?

API Proxy: Backend API'nin önündeki proxy/gateway, Teknik yapılandırma içerir, Policy'ler, routing, security ayarları, Developer/teknik ekip için

API Product: Portal'da sunulan ürün, İş odaklı paketleme, Fiyatlandırma, dokümantasyon, görünürlük, Son kullanıcılar için hazırlnamıştır.

• Bir API Product, bir veya birden fazla API Proxy içerebilir
• Bir API Proxy, birden fazla API Product'ta kullanılabilir

Birden fazla environment için ayrı API Product oluşturmalı mıyım?

Hayır, gerekli değil.

Doğru Yaklaşım: Bir API Product oluşturun, Environment'ları seçerek değiştirin

Nasıl Çalışır:

• API Product'ta bir environment seçersiniz (örn: Production)
• Kullanıcılar bu environment'taki API'yi kullanır
• Test için başka bir API Product oluşturabilirsiniz (opsiyonel)

Try It nedir ve nasıl kullanılır?

Portal'da API'yi doğrudan test etme özelliği

Swagger UI benzeri interaktif arayüzü

Kod yazmadan API'yi deneme