API Ürünü

Apinizer’da API’lerinizi portal üzerinden son kullanıcılara sunmak için oluşturulup yayınlanabilir ürünlerdir. Bir veya birden fazla API’yi bir araya getirerek farklı fiyatlandırma planları, dokümantasyon ve görünürlük ayarları ile portal kullanıcılarına sunar ve API monetizasyonu sağlar.

API Paketleme

Portal’da yayınlanacak API’lerin paketlenmesini ve sunulmasını sağlar

Fiyatlandırma

Free, Subscription, Metered ve Tiered planları ile API monetizasyonu yapabilir

Dokümantasyon

API dokümantasyonu ve örnek kullanımları paylaşır

Görünürlük Kontrolü

Public, Private ve Authorized Organizations görünürlük ayarlarını yönetir

Abonelik Yönetimi

Kullanıcı aboneliklerini ve API erişim izinlerini otomatik yönetir

​

Yeni API Ürünü Oluşturma

API Product Oluşturma Formu

1. API Products Sayfasına Giriş

   • Sol menüden Administration → Portal → API Products bölümüne gidin
   • Sağ üstteki [+ New API Product] butonuna tıklayın
2. Genel Bilgileri Girme

   Select Project (Zorunlu)

   • API Product’ın bağlı olacağı projeyi seçin
   • Admin projesi genellikle varsayılan olarak seçilir

   Define your API Spec (Zorunlu)

   İki seçenek sunulur:

   • Get spec from API: API’den otomatik olarak spec alınır (OpenAPI/Swagger)
   • Upload spec source: Manuel olarak spec dosyası yüklenebilir

   Name (Zorunlu)

   • API Product’ın benzersiz adı
   • Örnek: “Payment API”, “SMS Gateway API”

   Bu ad Portal’da görünür, anlamlı olmalıdır

   Name (TR) (İsteğe Bağlı)

   • Türkçe ad
   • Çoklu dil desteği varsa kullanılır

   Description (Zorunlu)

   • API Product’ın detaylı açıklaması
   • Markdown formatını destekler
   • Portal’da kullanıcılara gösterilir

   Description (TR) (İsteğe Bağlı)

   • Türkçe açıklama

   Image (İsteğe Bağlı)

   • API Product görseli
   • Format: PNG, JPG, GIF
   • Maksimum Boyut: 2 MB
   • Önerilen Boyut: 400x300 px
   • Portal’da API Product kartında görünür

   Categories (Zorunlu)

   • API Product’ın ait olduğu kategoriler
   • Birden fazla kategori seçilebilir
   • Portal’da filtreleme için kullanılır

   API Ürün Kategorileri eklemek veya yönetmek için ilgili bağlantıyı ziyaret edebilirsiniz.

   Responsible Unit (İsteğe Bağlı)

   • Sorumlu birim/departman
   • Destek ve iletişim için kullanılır
   • Örnek: “API Geliştirme Ekibi”, “Ödeme Sistemleri”
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

​

İlk Oluşturma Sonrası Yapılandırma

API Product oluşturduktan sonra, aşağıdaki adımları tamamlamanız önerilir:

İşlem	Açıklama
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 Product Listeleme Ve Görüntüleme

API Product Liste Ekranı

Listeleme

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)

​

API Product Detay Görünümü

API Product Detay Sayfası

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

Sekmeler

1. API Specification (Varsayılan aktif tab)

• API kaynağı bilgileri
• Ortam bilgileri
• API uç nokta 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

​

API Specification Yapılandırması

API Specification Nedir?

Tanım: API Product’ın hangi API’yi temsil ettiğini ve nasıl kullanılacağını belirten yapılandırmadır.

Temel Bileşenler:

1. API Source Type: API Proxy veya Proxy Group
2. API Proxy/Group: Hangi API kullanılacak
3. Environment: Hangi ortamda (test, production, vb.)
4. API Specification Source: Spec nereden alınacak (API’den otomatik veya manuel upload)

API Specification Yapılandırma

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

2. Configure Butonuna Tıklama

   “Configure” butonuna tıklayın (sağ tarafta, kart üzerinde) “API Configuration” dialog açılır

3. API Source Type Seçimi

   API Proxy

   Tek bir API Proxy kullanılır

   Proxy Group

   • Birden fazla API Proxy’yi gruplar
   • Daha kompleks yapılar için
