Vucos Logo

API-First Entegrasyonlar

Platformdaki her yetenek bir sözleşmedir — REST, GraphQL ve webhook — önce bir OpenAPI spesifikasyonu olarak yayınlanır, tipli SDK'ler olarak dağıtılır. Mühendislik ekibiniz Vucos'u Stripe veya Twilio'yu entegre ettiği şekilde entegre eder.

400+
Platform genelinde açık REST uç noktası
%99,95
API erişilebilirlik SLO'su
6
Birinci taraf SDK dili
12 ay
Minimum kullanımdan kaldırma çakışma penceresi

Platform, API'nin Kendisidir

Vucos API öncelikli olarak inşa edilmiştir; bu, operatör konsolundaki her ekranın ve tüketici uygulamasındaki her eylemin, halka açık ve belgelenmiş bir uç noktaya yaslandığı anlamına gelir. Gizli bir iç API yüzeyi yoktur, yalnızca UI üzerinden erişilebilen veri yoktur. REST uç noktaları entegrasyon işinin büyük bölümünü kaplar; GraphQL, katalog ve analitik için esnek sorgu kompozisyonunu açar ve bir webhook olay akışı durum değişikliklerini gerçek zamanlı olarak iter. Her şey sürümlenmiş, hız sınırlı ve gözlemlenebilirdir.

Neden önemli

Kara kutu olarak satılan OTT platformları, iş birimi sağlayıcının yol haritasında olmayan bir şeye ihtiyaç duyduğu anda yükümlülüğe dönüşür. Her özel akış — benzersiz bir onboarding, operatör faturalama entegrasyonu, bir sadakat programı, bir iş ortağı portalı — ya sağlayıcıyı bekler ya da kırılgan scraping ve polling ile platformun etrafına kablolanır. Bu geçici çözümler birikir ve 18 ay içinde entegrasyon borcu lisans maliyetini aşar.

API-first bir platform bu dinamiği tersine çevirir. Vucos'un dahili olarak kullandığı uç noktaların aynısı dışarıya açık olduğundan, ürünün yaptığı hiçbir şey ulaşılmaz değildir. Operatör mühendislik ekipleri özellikleri çeyreklerle değil günlerle sevk eder, iş ortakları aynı sözleşme üzerinden bağlanır ve iş senaryosu şekil değiştirdiğinde platform çalışmaya devam eder.

API yüzeyinin kapsadığı

REST API'leri

İçerik, abone, yetkilendirme, faturalama ve operasyon için kaynak odaklı REST. Her uç noktada tutarlı sayfalama, filtreleme ve hata sözleşmeleri.

GraphQL ağ geçidi

Katalog, kullanıcı ve analitik graf'larını birleştiren tek bir GraphQL uç noktası. İstemciler tam olarak ihtiyaç duydukları alanları çeker; kalıcı sorgular ve alan seviyesinde yetkilendirme.

Webhook olay akışı

Abonelik olayları, oynatma yaşam döngüsü, içerik durumu ve faturalama geçişleri için imzalı, yeniden denenebilir webhook'lar. Üstel geri çekilmeli at-least-once teslim ve bir replay API'si.

OpenAPI öncelikli spec

Her REST uç noktası yayınlanmadan önce OpenAPI 3.1'de tanımlanır. Aynı spec; sunucu stub'larını, SDK'leri ve etkileşimli dokümantasyon portalını besler — kod ve dokümanlar arasında sapma olmaz.

Tipli SDK'ler

Spec'ten üretilen TypeScript, Python, Go, Java, Kotlin ve Swift için birinci taraf SDK'ler. Tipli yanıtlar, yerleşik retry ve auth, uçtan uca iz yayılımı.

Hız sınırlama & sürümleme

Burst toleranslı kiracı başına sınırlar, kalan kotayı açıklayan yanıt başlıkları, açık API sürümlemesi ve minimum 12 aylık çakışmayla kullanımdan kaldırma politikaları.

Operatörler nasıl kullanıyor

Telekom operatörü

Operatör faturalama entegrasyonu

Abonelik satın alma, yükseltme ve iptali operatörün mobil uygulamasından akar; uygulama Vucos faturalama API'lerine post ederken ücret operatör BSS üzerinden çekilir. Operatör işlemi onayladığında webhook olayları durumu mutabık kılar.

İçerik stüdyosu

Otomatik içerik teslim boru hattı

Stüdyonun MAM'ı tamamlanmış master'ları ve meta veriyi REST ile Vucos'a iter; bu transkod, DRM paketleme ve yayımlamayı tetikler. Durum webhook'ları stüdyo dashboard'una geri besler; yapımcılar Vucos konsoluna girmeden yayın durumunu görür.

Sadakat ortağı

Ödül kullanımı & yetkilendirme verme

Bir seyahat ödülleri platformu, üyeler kilometre taşlarına ulaştığında ücretsiz SVOD erişimi vermek için Vucos yetkilendirme API'sini çağırır. Aynı webhook akışı aktivasyon ve kullanımı geri raporlar; sadakat programı etkileşimi puanlar.

