API ürünlerini yönetin

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

API ürünlerini bu bölümde açıklandığı şekilde Apigee Edge yönetim kullanıcı arayüzünü kullanarak yönetin. API ürününü kullanarak API ürününü yönetmek için Using the Edge management API to Publish API'lerini inceleyin.

API ürününün nasıl oluşturulacağını öğrenmek için aşağıdaki videoyu izleyin.

API ürünlerine genel bir bakış için API ürünü nedir? bölümüne bakın.

API ürünleri sayfasını keşfedin

API ürünleri sayfasına aşağıda açıklanan şekilde erişin.

Edge

Edge kullanıcı arayüzünü kullanarak API ürünleri sayfasına erişmek için:

  1. https://apigee.com/edge adresinde oturum açın.
  2. Yayınla > API Ürünleri'ni seçin.

API Ürünleri sayfası görüntülenir.

API ürünlerinin listesini gösteren API Ürünleri sayfası. Gerçekleştirebileceğiniz görevleri gösteren ve şeklin altında listelenen açıklama metinlerini kullanabilirsiniz.

Önceki şekilde gösterildiği gibi API ürünleri sayfası, bu bölümün ilerleyen kısımlarında açıklanan aşağıdaki görevleri gerçekleştirmenize olanak tanır:

Klasik Edge (Private Cloud)

Klasik Edge kullanıcı arayüzünü kullanarak API ürünleri sayfasına erişmek için:

  1. http://ms-ip:9000 üzerinde oturum açın. Burada ms-ip, Yönetim Sunucusu düğümünün IP adresi veya DNS adıdır.
  2. Yayınla > Ürünler'i seçin.

API ürünleri sayfası, bu bölümün ilerleyen kısımlarında açıklanan aşağıdaki görevleri gerçekleştirmenizi sağlar:

API ürünü ekleme

Aşağıda açıklandığı gibi, kullanıcı arayüzünü kullanarak bir API ürünü ekleyin. Edge API'yi kullanmak için API'yi kullanarak API ürünlerini yapılandırma başlıklı makaleye bakın.

