Genel Bakış

​

API Developer Portal Nedir?

API Developer Portal (API Geliştirici Portalı), Apinizer API Gateway üzerinde yayınlanan API’lerinizi geliştiricilere, partnerlere ve son kullanıcılara sunmak için kullanılan kapsamlı bir self-service platformudur. Bu portal, API’lerinizi keşfedilebilir, dokümante edilmiş ve kolayca kullanılabilir hale getirerek API ekosisteminizi büyütmenizi sağlar.

​

Temel İşlevler

API Developer Portal aşağıdaki temel işlevleri yerine getirir:

• API Kataloğu: API’lerinizi kategorize edilmiş, arama yapılabilir bir katalogda sunma
• Self-Service Kayıt: Geliştiricilerin kendi hesaplarını oluşturmasına ve API’lere abone olmasına izin verme
• API Dokümantasyonu: Otomatik ve manuel dokümantasyon ile API kullanımını kolaylaştırma
• API Key Yönetimi: Güvenli API erişimi için credential yönetimi
• Fiyatlandırma ve Planlar: Farklı kullanım planları ve monetizasyon stratejileri
• Analytics ve İzleme: API kullanım istatistikleri ve performans metrikleri
• Test Araçları: Portal üzerinden API’leri test etme imkanı
• Görünürlük Kontrolü: Public, Private ve Authorized Organizations bazlı erişim yönetimi

​

Kullanım Senaryoları

• Public API Portal: Genel kullanıma açık API’leri sunma
• Partner API Portal: Belirli partner şirketlere özel API’leri sunma
• Internal API Portal: Kurum içi geliştiricilere API’leri sunma
• API Monetizasyonu: API kullanımından gelir elde etme
• Developer Onboarding: Yeni geliştiricileri hızlıca entegre etme
• API Ekosistemini Büyütme: Daha fazla geliştirici ve uygulama çekme

​

Portal Tipleri

Apinizer API Portal, farklı kullanım senaryoları için esnek görünürlük ve erişim kontrolü sunar.

​

Public API Portal (Herkese Açık Portal)

Ne Zaman Kullanılır:

• Genel kullanıma açık API’leri sunmak istediğinizde
• Mümkün olduğunca fazla geliştiriciye ulaşmak istediğinizde
• Açık API stratejisi izlediğinizde
• Marketing ve yaygınlaştırma odaklı olduğunuzda

Özellikler:

• Herkes portal’a kayıt olabilir
• Tüm yayınlanmış API’ler herkese görünür
• Self-service kayıt ve onay süreci
• Geniş kullanıcı tabanına erişim

Kullanım Örnekleri:

• Hava durumu API’leri
• Harita servisleri
• Genel veri API’leri
• Açık veri platformları

​

Partner API Portal (Partner Portalı)

Ne Zaman Kullanılır:

• Belirli partner şirketlere özel API’leri sunmak istediğinizde
• B2B entegrasyonlar için API’leri paylaşmak istediğinizde
• Kontrollü erişim gerektiren API’ler için
• Kurumsal müşterilere özel çözümler sunmak istediğinizde

Özellikler:

• Sadece yetkili organizasyonlar erişebilir
• Organizasyon bazlı görünürlük kontrolü
• Partner bazlı özel planlar ve fiyatlandırma
• Gelişmiş güvenlik ve erişim kontrolü

Kullanım Örnekleri:

• Ödeme gateway entegrasyonları
• Kurumsal veri paylaşımı
• B2B servis entegrasyonları
• Özel partner çözümleri

​

Internal API Portal (İç Portal)

Ne Zaman Kullanılır:

• Kurum içi geliştiricilere API’leri sunmak istediğinizde
• İç sistemler arası entegrasyon için
• Şirket içi API ekosistemini yönetmek istediğinizde
• Merkezi API yönetimi ve dokümantasyon için

Özellikler:

• Sadece kurum içi kullanıcılar erişebilir
• İç network üzerinden erişim
• Şirket kimlik doğrulama sistemi entegrasyonu
• İç kullanım odaklı planlar

Kullanım Örnekleri:

• Mikroservis API’leri
• İç sistem entegrasyonları
• Departmanlar arası API paylaşımı
• Kurumsal API kataloğu

​

Apinizer API Portal Özellikleri

Apinizer API Portal aşağıdaki kapsamlı özellikleri sunar:

​

Portal Modülleri

API Developer Portal aşağıdaki modüllerden oluşur:

​

API Ürün Yönetimi

API Ürünü modülü, API’lerinizi portal üzerinden son kullanıcılara sunmak için oluşturulup yayınlanabilir bir ürün haline getirir. Özellikler:

