Developer portal ve API deneyimi

Developer portal ve API deneyimi tasarımı

Bir API programının değeri, geliştiricinin içinde bulabildiği yol kadardır. Doğru endpoint zor bulunuyorsa, kimlik doğrulama üç farklı yerde anlatılıyorsa ve hata kodları bir PDF’te duruyorsa entegrasyon yavaşlar, destek talepleri birikir. MadeByCat, developer portallarının deneyim katmanını tasarlar ve geliştirir; böylece teknik ekipler keşiften çalışan bir entegrasyona daha az yardıma ihtiyaç duyarak ilerler.

Kısa cevap

MadeByCat developer portallarını birer ürün olarak tasarlar ve geliştirir: developer experience araştırması, API bilgi mimarisi ve kataloğu, dokümantasyon UX’i, sandbox ve onboarding yolculuğu, kimlik doğrulama, kod örnekleri ve hata durumlarının anlaşılır sunumu, tasarım sistemi ve duyarlı frontend. Yayımlanmış işler arasında Garanti BBVA API Market, Garanti Ödeme Sistemleri Developer Portal ve TAMI Developer Portal var. API’ler ve arka uç sistemler müşteride kalır.

Kimler için

Servisleri teknik olarak hazır ama benimsenmesi zor olan ürün, platform ve API ekipleri için: ödeme kuruluşları, platform şirketleri, yazılım sağlayıcıları ve API’lerini iş ortaklarına ya da dış geliştiricilere açan her kurum. Ortak işaret aynıdır: entegrasyonlar olması gerekenden uzun sürer ve aynı sorular sürekli destek veya çözüm mühendisliği ekibine gelir.

Bu sayfa bir sektörü değil, ürün türünü ve mühendislik problemini anlatır. Banka ve finans web sitelerinin daha geniş resmi — ürün yolculukları, kamuyu aydınlatma, yatırımcı içeriği — için bankacılık ve finans çözüm sayfasına bakın.

Bankacılık ve finans web deneyimi

Neyi tasarlıyor ve geliştiriyoruz

Developer portallar belirli ve tekrar eden noktalarda zorlanır. Kapsamı sayfa şablonlarına göre değil, bu noktalara göre kurarız.

Developer experience araştırması: entegrasyon amaçları, kullanıcı olgunluk seviyeleri, destek soruları ve geliştiricinin yarıda bıraktığı ya da yardım istediği noktalar.
API bilgi mimarisi ve keşfedilebilirlik: ürün → kullanım senaryosu → API hiyerarşisi, arama ve filtreleme, kolay taranan bir katalog.
Teknik dokümantasyon UX’i: referans, rehberler ve değişiklik notları ayrı arşivler yerine tek bir yolculuk olarak kurgulanır.
Sandbox, onboarding ve entegrasyon yolculuğu: geliştiricinin erişim bilgilerini nasıl aldığı, test ortamına nasıl ulaştığı ve canlıya geçiş adımını nasıl anladığı.
Kimlik doğrulama akışlarının anlaşılır sunumu: neyin, hangi sırayla gerektiği; yalnız metinle değil örneklerle.
Kod örnekleri ve hata durumları için içerik tasarımı: kopyalanabilir örnekler, nedeni ve sonraki adımıyla hata kodları, sağlayıcının yayımladığı test verileri.
API yüzeyi büyüdükçe dokümantasyon kalıplarını tutarlı tutan tasarım sistemi, duyarlı frontend ve web mühendisliği.
Teknik yazarlar için içerik yönetimi ve yayın sonrası sürümler, güncellemeler ve iyileştirmeler için yönetilen hizmet.

Kapsam ve kapsam dışı

Portal deneyim katmanı bizdedir: araştırma, yapı, arayüz, frontend, dokümantasyon sunumu ve kararlaştırılırsa sürekli işletim. API tasarımının kendisi, arka uç servisler, ödeme veya çekirdek sistem işlemleri, API gateway’ler ve güvenlik sertifikasyonu müşteride ve platform ekiplerinde kalır. Bu ekiplerle içerik doğruluğu ve gereksinimlerin geliştiriciye nasıl anlatılacağı üzerinde çalışırız; arkadaki sistemlerin sahipliğini üstlendiğimizi iddia etmeyiz.

Çalışma modeli