Edge kullanıcı arayüzünü kullanarak bir API ürünü eklemek için:

  1. Daha önce bu bölümde açıklandığı şekilde API ürünleri sayfasına erişin.
  2. +API Ürünü'nü tıklayın.
  3. API ürününüz için Ürün Ayrıntıları'nı girin.
    Alan Açıklama
    Ad API ürününün dahili adı. API ürünü oluşturulduktan sonra adı düzenleyemezsiniz. Adda özel karakter belirtmeyin.
    Görünen ad API ürününün görünen adı. Görünen ad, kullanıcı arayüzünde kullanılır ve dilediğiniz zaman düzenleyebilirsiniz. Belirtilmezse Name (Ad) değeri kullanılır. Bu alan, Ad değeri kullanılarak otomatik olarak doldurulur. Bu alanın içeriğini düzenleyebilir veya silebilirsiniz. Görünen ad özel karakterler içerebilir.
    Açıklama API ürününün açıklaması.
    Ortam API ürününün erişime izin vereceği ortamlar. Örneğin, test veya prod.
    Erişim Erişim düzeyi. Ayrıntılar için Erişim düzeyi başlıklı makaleyi inceleyin.
    Erişim isteklerini otomatik olarak onayla Herhangi bir uygulamadan bu API ürünü için anahtar isteklerinin otomatik olarak onaylanmasını etkinleştirin. Anahtarların manuel olarak onaylanmasını zorunlu kılmak için bu seçeneği devre dışı bırakın. Uygulamaları kaydetme ve API anahtarlarını yönetme (kullanıcı arayüzü) ve Geliştirici Uygulaması Anahtarları (API) konularını inceleyin.
    Kota Kota politikalarından başvurmak istediğiniz kota sınırı. Bir kota değeri girmek, ürün üzerinden yapılabilecek çağrı sayısına otomatik olarak kısıtlama getirmez. Ürünün referans verdiği API proxy'leri, kotayı uygulamak için Kota politikasını içermelidir. Daha fazla bilgi için Kotalar bölümüne bakın.
    İzin Verilen OAuth Kapsamları API ürünüyle OAuth kullanıyorsanız API ürününün izin vermesini istediğiniz OAuth kapsamlarına (ör. Okuma veya uygulamaların API çağrılarıyla göndereceği diğer kapsamlar) izin verin. Birden çok kapsamı virgülle ayrılmış liste olarak belirtin. OAuth kapsamları başlıklı makaleyi inceleyin.

  4. API proxy'leri ve kaynak yolları dahil olmak üzere API ürününde mevcut olan API Kaynaklarını ekleyin.

    Örneğin, temel yolu /music olan ürüne bir "music" API proxy'si eklerseniz API ürünü, /music çağrılarına izin verir. Ancak API ürününün yalnızca URI'sı /music/venues olan venues kaynak yoluna erişime izin vermesini istiyorsanız /venues kaynak yolunu ürüne ekleyin. Bu durumda, /music/venues?name=paramount numaralı telefona yapılan aramalara izin verilir, ancak /music/artists?name=Jack%Johnson numaralı telefona yapılan aramalar engellenir.

    Belirli bir kaynak yolunu veya kaynak yolunu / olarak belirterek temel yolu ve olası tüm alt yolları ayarlayın. Kaynak yolu, /** ve /* joker karakterleri içerebilir. Çift yıldız joker karakteri, temel yolun tüm alt yollarının desteklendiğini (ancak temel yolun desteklenmediğini) gösterir. Tek bir yıldız işareti, yalnızca temel yoldan bir düzey aşağıda yer alan URI'ların desteklendiğini gösterir. Bu bölümün ilerleyen kısımlarında açıklandığı şekilde, "/", "/*" ve "/**" kaynak yolunun davranışını yapılandırma konusuna bakın.

    API kaynakları eklemek için:

    1. API kaynakları bölümünde Proxy ekle'yi veya Yol ekle'yi tıklayın.
    2. API proxy'si, Yol veya hem API proxy'si hem de yol eklemek isteyip istemediğinizi seçin.

      API kaynağı ekleme bölümü bir API proxy'si, kaynak yolu veya her ikisini birden ekleyebilmenizi sağlar.

    3. Bir veya daha fazla API proxy'si ve kaynak yolu ekleyin.

      Aşağıdakileri göz önünde bulundurun:

      • Tanımladığınız kaynak yolları, API ürününe eklenen tüm API proxy'leri için geçerli olur.
      • Daha kapsamlı ve daha az spesifik kaynak yolları, daha spesifik olanlara göre önceliklidir. Örneğin, / ve /** eklerseniz / kaynak yolu öncelikli olur; /** kaynak yolu yoksayılır.

      Örneğin:

      Tüm API proxy'lerine ve daha spesifik kaynak yollarına uygulanan kaynak yolu yoksayılır

    4. Ek API kaynakları belirtmek için Ekle veya Başka ekle ve başlat'ı tıklayın.
  5. (İsteğe bağlı) Ürünü bir veya daha fazla uzak hizmet hedefine bağlamak için Apigee uzak hizmet hedefleri bölümünü kullanın. Apigee Envoy Adapter kullanmıyorsanız bu ayarı yoksayabilirsiniz. Daha fazla bilgi için Apigee Envoy Adapter'ın Operasyon Rehberi'ne bakın.

  6. (İsteğe bağlı) Bir API ürününe en fazla 18 özel özellik eklemek için Özel özellikler bölümünü kullanın.

    Özel özellikler, API proxy'sinin yürütülmesini kontrol etmeye yardımcı olmak da dahil olmak üzere birçok şekilde kullanılabilen anahtar/değer çiftleridir. Örneğin, doğru veya yanlış değerine sahip deprecated adlı bir özel özellik oluşturabilirsiniz. API proxy akışınızda, API ürününün deprecated özelliğinin değerini kontrol edebilirsiniz (örneğin, özel özellik oluşturulduktan sonra otomatik olarak kullanılabilen verifyapikey.{policy_name}.apiproduct.deprecated değişkenini kullanarak). Değeri true (doğru) ise (kullanımdan kaldırıldı) Hata Oluştur politikasını kullanarak hata verebilirsiniz.

  7. Kaydet'i tıklayın.

"/", "/*" ve "/**" kaynak yolunun davranışını yapılandırma

Aşağıdaki tabloda bir API ürününün farklı kaynak yolları için varsayılan davranışı açıklanmaktadır. Bu örnekte, API proxy'sinin temel yolu /v1/weatherapikey şeklindedir. API ürün kaynağı yolu, temel yoldan sonraki yol son ekine uygulanır.

İstek URI'si / için izin veriliyor /* için izin veriliyor /** için izin verilir /*/2/** için izin verilir /*/2/* için izin verilir

/v1/weatherapikey

Y

H

H

H

N

/v1/weatherapikey/

Y

H

H

H

N

/v1/weatherapikey/1

Y

Y

E

H

N

/v1/weatherapikey/1/

Y

Y

E

H

N

/v1/weatherapikey/1/2

Y

H

E

H

N

/v1/weatherapikey/1/2/

Y

H

Y

E

N

/v1/weatherapikey/1/2/3/

Y

H

Y

Y

Y

/v1/weatherapikey/1/a/2/3/

Y

H

E

H

N

Varsayılan olarak bir API ürünündeki / kaynak yolu, temel yolu ve tüm alt yolları destekler. Örneğin, API proxy'sinin Temel Yolu /v1/weatherapikey ise API ürünü /v1/weatherapikey ve alt yollara (ör. /v1/weatherapikey/forecastrss ve /v1/weatherapikey/region/CA) yapılan istekleri destekler.

Bu varsayılan değeri, / kaynak yolunun yalnızca API proxy'sinin Temel Yolu'na karşılık gelecek şekilde değiştirebilirsiniz. Diğer bir deyişle, API ürünü / karakterinden sonra herhangi bir şey içeren URI'ye erişim izni vermez. Bu değişikliği yaparsanız yukarıdaki tabloda yalnızca "/ için izin verildi" bölümünün altındaki ilk iki satırda "Y" bulunur.

Varsayılan değeri değiştirmek için bir sistem yöneticisinin kuruluşunuzdaki features.isSingleForwardSlashBlockingEnabled özelliğinin değerini true olarak ayarlaması gerekir. Cloud müşterileri, bu talebi Apigee Edge Destek Ekibi'ne iletebilir.

API ürününü düzenleme

Bir API ürününü düzenlemek için:

  1. Daha önce bu bölümde açıklandığı şekilde API ürünleri sayfasına erişin.
  2. Düzenlemek istediğiniz API ürününün satırını tıklayın.
  3. API ürün sayfasında Düzenle'yi tıklayın.
  4. Alanları gerektiği gibi düzenleyin.

    Bir API ürününe eklediğiniz kaynakları silebilirsiniz. Bir kaynak bozuksa veya daha fazla geliştirme gerektiriyorsa bu işlemi yapabilirsiniz. Kaynak silindiğinde artık API ürününün bir parçası olmaz. API ürününü kullanan uygulamalar artık silinen kaynağa erişemez. Silinen kaynaklar üründen kaldırılır ancak sistemden silinmez. Böylece, bu kaynaklar diğer ürünler tarafından kullanılmaya devam eder.

  5. Kaydet'i tıklayın.

Herkese Açık Bulut İçin Apigee Edge sayesinde Edge, varlıklara erişildikten sonra aşağıdaki varlıkları en az 180 saniye boyunca önbellekte tutar.

  • OAuth erişim jetonları. Bu, iptal edilen bir jetonun önbellek sınırının süresi dolana kadar üç dakika kadar daha başarılı olmaya devam edebileceği anlamına gelir.
  • Anahtar Yönetim Hizmeti (KMS) varlıkları (Uygulamalar, Geliştiriciler, API Ürünleri).
  • OAuth jetonları ve KMS varlıklarındaki özel özellikler.

API ürününü silme

Bir API ürününü silebilmeniz için ürünle ilişkilendirilmiş tüm geliştirici uygulamalarının kaydını iptal etmeniz/ilişkiyi iptal etmeniz gerekir. Bu işlemi uygulamaları silerek veya uygulama API anahtarlarını iptal ederek yapabilirsiniz.

Bir API ürününü silmek için:

  1. Daha önce bu bölümde açıklandığı şekilde API ürünleri sayfasına erişin.
  2. İmleci listedeki API ürününün üzerine getirin.
  3. Sil simgesi simgesini tıklayın.
  4. Silme işlemini onaylamak için Sil'i tıklayın.