Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Yayınlama, API'lerinizi uygulama geliştiricilerin kullanımına sunma sürecidir.
Video: Aşağıdaki videoda API yayınlamayla ilgili genel bilgiler verilmektedir.
API yayınlama, bu konuda açıklanan aşağıdaki görevleri içerir:
- Edge'de, API'lerinizi paketleyen API ürünlerini oluşturun.
- Edge'de uygulama geliştiricilerini kaydedin.
- Edge'de geliştirici uygulamalarını kaydedin.
- API'leriniz için belgeler ve topluluk desteği sağlayın.
1. Görev: Edge'de API ürünü oluşturma
Yayınlamada ilk görev bir API ürünü oluşturmaktır. API ürünü, uygulama geliştiricilerin kullanımına yönelik bir paket olarak sunulan API kaynaklarından oluşan bir koleksiyondur. Edge Management API veya kullanıcı arayüzünü kullanarak API ürünleri oluşturun. (API ürünleri hakkında daha fazla bilgi edinmek için API ürünü nedir? bölümüne bakın.)
Bu şekilde API, her biri üç API kaynağı içeren iki üründen oluşur.
API sağlayıcısı olarak erişim denetimi, kullanım kısıtlamaları ve diğer işletme gereksinimlerini karşılamak için API'ler ve API ürünleri oluşturmak sizin sorumluluğunuzdadır. Örneğin, şunları yapabilirsiniz:
- API kaynaklarına salt okuma erişimi sağlayan ücretsiz bir API ürünü yayınlayın.
- Ücretsiz sürümle aynı API kaynaklarına okuma/yazma erişimi sağlayan ancak günlük 1.000 istek gibi düşük bir erişim sınırına sahip olan düşük fiyata ikinci bir API ürünü yayınlayın.
- Aynı API kaynağına okuma/yazma erişimine izin veren ancak yüksek bir erişim sınırına sahip olan daha yüksek fiyata üçüncü bir API ürünü yayınlayın.
Edge'in size API'lerinizin iş gereksinimlerine uyan API ürünleri oluşturma esnekliği sunmasıdır.
API ürünleri oluşturma hakkında daha fazla bilgi için API ürünleri oluşturma başlıklı makaleye bakın.
2. Görev: Edge'e uygulama geliştirici kaydetme
Bir geliştirici, API'lerinizi kullanan uygulamaları oluşturur. Bir uygulama geliştirici, uygulamasını kaydedebilmek için Apigee Edge'e kaydolur. Uygulamasını kaydettirdiğinde uygulamanın API'ye erişmesine izin verecek bir API anahtarı alır.
Uygulama kayıt işlemi aracılığıyla, API'lerinize kimlerin erişebileceğini kontrol edebilirsiniz. Bir uygulama geliştiriciyi istediğiniz zaman silebilirsiniz. Bu durumda geliştiriciyle ilişkili tüm API anahtarları geçersiz hale gelir ve söz konusu geliştiricinin API'lerinize erişimi reddedilir.
API sağlayıcısı olarak geliştiricilerin nasıl kaydedileceğine siz karar verirsiniz. Örneğin, potansiyel bir geliştiricinin kaydolmak için kuruluşunuzla iletişime geçmesini gerektiren manuel kayıt işlemi kullanabilirsiniz. Potansiyel geliştirici; e-posta adresi, ad, soyadı ve şirket adı gibi tüm gerekli bilgileri sağlamalıdır. Geliştiricinin isteğini onaylarsanız geliştiriciyi manuel olarak kaydetmek için Edge yönetim kullanıcı arayüzünü kullanabilirsiniz. Daha fazla bilgi için Uygulama geliştiricilerini yönetme bölümüne bakın.
Apigee, geliştirici kayıt işlemini otomatikleştirmek için kullanabileceğiniz araçlar da sunar. Örneğin:
- Kayıt işlevini mevcut web sitenize entegre etmek için Apigee Edge Management API'yi kullanın. Edge Management API, geliştirici kayıt işlemini tüm yönleriyle gerçekleştirmek için kullanabileceğiniz bir REST API'dir. Daha fazla bilgi için API'leri Yayınlamak için Edge Management API'yi Kullanma konusuna bakın.
- Geliştiricileri kaydetmek için Apigee Geliştirici Hizmetleri portalını kullanın. Portalda geliştirici kaydı için yerleşik destek sunulur ancak API'lerinizi destekleyecek birçok başka özellik de mevcuttur. Daha fazla bilgi için Geliştirici portalı nedir? bölümüne bakın.
3. Görev: Edge'e geliştirici uygulaması kaydetme
Bir uygulamanın API'lerinize erişebilmesi için uygulamanın Edge'de kayıtlı olması gerekir. Bununla birlikte, Edge'de yalnızca kayıtlı geliştiriciler uygulama kaydedebilir.
Geliştirici, uygulama kaydı sırasında bir veya daha fazla API ürünü seçer. Örneğin, farklı hizmet türlerine ve fiyatlandırma planlarına karşılık gelen birden fazla API ürünü yayınlayabilirsiniz. Daha sonra uygulama geliştirici, mevcut API ürünleri listesinden seçim yapabilir.
Edge, uygulamayı Edge'e kaydettikten sonra uygulamaya benzersiz bir API anahtarı atar. Uygulama, API kaynağına yapılan her isteğin parçası olarak bu API anahtarını iletmelidir. Anahtarın kimliği doğrulanır ve geçerliyse istek onaylanır. Uygulamanın artık API'lerinize erişememesi için servis sağlayıcı olarak istediğiniz zaman anahtarı iptal edebilirsiniz.
API sağlayıcısı olarak uygulamaların nasıl kaydedileceğine siz karar verirsiniz. Şunları yapabilirsiniz:
- Geliştiricinin, uygulamasını kaydettirmek için kuruluşunuzla iletişime geçmesini gerektiren manuel bir işlem kullanın. Buna yanıt olarak, geliştiriciye API anahtarını muhtemelen e-postayla gönderirsiniz.
- Uygulama kaydı işlevini ve anahtar teslimini web sitenize entegre etmek için Edge Management API'yi kullanın.
- Ücretli Edge hesabı için uygulama kaydı ve API anahtarı dağıtımı için yerleşik desteğe sahip olan Apigee Geliştirici Hizmetleri portalını kullanın.
Daha fazla bilgi için Uygulamaları kaydetme ve API anahtarlarını yönetme konusuna bakın.
4. Görev: API'lerinizi belgeleyin
API ürünlerinin yayınlanmasında dikkate alınması gereken önemli noktalardan biri belge ve bir geliştirici geri bildirim mekanizması sağlamaktır. Sosyal yayınlama özelliklerine sahip geliştirici portalları, geliştirme topluluğuyla iletişim için giderek daha fazla kullanılıyor. Buna API belgeleri ve kullanım şartları gibi statik içeriğin yanı sıra bloglar ve forumlar gibi topluluğun katkıda bulunduğu dinamik içeriklerin yanı sıra müşteri desteği özellikleri de iletilir.
Belgelerinizi dağıtmak için kendi web sitenizi oluşturabilir veya ücretli bir Edge hesabınız varsa Apigee Geliştirici Hizmetleri portalını kullanabilirsiniz. Portalda, geliştirici topluluğunuzu desteklemek için gereken dokümanlar, bloglar, forumlar ve diğer içerik türleri için yerleşik destek bulunur.
SmartDocs, API'lerinizi Geliştirici Hizmetleri portalında, API belgelerini tamamen etkileşimli bir şekilde belgelemenizi sağlar. SmartDokümanlar ile etkileşimli belgeler sayesinde portal kullanıcıları şunları yapabilir:
- API hakkında bilgi edinin
- API'ye canlı istek gönderme
- API'den döndürülen canlı yanıtı görüntüleme
Örneğin, aşağıdaki şekilde Smart Docs kullanılarak portalda belgelenmiş bir API gösterilmektedir. Bu API, belirli bir konumla ilgili hava durumu bilgilerini sağlar:
Geliştirici, konumu belirtmek için "w" sorgu parametresine bir değer girer ve canlı isteği ve yanıtı görmek için İsteği gönder düğmesini tıklar. API'lerinizde etkileşimli bir belge oluşturarak portal kullanıcısının API'lerinizi öğrenmesini, test etmesini ve değerlendirmesini kolaylaştırırsınız.
Edge Management API, herhangi bir HTTP istemcisini kullanarak API Hizmetlerine erişmenizi sağlayan bir REST API'dir. Apigee, SmartDokümanlar'ı kullanarak Edge Management API için etkileşimli belgeler oluşturur. Buradaki API belgelerine bakın.
Daha fazla bilgi için Dokümanlar API'lerini dokümanlamak için kullanma bölümüne bakın.