• API Proxy veya Proxy Group’ları ürün olarak paketleme
• Kategori bazlı organizasyon
• Görünürlük kontrolü (Public, Private, Authorized Organizations)
• Fiyatlandırma planları (Free, Subscription, Metered, Tiered)
• Dokümantasyon ve dosya yönetimi
• Otomatik OpenAPI/Swagger entegrasyonu

​

Hesaplar ve Geliştiriciler

Hesaplar/Geliştiriciler modülü, portal kullanıcılarının ve geliştiricilerin yönetimini sağlar. Özellikler:

• Self-service kayıt ve onay süreci
• Profil yönetimi
• Organizasyon yöneticisi yetkileri
• API Access Token oluşturma ve yönetimi
• Şifre yönetimi ve güvenlik

​

Uygulama Yönetimi

Uygulama Yönetimi modülü, portal kullanıcılarının API’lere erişmek için oluşturdukları uygulamaları yönetir. Özellikler:

• Portal App oluşturma ve yönetimi
• API Key (Credential) oluşturma ve rotasyon
• API Product abonelikleri
• Uygulama bazlı kullanım izleme

​

Portal Ayarları

API Portal modülü, portal’ın temel konfigürasyonlarını yönetir. Özellikler:

• Genel ayarlar (ad, URL, dil)
• E-posta bildirimleri ve şablonları
• Güvenlik ayarları (kayıt, onay, credential yönetimi)
• Özellikler (Test Tools, Analytics, Jira entegrasyonu)
• Yasal düzenlemeler ve SEO

​

Görünüm ve Tema

Görünüm ve Tema modülü, portal’ın görsel kimliğini özelleştirmenizi sağlar. Özellikler:

• Logo ve favicon yönetimi
• Renk paleti ve tema ayarları
• Ana sayfa içerikleri
• Footer ve “Nasıl Çalışır” sayfası
• Çoklu dil içerik yönetimi

​

Test Araçları

Araçlar modülü, portal kullanıcılarına çeşitli test ve dönüştürme araçları sunar. Özellikler:

• JSONPath testi
• XPath testi
• XML/JSON dönüştürme
• Base64 encode/decode
• JWT decode
• JSON Schema oluşturma

​

Destek Paketleri

Destek Paketleri modülü, kullanıcılara sunulacak destek hizmetlerini yönetir. Özellikler:

• Destek paketi oluşturma ve yönetimi
• SLA seviyeleri ve özellikler
• Fiyatlandırma
• Destek talepleri yönetimi
• Jira entegrasyonu

​

Organizasyon Görünürlüğü

Organizasyon Görünürlüğü modülü, organizasyonların API kullanımını izlemenizi sağlar. Özellikler:

• Organizasyon bazlı API erişim raporları
• Hesap ve API ürün ilişkileri
• Durum takibi ve analiz

​

Portal İş Akışı

​

Geliştirici Perspektifi

1. Kayıt: Portal’a kayıt olur ve e-posta onaylar
2. Onay: Hesap onaylanır (otomatik veya manuel)
3. Keşfetme: API kataloğunu inceler ve ilgilendiği API’leri bulur
4. Uygulama Oluşturma: API’lere erişmek için bir uygulama oluşturur
5. Abonelik: İstediği API Product’a bir plan seçerek abone olur
6. API Key Alma: Abonelik onaylandıktan sonra API Key’lerini alır
7. Test ve Kullanım: Try It konsolu ile test eder ve uygulamasında kullanır
8. İzleme: Analytics ile kullanımını izler

​

Yönetici Perspektifi

1. Portal Kurulumu: Portal ayarlarını yapılandırır
2. API Ürün Oluşturma: API’leri ürün olarak paketler ve yayınlar
3. Görünürlük Ayarlama: Public, Private veya Authorized Organizations seçer
4. Plan Tanımlama: Fiyatlandırma planları oluşturur
5. Onay Yönetimi: Geliştirici kayıtlarını ve abonelikleri onaylar
6. İzleme: Kullanım istatistiklerini ve raporları inceler
7. Destek: Destek taleplerini yönetir

​

Portal ve Manager İlişkisi

API Developer Portal, Apinizer API Manager ile yakından entegre çalışır:

• API Manager: API Proxy’lerin oluşturulduğu, yapılandırıldığı ve deploy edildiği yerdir
• API Portal: API Manager’da yayınlanan API’lerin geliştiricilere sunulduğu yerdir
• Tek Yönlü Veri Akışı: Portal, Manager’dan API bilgilerini okur; Manager’da yapılan değişiklikler otomatik olarak Portal’a yansır
• Yayınlama: API Product’lar Manager’da yayınlandığında Portal’da görünür hale gelir

​

Önemli Notlar