Teknik detaylar

API stilleri
  • REST (JSON:API tarzı)
  • GraphQL ağ geçidi
  • Webhook olay akışı
  • Yüksek hacimli dahili için gRPC
Spesifikasyon
  • OpenAPI 3.1
  • Direktifli GraphQL şeması
  • Webhook'lar için AsyncAPI
  • Payload'lar için JSON Schema
SDK'ler
  • TypeScript / JavaScript
  • Python
  • Go
  • Java
  • Kotlin
  • Swift
Yetkilendirme
  • PKCE ile OAuth 2.1
  • Makineden makineye JWT'ler
  • Ortak entegrasyonları için API anahtarları
  • İnce taneli kapsamlar
Hız & sürümleme
  • Kiracı başına token bucket
  • Burst + sürekli limitler
  • Semantik API sürümleme
  • 12 aylık kullanımdan kaldırma çakışması
Güvenilirlik
  • %99,95 API SLO'su
  • Bölgesel okuma kopyaları
  • Yazma işlemlerinde idempotency anahtarları
  • Uzun görevler için asenkron iş kuyruğu

Key Takeaways

  • Her uç nokta yayınlanmadan önce OpenAPI 3.1 spesifikasyonu yayımlanır
  • Operasyonlar için REST, kompozisyon için GraphQL, olaylar için webhook
  • TypeScript, Python, Go, Java, Kotlin ve Swift için tipli SDK'ler
  • At-least-once teslim ve replay API'li imzalı, yeniden denenebilir webhook'lar
  • Kalan kotayı başlıklarda açıklayan kiracı başına hız sınırları
  • Durum yoklaması ile uzun süren operasyonlar için asenkron iş kuyruğu

Sıkça Sorulan Sorular

API'ler ne kadar kararlı — altımızda değişir mi?
Tasarım gereği kararlı. Her API semantik olarak sürümlenir; kıran değişiklikler, her iki sürümün paralel çalıştığı minimum 12 aylık bir çakışma penceresiyle yeni sürüm olarak çıkar. Kırıcı olmayan eklemeler (yeni alanlar, yeni isteğe bağlı parametreler) sürüm artışı olmadan sürekli gerçekleşir. Kullanımdan kaldırma; yanıt başlıkları, changelog ve doğrudan geliştirici teması yoluyla bildirilir.
REST mi GraphQL mi — hangisini kullanmalıyız?
Çoğu alan için her ikisi de mevcuttur. Net fiillerin ve idempotency'nin önemli olduğu işlem temelli operasyonlar (abonelik oluştur, yetkilendirme ver, transkod başlat) için REST'i kullanın. Fazladan veri çekmenin zarar vereceği okuma ağırlıklı UI kompozisyonu (5 kaynaktan kısmi alanlarla bir katalog ekranı render etmek) için GraphQL'i kullanın. SDK'ler her ikisini de açar.
Webhook'lar başarısızlıkları nasıl yönetiyor?
Her webhook döner bir sırla imzalanır ve 72 saate kadar üstel geri çekilmeyle yeniden denenir. Teslimat başarısız olmaya devam ederse olaylar ölü mektup kuyruğuna düşer ve birinci sınıf bir API üzerinden yeniden oynatılabilir — son 30 gün içindeki herhangi bir olayı kimlik veya zaman aralığıyla yeniden teslim etmesini Vucos'tan isteyebilirsiniz; alıcı kesintisinden sonra yararlıdır.
Hız sınırı duruşu nedir?
Varsayılan kiracı başına sınırlar cömerttir — tipik entegrasyonlar bunları hiç görmez. Sınırlar yanıt başlıklarında yayınlanır (X-RateLimit-Remaining, X-RateLimit-Reset) ve kurumsal kiracılar daha yüksek tavanlar veya ayrılmış kapasite müzakere edebilir. Kritik uç noktalar (oynatma yetkilendirmesi, DRM lisans verme) ayrı, daha yüksek öncelikli kotalara sahiptir.
Üretim dışı bir örneğe karşı sandbox yapabilir miyiz?
Evet. Her kiracı; üretim API yüzeyini test verileri ve test faturalama akışlarıyla yansıtan bir sandbox ortamı alır. SDK'ler bir base URL kabul eder, bu nedenle sandbox ile üretim arasında geçiş bir yapılandırma değişikliğidir, kod çatalı değil.
Uzun süren operasyonlar nasıl modelleniyor?
Asenkron olarak. Toplu transkodlama, toplu yetkilendirme verme veya katalog yeniden indeksleme gibi operasyonlar hemen bir iş kimliği döndürür ve bir iş durumu uç noktası ile tamamlama webhook'ları sunar. Bu, uzun süre açık tutulan HTTP bağlantılarından kaçınır ve saatlerce süren iş akışları için ilerlemeyi gözlemlenebilir tutar.

İlgili

Daha fazlasını öğrenmeye hazır mısınız?

Bunun dağıtımınıza nasıl uyduğunu bir mimarla görüşün.