4. API Proxy/Group Seçimi

   API Proxy Seçimi:

   1. API Source Type olarak “API Proxy” seçili olmalı
   2. API Proxy dropdown’ından bir API seçin

   API Proxy Group Seçimi:

   1. API Source Type olarak “Proxy Group” seçili olmalı
   2. API Proxy Group dropdown’ından bir grup seçin
   3. Gruptaki tüm API’lerin birleşik spec’i kullanılır

   API Proxy ve Proxy Group birlikte kullanılamaz. Sadece birini seçmelisiniz. Seçim yaptıktan sonra environments listesi otomatik yüklenir.
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.
6. API Specification Source Seçimi

   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

   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
7. Save/Update

   “Save” veya “Update” butonuna tıklayın

​

Files (Dosyalar) Yönetimi

Files Nedir?

Tanım: API Product ile birlikte kullanıcılara sunulan ek dosyalardır.

Kullanım Alanları:

• SDK dosyaları (ZIP)
• Örnek kod dosyaları
• Postman collection dosyaları
• PDF kılavuzlar
• Sertifika dosyaları
• Test verileri

Files Yönetimi

1. Files Tab'ına Giriş

   API Product detay sayfası → Files

2. Add Butonuna Tıklama

   ”+ Add File” butonuna tıklayın “Add File” dialog açılır

3. Dosya Bilgilerini Doldurma

   Name (Zorunlu)

   • Dosya adı (görünen ad)
   • Örnek: “Java SDK”, “Postman Collection”, “API Guide”

   File (Zorunlu)

   • Yüklenecek dosya
   • Maksimum Boyut: Platform ayarlarına göre değişir
   • Desteklenen Formatlar: PDF, ZIP, JSON, XML, TXT, vb.

   Description

   • Dosya açıklaması
   • Ne içerdiği
   • Nasıl kullanılacağı
4. Save

   “Save” butonuna tıklayın

Dosya İndirme

1. API Product sayfasında Files sekmesine git
2. İndirmek istediği dosyayı bul
3. “Download” butonuna tıkla
4. Dosya indirilir

Dosya Düzenleme

1. Files listesinde dosyayı bulun
2. Üç nokta menüsünden “Edit” seçin
3. Değişiklikleri yapın
4. “Save” butonuna tıklayın

Dosya Silme

1. Files listesinde dosyayı bulun
2. Üç nokta menüsünden “Delete” seçin
3. Onay dialogunda “Yes” deyin

Silme işlemi geri alınamaz

​

Dökümantasyon Yönetimi

Dökümantasyon Nedir?

Tanım: API Product ile birlikte sunulan özel dokümantasyon sayfalarıdır.

API Specification ile Farkı:

• API Specification: Otomatik oluşturulan, endpoint bazlı teknik dokümantasyon
• Documentation: Manuel oluşturulan, özel içerikli sayfalar

Kullanım Alanları:

• Getting Started (Başlangıç Kılavuzu)
• Use Cases (Kullanım Senaryoları)
• Best Practices (En İyi Uygulamalar)
• Troubleshooting (Sorun Giderme)
• Migration Guides (Geçiş Kılavuzları)
• FAQ (Sık Sorulan Sorular)
• Changelog (Değişiklik Geçmişi)

Dökümantasyon Yönetimi

1. Documentation Tab'ına Giriş

   API Product detay sayfası → Documentation tab

2. Add Page Butonuna Tıklama

   ”+ Add Page” butonuna tıklayın “Add Documentation Page” dialog açılır

3. Sayfa Bilgilerini Doldurma

   Name (Zorunlu)

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

   Slug (Zorunlu)

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

   Content (Zorunlu)

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

   “Save” butonuna tıklayın

Dokümantasyon Sayfası Düzenleme

1. Documentation tab’ında sayfayı bulun
2. Üç nokta menüsünden “Edit” seçin
3. Değişiklikleri yapın
4. “Save” butonuna tıklayın

Dokümantasyon Sayfası Silme

1. Documentation tab’ında sayfayı bulun
2. Üç nokta menüsünden “Delete” seçin
3. Onay dialogunda “Yes” deyin

​

Visibility ve Plan Yönetimi

​

Visibility (Görünürlük)

Visibility Nedir?

Tanım: API Product’ın Portal’da kimlerin görebileceğini ve erişebileceğini belirler.

PUBLIC (Herkese Açık)

• Portal’daki tüm kullanıcılar görebilir
• Herkes abone olabilir
• API Catalog’da listelenir

Ne Zaman Kullanılır:

• Genel API’ler için
• Halka açık servisler
• Marketing amaçlı API’ler

