Teslim ve ürün
Entegrasyonları proje olmaktan çıkarın
Her iş ortağı, müşteri ve iç ekip farklı entegre olduğunda her yeni bağlantı bir projeye dönüşür. Tek bir API standardı, gateway, sözleşme testleri ve geliştirici portalı kurarız.
- Süre
- 6 ila 14 hafta
- Model
- Tasarım ve kurulum
- Çıktı
- API standardı, gateway ve geliştirici portalı
Entegrasyonlarınızın bir platforma ihtiyaç duyduğunu gösteren işaretler
Entegrasyonlar nadiren tek bir kötü API yüzünden aksar. Aksamalarının nedeni, onları kurmanın ortak bir yolunun olmamasıdır.
- Her yeni iş ortağı entegrasyonu ayrı bir proje olarak tahmin ediliyor, ekibi kuruluyor ve teslim ediliyor.
- Aynı şirketteki iki API farklı isimlendirme, hata formatı, sayfalama ve kimlik doğrulama kullanıyor.
- API dokümantasyonu iki sürüm önce güncellenmiş bir wiki sayfası; iş ortakları doğrudan mühendislerinize soruyor.
- Bir servisteki değişiklik, varlığından kimsenin haberi olmayan bir tüketiciyi bozuyor.
- Kimlik doğrulama, hız limitleri ve loglama her serviste farklı uygulanmış.
- Hangi API sürümlerinin hâlâ kullanıldığını ve kimin kullandığını kimse söyleyemiyor.
- Bir iş ortağının adresi erişilemez olduğunda webhook’lar elle yeniden gönderiliyor.
Araçlarla uygulanan bir standart
Tutarsız API’ler bir disiplin sorunu değildir. Yazılı bir standart ve onu kontrol eden araçlar olmadığında her ekip makul ama farklı seçimler yapar ve bu farklar, kimsenin bir seferde öğrenemeyeceği bir yüzeye dönüşür.
Standardı ekiplerinizle birlikte yazarız: kaynak isimlendirme, hatalar, sayfalama, sürümleme, kimlik doğrulama, idempotency ve webhook teslimi. Sonra ona uymayı ucuz hale getiririz: dağıtım hattında lint kontrolü, ortak kaygıları üstlenen bir gateway ve kırıcı değişiklikleri sürümden önce yakalayan sözleşme testleri.
Geliştirici portalı döngüyü kapatır. İş ortakları ve iç ekipler doğru, otomatik üretilmiş dokümantasyonu bulur, çağrıları bir sandbox ortamında dener ve bir talep açmadan anahtar alır.
Kapsam
Dahildir
- API standardı: isimlendirme, hatalar, sayfalama, sürümleme, idempotency
- API gateway kurulumu: kimlik doğrulama, hız limitleri, loglama
- Dağıtım hattında sözleşme testleri
- OpenAPI veya AsyncAPI ile önce şartname akışı
- Tekrar deneme ve imzalı webhook teslimi
- Otomatik dokümantasyon ve sandbox içeren geliştirici portalı
- Mevcut API’lerin ve tüketicilerinin envanteri
- En çok kullanılan mevcut API’ler için geçiş planı
Dahil değildir
- Tüm mevcut API’lerin aynı anda yeniden yazılması
- İş ortağına özel iş özelliklerinin geliştirilmesi
- API’lerin ticari olarak fiyatlanması
- Devirden sonra gateway’in işletimi
İş nasıl ilerler
- Hafta 1 ila 2Envanter çıkarın. Mevcut API’ler, tüketiciler, sürümler ve hata geçmişi haritalanır; en çok maliyet çıkaran entegrasyonlar belirlenir.
- Hafta 3 ila 5Standardı yazın. API standardı ekiplerinizle birlikte yazılır ve mevcut API’lerinizle karşılaştırılır. İstisnalar gizlenmez, kayda geçirilir.
- Hafta 6 ila 10Platformu kurun. Gateway, sözleşme testleri, şartname kontrolü ve geliştirici portalı kurulur; ilk API’ler bunların üzerine alınır.
- Son haftalarTaşıyın ve devredin. En çok kullanılan API’ler gateway’in arkasına taşınır; standardı ve araçları ekipleriniz devralır.
Elinize geçenler
Her şey sizin hesaplarınızda ve dağıtım hatlarınızda kurulur.
Bu hizmet kimin için değil
- Bir ya da iki sabit entegrasyonu olan şirketler. Tam bir platform, kazandıracağından fazlasına mal olur.
- Standardın yazılmasını isteyip uygulanmasını istemeyen ekipler. Araçla desteklenmeyen bir belge bir çeyrek içinde unutulur.
- Belirli bir iş ortağı entegrasyonunun bu ay kurulmasına ihtiyaç duyan projeler. Kurabiliriz, ama tek seferlik bir iş olarak değil, platformun üzerinde.
Sık sorulanlar
REST mi, GraphQL mi, olaylar mı?
Her birinin yeri var. Şirketlerin çoğu iş ortakları için REST ya da HTTP API’lerine, iç akışlar için olaylara, bazen de kendi arayüzleri için GraphQL’e ihtiyaç duyar. Standart, gerçekten kullandığınız stilleri kapsar.
Ticari bir API gateway’e ihtiyacımız var mı?
Gerekmeyebilir. Açık kaynak gateway’ler ve AWS, Azure ve Google Cloud’un yönetilen gateway’leri çoğu ihtiyacı karşılar. Trafiğinize, ekibinize ve bulutunuza göre seçeriz.
Standarda uymayan mevcut API’lere ne olacak?
Bir sahip ve bir planla listelenirler. En çok kullanılanlar önce taşınır; trafiği düşük olanlar emekliye ayrılana kadar kayıtlı istisna olarak kalabilir.
Sözleşme testleri ekipler arasında nasıl çalışıyor?
Tüketiciler neye dayandıklarını tanımlar, sağlayıcılar bu beklentileri kendi dağıtım hatlarında çalıştırır; bir tüketiciyi bozacak değişiklik sürümden önce başarısız olur.
İş ortakları üretime dokunmadan test edebilir mi?
Evet. Geliştirici portalı, gerçekçi test verisi ve ayrı anahtarlarla bir sandbox ortamı içerir.
Önce kısa bir teknik sohbetle başlayalım
Otuz dakika. Canınızı yakan iki üç entegrasyonu gösterirsiniz, biz ortak bir standardın neyi değiştireceğini söyleriz.