Ana içeriğe atla

API Portal Kavramı

API Keşfi

API kataloğunu keşfetme

Dokümantasyon

Detaylı API dokümantasyonu

Test Etme

API’leri test etme

Self-Service

Kullanıcı self-service yönetimi

Apinizer Developer Portal’in Sağladığı Avantajlar

İş Birimleri İçin

  • API’lerinizi iç ekiplerinizle paylaşarak sistemler arası entegrasyonu hızlandırın
  • Teknik dokümantasyonu merkezi bir noktada toplayarak bilgi dağınıklığını önleyin
  • Self-service yaklaşımı ile destek ekiplerinizin yükünü azaltın

Geliştiriciler İçin

  • İhtiyacınız olan API’yi kolayca bulun ve hemen kullanmaya başlayın
  • İnteraktif dokümantasyon ile API’yi anlamak için daha az zaman harcayın
  • Sandbox ortamında güvenle test yapın, production’a geçmeden önce emin olun

İş Ortakları İçin

  • Güvenli bir şekilde API’lerinize erişim sağlayın
  • Partner ekosisteminizi yönetin ve kontrol edin
  • Şeffaf kullanım metrikleri ile iş birliğinizi güçlendirin

API Portal Özellikleri

API Keşfi

  • Tüm API’lerin listelenmesi
  • Kategori bazlı filtreleme
  • Arama fonksiyonu
  • API detay sayfaları
  • OpenAPI/Swagger dokümantasyonu
  • Endpoint detayları
  • Request/Response örnekleri
  • Schema tanımları
  • Versiyon listesi
  • Versiyon karşılaştırma
  • Deprecation bilgileri

Self-Service Yönetim

Uygulama Yönetimi

  • Uygulama oluşturma
  • Uygulama düzenleme
  • API ürünlerine abone olma

API Key Yönetimi

  • API Key oluşturma
  • API Key rotasyonu
  • API Key iptal etme

Kullanım İzleme

  • API kullanım istatistikleri
  • Quota durumu
  • Hata logları

Profil Yönetimi

  • Kullanıcı profili
  • Bildirim tercihleri
  • Hesap ayarları

Test ve Deneme

  • API endpoint’lerini test etme
  • Request gönderme
  • Response görüntüleme
  • Authentication test etme
  • Çeşitli programlama dilleri için kod örnekleri
  • cURL örnekleri
  • SDK örnekleri

Özelleştirme

Tema ve Markalaşma

  • Logo ve renkler
  • Custom CSS
  • Branding

Dil Desteği

  • Çoklu dil desteği
  • Lokalizasyon

Özel Sayfalar

  • Custom HTML sayfaları
  • İçerik yönetimi

Entegrasyon

  • SSO entegrasyonu
  • Custom authentication

Temel Özellikler

Esnek Deployment

Hem internal hem de external API’ler için on-premise veya cloud ortamlarda kurulum

Çoklu API Spesifikasyon Desteği

OpenAPI (Swagger), WSDL ve özel dokümantasyon formatları

Özelleştirilebilir İçerik

Site seviyesinde ve API seviyesinde markdown ile zengin içerik oluşturma

Self-Service Yönetim

Geliştiricilerin kendi API key’lerini ve aboneliklerini yönetmesi

Gelişmiş Arama ve Filtreleme

API katalogunda hızlı arama ve kategori bazlı filtreleme

Responsive Tasarım

Tüm cihazlarda sorunsuz çalışan modern arayüz

Güvenlik ve Yetkilendirme

Rol bazlı erişim kontrolü ve API seviyesinde izin yönetimi

API Portal Kullanım Senaryoları

API Keşfi

  1. Portal’a giriş yapma
  2. API kataloğunu inceleme
  3. İlgili API’yi bulma
  4. Dokümantasyonu okuma
  5. Test etme

Uygulama Oluşturma

  1. Yeni uygulama oluşturma
  2. API ürünlerine abone olma
  3. API Key alma
  4. API’yi kullanmaya başlama

API Test Etme

  1. API endpoint’ini seçme
  2. Request parametrelerini girme
  3. Authentication bilgilerini ekleme
  4. Request gönderme
  5. Response’u inceleme

API Portal ve API Manager İlişkisi

API Portal, API Manager’dan API bilgilerini alır ve kullanıcılara sunar. İşleyiş akışı:
API Manager

   │ API Konfigürasyonu
   │ API Dokümantasyonu


API Portal

   │ Kullanıcı Arayüzü


API Consumers (Developers)

1. API Yönetimi

API Manager’da API Proxy’ler oluşturulur ve yapılandırılırAPI konfigürasyonları ve dokümantasyon API Manager’da yönetilir.

2. Portal Entegrasyonu

API bilgileri API Portal’a aktarılırAPI Proxy’ler ve dokümantasyonlar portalda görüntülenir.

3. Geliştirici Erişimi

Geliştiriciler portal üzerinden API’leri keşfeder ve kullanırSelf-service kayıt, API key yönetimi ve test yapılır.
API Portal ve API Manager arasındaki bu entegrasyon, API’lerin merkezi yönetimi ve geliştiricilere sunumu arasında köprü kurar.

API Portal Avantajları

Self-Service

  • Kullanıcılar kendi hesaplarını yönetir
  • API Key’leri kendileri oluşturur
  • Daha az yönetim yükü

Geliştirici Deneyimi

  • Kolay API keşfi
  • Detaylı dokümantasyon
  • Test araçları

API Adoption

  • API kullanımını artırır
  • Geliştirici on boarding’i kolaylaştırır

Entegrasyon

  • Mevcut sistemlerle entegrasyon
  • SSO desteği

Sonraki Adımlar