PRIVATE (Özel)

• Sadece yöneticiler görebilir
• Normal kullanıcılar göremez
• Özel davet gerekir

Ne Zaman Kullanılır:

• Beta API’ler
• İç kullanım API’leri
• Test aşamasındaki API’ler

AUTHORIZED_ORGANIZATIONS (Yetkili Organizasyonlar)

• Sadece seçilen organizasyonlar görebilir
• Organizasyon üyeleri abone olabilir
• Kısıtlı erişim

Ne Zaman Kullanılır:

• Partner API’ler
• B2B entegrasyonlar
• Kurumsal API’ler

Visibility Yapılandırma

1. Visibility and Plan Tab'ına Giriş

   API Product detay sayfası → Visibility and Plan tab

2. Configure Visibility

   “Configure” butonuna tıklayın (Visibility kartında) “Configure Visibility” dialog açılır

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
4. Authorized Organizations Ekleme

   (Sadece AUTHORIZED_ORGANIZATIONS için)

   Yeni organizasyon eklemek veya düzenlemek için kurumlar linkini ziyaret edebilirsiniz.

   Yapılacak İşlem:

   1. ”+ Add Organization” butonuna tıklayın
   2. Organization seçim dialogu açılır

   Organization Seçimi:

   1. Listeden organizasyonları seçin (checkbox)
   2. “Select All” ile tümünü seç/kaldır
   3. “Add” butonuna tıklayın

   Seçilen Organizasyonlar:

   • Visibility and Plan tab’ında listelenir
   • Her organizasyon için:
     • Ad
     • E-posta
     • Durum (Active/Inactive)
     • Kaldırma butonu (X)

   Organizasyon Kaldırma:

   1. Organizasyon satırında X butonuna tıklayın
   2. Onay dialogunda “Yes” deyin
   3. Organizasyon listeden çıkar

​

Plan Yönetimi

Plan Nedir?

Tanım: API kullanımı için farklı fiyatlandırma ve limit seçenekleridir.

Neden Plan Oluşturulur:

• Farklı kullanıcı segmentlerine hitap etmek
• Kullanım limitlerini kontrol etmek

Plan Tipi	Özellikler
FREE PLAN (Ücretsiz Plan)	Ücretsiz kullanım Belirli limitler dahilinde Throttling ve/veya Quota içerebilir
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
METERED PLAN (Ölçümlü Plan)	Kullanım bazlı ücretlendirme Her API çağrısı için sabit ücret Pay-as-you-go modeli
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)

1. Add Plan Butonuna Tıklama

   Visibility and Plan tab → ”+ Add Plan” butonu

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

3. Plan Detaylarını Doldurma

   FREE PLAN

   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)

   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

   Fee (Zorunlu)

   • Abonelik ücretini girin (örn: 50)

   Currency (Zorunlu)

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

   Billing Period (Zorunlu)

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

   Throttling (İsteğe Bağlı)

   • Free Plan’deki gibi

   Quota (İsteğe Bağlı)

   • Free Plan’deki gibi

   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

   Fee (Zorunlu)

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

   Currency (Zorunlu)

   • Para birimi

   Billing Period (Zorunlu)

   • Faturalama dönemi

   TIERED PLAN

   Billing Type (Zorunlu)

   • Volume Based veya Transaction Based

   Currency (Zorunlu)

   • Para birimi

   Billing Period (Zorunlu)

   • Faturalama dönemi

   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ı

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

   • Son kademe sonrası devam?

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

   • Son kademe sonrası fiyat
4. Save Plan

   “Save” butonuna tıklayın

   • Plan doğrulaması yapılır
   • Plan kaydedilir
   • Plan listesine eklenir

​

API Product Silme

API Product Silme

1. Danger Zone Tab'ına Giriş

   API Product detay sayfası → Danger Zone tab

2. Delete Butonuna Tıklama

   “Delete API Product” butonuna tıklayın Onay dialogu açılır

3. Onay Verme

   “Evet, Sil” butonuna tıklayın

4. Silme İşleminin Tamamlanması

   • Tüm aktif abonelikler iptal edilir
   • Kullanıcı erişim izinleri kaldırılır
   • Files silinir
   • Documentation sayfaları silinir
   • Plans silinir
   • API Product kaydı silinir

​

API Product Yayınlama ve Yayından Kaldırma

İşlem	Adım 1	Adım 2	Adım 3
Yayınlama (Publish)	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
Yayından Kaldırma (Unpublish)	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

