Yayınlamaya genel bakış

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info

Yayınlama, API'lerinizi uygulama geliştiricilerin kullanımına sunma işlemidir.

API yayınlama işlemi, bu konuda açıklanan aşağıdaki görevleri içerir:

1. Edge'de API'lerinizi bir araya getiren API ürünlerini oluşturun.
2. Uygulama geliştiricilerini Edge'e kaydedin.
3. Geliştirici uygulamalarını Edge'e kaydedin.
4. API'leriniz için dokümanlar ve topluluk desteği sağlayın.

1. görev: Edge'de API ürünü oluşturma

Yayınlama işleminin ilk adımı bir API ürünü oluşturmaktır. API ürünü, uygulama geliştiricilere kullanım için paket halinde sunulan bir API kaynağı koleksiyonudur. Edge yönetim API'sini 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? başlıklı makaleyi inceleyin.)

Bu şekildeki 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 tüm iş gereksinimlerini karşılayacak API'leri ve API ürünlerini oluşturmaktan sorumlusunuz. Ö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 düşük bir erişim sınırıyla (ör. günlük 1.000 istek) sunulan ikinci bir API ürünü yayınlayın.
• Aynı API kaynağına yüksek erişim sınırıyla okuma/yazma erişimi sağlayan, daha yüksek fiyatlı üçüncü bir API ürünü yayınlayın.

Edge'in, API'lerinizin iş gereksinimlerine uyan API ürünleri oluşturma esnekliği sunduğunu unutmayın.

API ürünleri oluşturma hakkında daha fazla bilgi için API ürünleri oluşturma başlıklı makaleyi inceleyin.

2. görev: Edge'de bir uygulama geliştiriciyi kaydetme

Geliştiriciler, API'lerinizi kullanan uygulamaları oluşturur. Uygulama geliştiriciler, uygulamalarını kaydettirmeden önce Apigee Edge'e kaydolurlar. Uygulamalarını kaydettiklerinde, uygulamaya API'ye erişim izni verecek bir API anahtarı alırlar.

API'lerinize kimlerin erişebileceğini uygulama kayıt işlemi aracılığıyla kontrol edersiniz. İstediğiniz zaman bir uygulama geliştiricisini silebilirsiniz. Bu işlem, geliştiriciyle ilişkili tüm API anahtarlarını geçersiz kılar ve geliştiricinin API'lerinize erişimini reddeder.

API sağlayıcı olarak geliştiricilerin nasıl kaydedileceğine siz karar verirsiniz. Örneğin, kaydolmak için potansiyel geliştiricilerin kuruluşunuzla iletişime geçmesini gerektiren manuel bir kayıt süreci kullanabilirsiniz. Potansiyel geliştirici, e-posta adresi, ad, soyadı ve şirket adı gibi gerekli tüm 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 başlıklı makaleyi inceleyin.

Apigee, geliştirici kaydı sürecini otomatikleştirmek için kullanabileceğiniz araçlar da sağlar. Örneğin:

• Kayıt işlevini mevcut web sitenize entegre etmek için Apigee Edge yönetim API'sini kullanın. Edge Management API, geliştirici kayıt sürecinin tüm aşamalarını gerçekleştirmek için kullanabileceğiniz bir REST API'sidir. Daha fazla bilgi için API'leri yayınlamak için Edge Management API'yi kullanma başlıklı makaleyi inceleyin.
• Geliştiricileri kaydetmek için Apigee Developer Services portalını kullanın. Portalda geliştirici kaydı için yerleşik destek bulunur ancak API'lerinizi destekleyen birçok özellik de vardır. Daha fazla bilgi için Geliştirici portalı nedir? başlıklı makaleyi inceleyin.

3. görev: Edge'de geliştirici uygulaması kaydetme

Bir uygulamanın API'lerinize erişebilmesi için Edge'e kaydedilmesi gerekir. Ancak Edge'e 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. Uygulama geliştirici, mevcut API ürünleri listesinden seçim yapabilir.

Uygulamanın Edge'e kaydedilmesine yanıt olarak Edge, uygulamaya benzersiz bir API anahtarı atar. Uygulama, API kaynağına yapılan her istek kapsamında bu API anahtarını iletmelidir. Anahtarın kimliği doğrulanır ve geçerliyse istek kabul edilir. Servis sağlayıcı olarak, uygulamanın API'lerinize erişememesi için anahtarı dilediğiniz zaman iptal edebilirsiniz.

API sağlayıcı olarak, uygulamaları nasıl kaydettirmek istediğinize siz karar verirsiniz. Şunları yapabilirsiniz:

• Geliştiricinin uygulamasını kaydettirmek için kuruluşunuzla iletişime geçmesini gerektiren manuel bir süreç kullanın. Geliştiriciye API anahtarını (muhtemelen e-postayla) gönderebilirsiniz.
• Uygulama kaydı işlevini ve anahtar yayınlamayı web sitenize entegre etmek için Edge Management API'yi kullanın.
• Ücretli bir Edge hesabı için uygulama kaydı ve API anahtarı yayınlama için yerleşik destek sunan Apigee Developer Services portalını kullanın.

Daha fazla bilgi için Uygulama kaydetme ve API anahtarlarını yönetme başlıklı makaleyi inceleyin.

4. Görev: API'lerinizi belgeleyin

API ürünlerini yayınlarken dikkat edilmesi gereken önemli noktalardan biri, dokümanlar ve geliştirici geri bildirim mekanizması sağlamaktır. Sosyal yayınlama özelliklerine sahip geliştirici portalları, geliştirici topluluğuyla iletişim kurmak için giderek daha fazla kullanılıyor. Buna API dokümanları ve kullanım şartları gibi statik içeriklerin yanı sıra, topluluk tarafından oluşturulan dinamik içerikler (ör. bloglar ve forumlar) ve müşteri desteği özellikleri de dahildir.

Belgelerinizi dağıtmak için kendi web sitenizi oluşturabilir veya ücretli bir Edge hesabınız varsa Apigee Developer Services portalını kullanabilirsiniz. Portalda, geliştirici topluluğunuzu desteklemek için gereken belgeler, bloglar, forumlar ve diğer içerik türleri için yerleşik destek bulunur.

SmartDocs, API'lerinizi Geliştirici Hizmetleri portalında API belgelerinin tamamen etkileşimli olmasını sağlayacak şekilde belgelemenize olanak tanır. SmartDocs ile etkileşimli belgeler sayesinde portal kullanıcıları:

• 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 SmartDocs 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 parametresi için bir değer girer ve ardından canlı isteği ve yanıtı görmek için İsteği gönder düğmesini tıklar. API'lerinizle ilgili etkileşimli bir doküman oluşturarak portal kullanıcılarının API'lerinizi öğrenmesini, test etmesini ve değerlendirmesini kolaylaştırırsınız.

Edge yönetim API'si, herhangi bir HTTP istemcisi kullanarak API Hizmetleri'ne erişmenizi sağlayan bir REST API'sidir. Apigee, Edge yönetim API'si için etkileşimli dokümanlar oluşturmak üzere SmartDocs'u kullanır. API dokümanlarını burada bulabilirsiniz.

Daha fazla bilgi için API'leri belgelemek için SmartDocs'u kullanma başlıklı makaleyi inceleyin.