Çalışma; mevcut API’lerin, dokümantasyonun ve destek sorularının envanteriyle ve bugün entegrasyon yapan geliştiricilerle yapılan görüşmelerle başlar. Buradan bilgi mimarisini ve entegrasyon yolculuğunu tanımlar, kritik yolları — API bulma, kimlik doğrulama, sandbox çağrısı, hata çözme — prototipler ve geliştirmeden önce test ederiz.

Geliştirme, teknik doğruluğu müşterinin platform ekibinin gözden geçirdiği adımlarla ilerler. Yayından sonra portal; planlı sürümler, dokümantasyon güncellemeleri ve gerçek kullanım ile destek sinyallerine dayalı iyileştirmelerle yönetilen hizmet modeline geçebilir. Karar kapıları, RACI ve öncelik seviyeleri yayımlanmış playbook’umuza göre işler.

Yayımlanmış developer portal işleri

Garanti BBVA API Market: servislerin API kategorilerinde gruplandığı, dokümantasyonun keşif yoluna yerleştirildiği arama odaklı bir API market; rolümüz deneyim stratejisi, bilgi mimarisi, UX/UI, dokümantasyon deneyimi ve tasarım sistemi uygulamasını kapsadı. Garanti Ödeme Sistemleri Developer Portal: ödeme ürün alanlarında API kataloğu ve arama; dokümantasyon, test kartları, hata kodları ve destek içeriğiyle birlikte. Rolümüz frontend/platform uygulamasını da içerdi. TAMI Developer Portal: ödeme API’leri, sandbox yolları ve test ile production endpoint’leri arasındaki net ayrım; bu işte de frontend/platform uygulaması rolümüzün parçasıydı.

Üç işte de ödeme API’leri ve arka uç sistemler müşteriye aittir; vaka sayfaları MadeByCat’in hangi katmanı teslim ettiğini açıkça belirtir.

Kanıt ve ilgili vaka çalışmaları

Canlı geliştirici portalı, API arama, hizmet sayfaları ve API kategorileriyle e-ticaret API market'ini sunuyor.
Garanti BBVA API Market
Canlı portal; Sanal POS, Switch, Kart Saklama, Güvenlik Platformu ve GarantiPay dahil ürün alanlarıyla API kataloğu ve arama sunar.
Garanti Ödeme Sistemleri Developer Portal
Canlı portal; Developer Portal ve sandbox bağlantılarını, ödeme API’lerini ve test/production endpoint ayrımını sunar.
TAMI Developer Portal

Sık sorulan sorular

Portalın arkasındaki API’leri veya arka ucu siz mi geliştiriyorsunuz?: Hayır. Developer portal deneyimini ve frontend’ini tasarlar ve geliştiririz. API tasarımı, arka uç servisler ve çekirdek sistemler platform ekibinizde kalır; doğruluk ve sunum için onlarla birlikte çalışırız.
Mevcut dokümantasyonumuzla çalışabilir misiniz?: Evet. Önce var olanın envanterini çıkarırız — referans dokümanlar, rehberler, PDF’ler, destek yanıtları — ve yeniden yapılandırırız. Yeniden yazım varsayılan değildir, içerik bazında kararlaştırılır.
Bu yalnızca bankalar ve ödeme şirketleri için mi?: Hayır. Yayımlanmış portal işlerimiz ödeme alanında, ancak API’leri keşfedilebilir kılma ve entegrasyonu hızlı başlatma problemi API’lerini iş ortaklarına açan her kurum için geçerlidir.
Teknik yazarlar portalı geliştiriciye ihtiyaç duymadan güncelleyebilir mi?: Genellikle hedef budur. İçerik modeli ve yönetim yaklaşımı, dokümantasyon ekiplerinin kararlaştırılmış inceleme adımlarıyla yayın yapabilmesine göre seçilir.
Yayından sonra portala destek veriyor musunuz?: Evet, kapsamdaysa. Yönetilen hizmetler planlı sürümleri, güncellemeleri ve iyileştirmeleri kapsar; müdahale ve çözüm hedefleri sabit sayılarla yayımlanmaz, hizmet sözleşmesinde kararlaştırılır.

Bir developer portal mı planlıyorsunuz ya da yeniden mi düşünüyorsunuz?

Hangi API’leri açtığınızı, kimlerin entegrasyon yaptığını ve geliştiricilerin bugün nerede takıldığını anlatın. Portal deneyimini nasıl kurgulayacağımızı paylaşalım.

İletişime geçin→