​

API Portal Arayüzünde Görünümü

​

Genel Bakış

API Product, Apinizer API Manager’da yayınlanan API paketlerinin, API Portal üzerinden son kullanıcılara ve uygulamalara sunulan yüzüdür.

Her ürün; görünürlük ayarları, çoklu fiyatlandırma planları (Free, Subscription, Metered, Tiered), dokümantasyon, dosyalar, deneme (Try It) ve analytics kabiliyetleriyle birlikte gelir.

Portal kullanıcıları bu ürünleri inceleyebilir, planlara abone olabilir, Try It konsolu üzerinden çağrı yapabilir ve aboneliklerini yönetebilir.

​

Roller ve Ön koşullar

• Portal Manager / Portal Business: Tüm ürünleri ve yönetimsel seçenekleri görür. Ayrıca gelişmiş diyalogları (ör. API product selection) kullanabilir.
• Standart Portal Kullanıcısı: Görünürlüğü kendisine açık (Public veya yetkilendirildiği organizasyon) ürünleri görür.
• Abonelik başlatmak için:
  • Portal hesabınızla giriş yapmış olmanız gerekir.
  • En az bir Portal App tanımınız olmalıdır (yoksa detay sayfasından oluşturabilirsiniz).
• Ürün içeriği (plan, doküman, dosya) API Manager’da hazırlanır; Portal tarafında sadece tüketilir.

​

API Product Liste Sayfası

API Product Portal Liste Sayfası

Erişim:

• Menü: Portal → API Products.
• Sayfanın üstündeki spot metin portal ayarlarından yönetici tarafından özelleştirilebilir

Sol Panel (Kategori Ağacı)

• Kategoriler PrimeNG panelleri şeklinde listelenir. Her kategori başlığına tıklayarak içinde yer alan API ürünlerini görebilirsiniz.
• Arama kutusu hem kategori ağacını hem de sağdaki kart listesini filtreler; yazdıkça debounce’lu arama yapılır.

Sağ Panel (Kart Liste)

• Her kategori için ürün kartları grid düzeninde listelenir.
• Kart içeriği:
  • Ürün adı ve isteğe bağlı görseli.
  • Yayın durumu (yeşil/pembe ikon), API tipi, son güncelleme tarihi.
  • Açıklamanın ilk 300 karakteri; uzun metinler tooltip ile tam haliyle görüntülenebilir.
  • “Explore API” butonu ürün detay sayfasına yönlendirir.
• Kategori seçimi, “Tümü”ne dönmek için temizle butonuyla sıfırlanabilir.

​

API Product Detay Sayfası

API Product Portal Detay Sayfası

• Sol panelde yine kategori ağacı yer alır; başka ürüne geçmek için sayfayı terk etmeden tıklayabilirsiniz.
• Üstte ürün adı, kısa açıklama, yayın durumu (Active/Passive), API tipi, otomatik onay bilgisi ve son değişiklik tarihi gösterilir.
• “Access URL” bağlantısı (OpenAPI veya WSDL) doğrudan erişim sağlar; yanındaki “Download” butonu spec dosyasını indirir.

Sekme	Açıklama/ İşlev	Görünüm
Overview	- 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ı).
API Specification	- 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.
Documentation	- Yayınlanmış portal doküman sayfaları markdown/HTML olarak gösterilir. - Ürün yayınlanmamışsa kilit ikonlu uyarı çıkar.
Applications	- 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.
Analytics	(Portal ayarlarında Analytics açık ve kullanıcı giriş yapmışsa) - jhi-api-product-analytics bileşeni dashboard ve trafik grafiklerini getirir.
Files	- Ürüne bağlı dosya listesi tablo halinde gösterilir; indirme butonları bulunur.

​

API Specification ve Test Konsol

Authentication Özeti

• API’nin ihtiyaç duyduğu kimlik doğrulama tipi (No Auth / Plain Text / Basic / JWT) net olarak gösterilir.
• Plain Text: kullanıcı adı/şifre hangi header’da gönderilecek, portal credential’dan hangi alanın çekileceği belirtilir.
• JWT: token sunucusu adresi, client bilgileri ve grant type bilgisi listelenir.

Authorize Diyaloğu

• Login olmayan kullanıcı için giriş sayfasına yönlendirme yapılır.
• Login olan kullanıcı; abone olduğu planlar için mevcut credential’ları seçebilir.
• Kimlik tipine göre Authorization header’ları (Basic, Bearer vb.) otomatik hazırlanır ve test konsoluna aktarılır.
• İlgili Portal App’e bağlı credential yoksa uyarı alınır.

