Yayınlamaya genel bakış

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ınlama hakkında genel bir giriş yapılıyor.

Yayınlama API'leri, bu konuda açıklanan aşağıdaki görevleri içerir:

  1. API'lerinizi paketleyen Edge'de API ürünleri oluşturun.
  2. Edge'e uygulama geliştiricileri kaydetme
  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ınlamanın ilk görevi bir API ürünü oluşturmaktır. API ürünü, uygulama geliştiricilere tüketim için paket olarak sunulan API kaynakları koleksiyonudur. Edge Management API'yi 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.)

Soldan sağa doğru bir geliştiriciyi, uygulamayı, API'leri ve arka uç hizmetlerini gösteren sıralı diyagram. API simgesi ve kaynakları vurgulanır. Noktalı bir çizgi, geliştiriciden geliştiricinin oluşturduğu bir uygulamanın simgesine doğru uzanır. Uygulamaya giden ve uygulamadan geri gelen oklar, bir API simgesine yönelik istek ve yanıt akışını gösterir. Uygulama anahtarı, isteğin üzerinde yer alır. API simgesi ve kaynakları vurgulanır. API simgesinin altında, iki API ürününde gruplandırılmış iki kaynak yolu grubu bulunur: Konum ürünü ve Medya ürünü. Location ürününde /countries, /cities ve /languages kaynakları, Media ürününde ise /books, /magazines ve /movies kaynakları bulunur. API'nin sağında, API'nin çağırdığı arka uç kaynakları (veritabanı, kurumsal hizmet veri yolu, uygulama sunucuları ve genel bir arka uç dahil) yer alır.

Bu şekilde, API her biri üç API kaynağı içeren iki üründen oluşur.

API sağlayıcı olarak, erişim denetimi, kullanım kısıtlamaları ve diğer tüm iş gereksinimlerini karşılayacak API'ler ve API ürünleri oluşturmaktan siz 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ı (ör. günde 1.000 istek) olan ikinci bir API ürününü düşük bir fiyata yayınlayın.
  • Aynı API kaynağına okuma/yazma erişimi sağlayan ancak yüksek erişim sınırına sahip üçüncü bir API ürününü daha yüksek bir fiyata yayınlayın.

Unutulmaması gereken nokta, Edge'in 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ı makaleyi inceleyin.

2. görev: Edge'e uygulama geliştirici kaydetme

Geliştiriciler, API'lerinizi kullanan uygulamalar oluşturur. Bir uygulama geliştirici, uygulamasını kaydetmeden önce Apigee Edge'e kaydolur. Uygulamasını kaydettiğinde, uygulamaya API'ye erişim izni verecek bir API anahtarı alır.

Uygulama kayıt işlemi aracılığıyla API'lerinize kimlerin erişebildiğini kontrol edebilirsiniz. İstediğiniz zaman bir uygulama geliştiriciyi silebilirsiniz. Bu durumda, geliştiriciyle ilişkili tüm API anahtarları geçersiz kılınır ve geliştiricinin API'lerinize erişimi engellenir.

Soldan sağa doğru bir geliştiriciyi, uygulamayı, API'leri ve arka uç hizmetlerini gösteren sıralı diyagram. Geliştirici simgesi vurgulanır. Noktalı bir çizgi, vurgulanan geliştiriciden geliştiricinin oluşturduğu bir uygulamanın simgesine doğru uzanır. Uygulamaya giden ve uygulamadan geri gelen oklar, bir API simgesine yönelik istek ve yanıt akışını gösterir. Uygulama anahtarı, isteğin üzerinde yer alır. API simgesinin altında, iki API ürününde gruplandırılmış iki kaynak yolu grubu bulunur: Konum ürünü ve Medya ürünü. Location ürününde /countries, /cities ve /languages kaynakları, Media ürününde ise /books, /magazines ve /movies kaynakları bulunur. API'nin sağında, API'nin çağırdığı arka uç kaynakları (veritabanı, kurumsal hizmet veri yolu, uygulama sunucuları ve genel bir arka uç dahil) yer alır.

API sağlayıcı 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 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 kayıt sürecini 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 sürecinin tüm aşamalarını gerçekleştirmek için kullanabileceğiniz bir REST API'sidir. Daha fazla bilgi için Using the Edge management API to Publish APIs 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. Ayrıca API'lerinizi destekleyecek birçok özellik de mevcuttur. 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 yalnızca kayıtlı bir geliştirici, Edge'e uygulama kaydedebilir.