Endpoint Accordions

• Her endpoint için:
  • Summary ve description alanları.
  • Parametre tablosu (name, typeIn, zorunluluk, örnek).
  • Request body – medya tipi bazında şema ve örnekler.
  • Response listesi – durum kodu, medya tipi, örnek.
  • Try It butonu (Try It devrede ise).

Test Konsolu (Try It)

• Endpoint dialogu genişletilebilir p-dialog içinde açılır.
• HTTP metodu dropdown’dan değiştirilebilir, URL parametreleri dinamik olarak güncellenir.
• Query/header/path parametreleri ekleyip çıkarabilirsiniz.
• Request body editörü JSON/XML örneğiyle hazır gelir; test butonu isteği gönderir.
• Yanıt editöründe status koduna göre renklendirme yapılır; lbl-color-success vs.
• SOAP endpoint’lerde WSDL indirme bağlantısı, REST endpoint’lerde OpenAPI indirilebilir.
• JSON imzalama ve WS-Security diyalogları ile güvenlik testleri yapılabilir (ileri seviye).

API Spesifikasyon Sekmesindeki Kod Örnekleri

Portal’de bir API ürününün detayına girip API Spefication sekmesini açtığımızda, her endpoint kartının sonunda Kod örnekleri başlıklı bir bölüm vardır. Bu bölümün hedefi, endpointlerin nasıl çağırılacağını farklı programlama dillerinde hazır şablonlarla göstermek ve çalıştırmaya birkaç saniyede başlayabilmenizi sağlamaktır.

Kod Örnekleri

Nasıl Çalışır?

Adım	Açıklama
Endpoint’i Seçin	- Ü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.
Dil Sekmesini Seçin	- 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).
Kodu İnceleyin	- 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.
Tek tıkla Kopyalayın	- 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.
Kendi Ortamınıza Uyarlayın	- 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.

Neden Kullanmalısınız?

• Hızlı Başlangıç: “Bu API’yi nasıl çağıracağım?” sorusuna saniyeler içinde yanıt bulursunuz.
• Dil Esnekliği: Farklı ekipler (Python, Java, Node, Go vb.) kendi diline uygun örneğe anında erişir.
• Güncel Kalır: Örnekler API’nin OpenAPI spesifikasyonundan üretildiği için endpoint güncellendiğinde kod da otomatik uyarlanır.
• Kopyala & Çalıştır: Hazır şablon, test veya entegrasyon sürecine hız kazandırır.

​

Dokümantasyon ve Dosyalar

Documentation Sekmesi

• Sadece yayınlanmış ürünlerde görünür; yayın dışı ürünler için kilit ikonlu bilgilendirme yapılır.
• Birden fazla doküman varsa başlıklar arasında sekme yapısız bağlantı listesi bulunur.
• Markdown içerikler GitHub tarzı stillerle render edilir; HTML içerik innerHTML ile güvenli şekilde gösterilir.

Files Sekmesi

• p-table ile dosya adı, açıklaması, boyutu listelenir.
• Her dosya satırında indirme butonu bulunur (downloadFile).
• Dosya yoksa bilgilendirme mesajı gösterilir.

​

Analytics ve Kullanım Takibi

• Portal ayarlarında enableAnalytics açıksa ve kullanıcı giriş yapmışsa Analytics sekmesi görünür.
• Dashboard’da toplam çağrı, hata dağılımı, en popüler planlar gibi grafikler yer alır.
• Tarih aralığı değiştirilebilir (EnumDateRangeUsedComponents.API_DASHBOARD).
• Bu modül ApiProductAnalyticsCoreModule üzerinden sağlanır.

​

Portal–Manager İş Akışı

• API Product içeriğinin gerçek kaynağı API Manager’dır. Portal, yayımlanmış içeriği okur ve son kullanıcıya sunar.
• Portalda yapılamayan işlemler:
  • Plan metni / fiyatı değiştirme
  • Dokümantasyon sayfası güncelleme
  • API görünürlüğü değiştirme
  • Try It ayarlarını açma/kapama
• Bu değişiklikler API Manager’da yapılır; Portal sayfaları otomatik güncellenir.
• API Manager’da Publish durumu kapatıldığında Portal listesinden ürün otomatik düşer.

​

Sık Sorulan Sorular

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ırlanmış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