Soldan sağa doğru bir geliştiriciyi, uygulamayı, API'leri ve arka uç hizmetlerini gösteren sıralı diyagram. Uygulama, istek/yanıt ve API anahtarı okları vurgulanır. Noktalı bir çizgi, geliştiriciden geliştiricinin oluşturduğu bir uygulamanın simgesine doğru uzanır. Uygulamaya giden ve uygulamadan geri gelen oklar, bir API simgesine yönelik istek ve yanıt akışını gösterir. Uygulama anahtarı, isteğin üzerinde yer alır. API simgesi ve kaynakları vurgulanır. API simgesinin altında, iki API ürününde gruplandırılmış iki kaynak yolu grubu bulunur: Konum ürünü ve Medya ürünü. Location ürününde /countries, /cities ve /languages kaynakları, Media ürününde ise /books, /magazines ve /movies kaynakları bulunur. API'nin sağında, API'nin çağırdığı arka uç kaynakları (veritabanı, kurumsal hizmet veri yolu, uygulama sunucuları ve genel bir arka uç dahil) yer alır.

Uygulama kaydı sırasında geliştirici 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 daha sonra mevcut API ürünleri listesinden seçim yapabilir.

Uygulama Edge'e kaydedildiğinde Edge, uygulamaya benzersiz bir API anahtarı atar. Uygulama, API kaynağına yapılan her isteğin bir parçası olarak bu API anahtarını iletmelidir. Anahtarın kimliği doğrulanır ve geçerliyse istek kabul edilir. Hizmet sağlayıcı olarak siz, istediğiniz zaman anahtarı iptal edebilirsiniz. Böylece uygulama, API'lerinize erişemez.

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

  • Geliştiricinin uygulamasını kaydetmek için kuruluşunuzla iletişime geçmesini gerektiren manuel bir süreç kullanın. Buna karşılık olarak, geliştiriciye API anahtarını (ör. e-posta yoluyla) gönderin.
  • Uygulama kaydı işlevini ve anahtar teslimini web sitenize entegre etmek için Edge Management API'yi kullanın.
  • Ücretli bir Edge hesabı için, uygulama kaydı ve API anahtarı teslimi için yerleşik destek sunan Apigee Developer Services portalını kullanın.

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

4. görev: API'lerinizi belgeleyin

API ürünlerini yayınlarken önemli bir nokta, doküman ve geliştirici geri bildirim mekanizması sağlamaktır. Sosyal yayınlama özelliklerine sahip geliştirici portalları, geliştirme topluluğuyla iletişim kurmak için giderek daha fazla kullanılıyor. API belgeleri ve kullanım şartları gibi statik içeriklerin yanı sıra bloglar ve forumlar gibi topluluk tarafından gönderilen dinamik içerikler ve müşteri desteği özellikleri de bu kapsamdadır.

Soldan sağa doğru bir geliştiriciyi, uygulamayı, API'leri ve arka uç hizmetlerini gösteren sıralı diyagram. Geliştirici simgesi vurgulanır. Geliştiricinin altında, geliştirici portalını temsil eden bir kutu bulunur. Portalda API belgeleri, örnekler, eğitimler, API referansı ve diğer bilgiler yer alır. Portalda ayrıca bloglar, forumlar ve bir destek portalı da bulunur. Noktalı bir çizgi, vurgulanan geliştiriciden geliştiricinin oluşturduğu bir uygulamanın simgesine doğru uzanır. Uygulamaya giden ve uygulamaya geri dönen oklar, bir API simgesine yönelik istek ve yanıt akışını gösterir. İstek üzerinde bir uygulama anahtarı bulunur. API simgesinin altında, iki API ürününde gruplandırılmış iki kaynak yolu grubu bulunur: Konum ürünü ve Medya ürünü. Location ürününde /countries, /cities ve /languages kaynakları, Media ürününde ise /books, /magazines ve /movies kaynakları bulunur. API'nin sağında, API'nin çağırdığı arka uç kaynakları (veritabanı, kurumsal hizmet veri yolu, uygulama sunucuları ve genel bir arka uç dahil) yer alır.

Dokümanlarınızı 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 belgelerini tamamen etkileşimli hale getirecek şekilde Geliştirici Hizmetleri portalında API'lerinizi 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 belgelendirilmiş bir API gösterilmektedir. Bu API, belirli bir konumla ilgili hava durumu bilgileri sağlar:

Konudaki bir düğmeyi tıklayarak hava durumu API'sini çağırmanızı sağlayan bir SmartDocs API yöntemi konusu.

Geliştirici, konumu belirtmek için "w" sorgu parametresine 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 belgeler oluşturarak portal kullanıcılarının API'lerinizi öğrenmesini, test etmesini ve değerlendirmesini kolaylaştırabilirsiniz.

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

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