Öğretici: Ürün oluşturma ve yayımlama

  • Makale

UYGULANANLAR: Tüm API Management katmanları

Azure API Management'ta bir ürün bir veya daha fazla API, kullanım kotası ve kullanım koşulları içerir. Bir ürün yayımlandıktan sonra geliştiriciler ürüne abone olabilir ve ürünün API'lerini kullanmaya başlayabilir.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

  • Ürün oluşturma ve yayımlama
  • Ürüne API ekleme
  • Ürün API'lerine erişme

Portalda API Management ürünleri

Önkoşullar

Ürün oluşturma ve yayımlama

  1. Azure portalında oturum açın ve API Management örneğine gidin.

  2. Sol gezinti bölmesinde Ürünler>+ Ekle'yi seçin.

    Azure portalında ürün ekleme

  3. Ürün ekle penceresinde, aşağıdaki tabloda açıklanan değerleri girerek ürününüzü oluşturun.

    Ürün ekle penceresi

    Veri Akışı Adı Açıklama
    Görünen ad Geliştirici portalında gösterilmesini istediğiniz ad.
    Açıklama Ürün hakkında amacı, erişim sağladığı API'ler ve diğer ayrıntılar gibi bilgileri sağlayın.
    Durum Ürünü yayımlamak istiyorsanız Yayımlandı'yı seçin. Bir üründeki API'lerin çağrılabilmesi için önce ürünün yayımlanması gerekir. Varsayılan olarak, yeni ürünler yayımdan kaldırılır ve yalnızca Yönetici istrators grubu tarafından görülebilir.
    Abonelik gerektirir Kullanıcının ürünü kullanmak için abone olması gerekip gerekmediğini (ürün korunuyor) ve ürünün API'lerine erişmek için bir abonelik anahtarı kullanılması gerekip gerekmediğini seçin. Abonelik gerekmiyorsa (ürün açıksa), ürünün API'lerine erişmek için abonelik anahtarı gerekmez. Bu makalenin devamında ürün API'lerine erişim konusuna bakın.
    Onay gerekiyor Bir yöneticinin bu ürüne yönelik abonelik girişimlerini gözden geçirmesini ve kabul edip reddetmesini istiyorsanız seçin. Seçili değilse abonelik denemeleri otomatik olarak onaylanmıştır.
    Abonelik sayısı limiti İsteğe bağlı olarak birden çok eşzamanlı aboneliğin sayısını sınırlayın.
    Yasal koşullar Abonelerin ürünü kullanmak için kabul etmek zorunda olduğu ürün kullanım koşullarını ekleyebilirsiniz.
    API'ler Bir veya daha fazla API seçin. Ürünü oluşturduktan sonra API'ler de ekleyebilirsiniz. Daha fazla bilgi için bu makalenin devamında bir ürüne API ekleme bölümüne bakın.

    Ürün açıksa (abonelik gerektirmez), yalnızca başka bir açık ürünle ilişkili olmayan bir API ekleyebilirsiniz.

  4. Yeni ürününüzü oluşturmak için Oluştur'u seçin.

Dikkat

Abonelik gerektirmeyen bir ürünü yapılandırırken dikkatli olun. Bu yapılandırma fazla izin verebilir ve ürünün API'lerini belirli API güvenlik tehditlerine karşı daha savunmasız hale getirebilir.

Daha fazla yapılandırma ekleme

Ürünü kaydettikten sonra yapılandırmaya devam edin. API Management örneğinizde Ürünler penceresinden ürünü seçin. Ekle veya güncelleştir:

Öğe Açıklama
Ayarlar Ürün meta verileri ve durumu
API'ler Ürünle ilişkili API'ler
İlkeler Ürün API'lerine uygulanan ilkeler
Erişim denetimi Geliştiriciler veya konuklar için ürün görünürlüğü
Abonelikler Ürün aboneleri

Ürüne API ekleme

Ürünler bir veya daha fazla API arasındaki ilişkilendirmelerdir. Birçok API ekleyebilir ve bunları geliştirici portalı aracılığıyla geliştiricilere sunabilirsiniz. Ürün oluşturma sırasında bir veya daha fazla mevcut API ekleyebilirsiniz. Daha sonra Ürünler Ayarlar sayfasından veya API oluştururken ürüne API'ler de ekleyebilirsiniz.

Mevcut bir ürüne API ekleme

  1. API Management örneğinizin sol gezinti bölmesinde Ürünler'i seçin.
  2. Bir ürün seçin ve ardından API'ler'i seçin.
  3. + API Ekle'yi seçin.
  4. Bir veya daha fazla API'yi ve ardından Seç'i seçin.

Mevcut bir ürüne API ekleme

Ürün API'lerine erişim

Bir ürünü yayımladıktan sonra geliştiriciler API'lere erişebilir. Ürünün nasıl yapılandırıldığına bağlı olarak, ürüne erişim için abone olmaları gerekebilir.

  • Korumalı ürün - Geliştiricilerin ürünün API'lerine erişmek için önce korumalı bir ürüne abone olması gerekir. Abone olduklarında, bu üründeki herhangi bir API'ye erişebilen bir abonelik anahtarı alır. API Management örneğini oluşturduysanız zaten bir yöneticisinizdir, bu nedenle varsayılan olarak her ürüne abone olursunuz. Daha fazla bilgi için bkz . Azure API Management'ta abonelikler.

    İstemci geçerli bir ürün abonelik anahtarına sahip bir API isteğinde bulunursa, API Management isteği işler ve ürün bağlamında erişime izin verir. Ürün için yapılandırılan ilkeler ve erişim denetimi kuralları uygulanabilir.

    İpucu

    Rest API veya PowerShell komutu aracılığıyla özel abonelik anahtarlarıyla bir kullanıcının aboneliğini oluşturabilir veya bir ürüne güncelleştirebilirsiniz.

  • Açık ürün - Geliştiriciler açık bir ürünün API'lerine abonelik anahtarı olmadan erişebilir. Ancak, OAuth 2.0, istemci sertifikaları ve çağıran IP adreslerini kısıtlama gibi API'lere istemci erişiminin güvenliğini sağlamak için başka mekanizmalar yapılandırabilirsiniz.

    Not

    Geliştiricilerin öğrenmesi veya abone olması için açık ürünler geliştirici portalında listelenmez. Bunlar yalnızca Yönetici istrators grubu tarafından görülebilir. Geliştiricileri abonelik anahtarı olmadan erişilebilen API'ler hakkında bilgilendirmek için başka bir mekanizma kullanmanız gerekir.

    İstemci abonelik anahtarı olmadan BIR API isteğinde bulunursa:

    • API Management, API'nin açık bir ürünle ilişkili olup olmadığını denetler. Bir API en fazla bir açık ürünle ilişkilendirilebilir.

    • Açık ürün varsa, isteği bu açık ürün bağlamında işler. Açık ürün için yapılandırılan ilkeler ve erişim denetimi kuralları uygulanabilir.

Daha fazla bilgi için bkz . API Management abonelik anahtarlarıyla veya abonelik anahtarları olmadan istekleri nasıl işler?

Sonraki adımlar

Bu öğreticide, şunların nasıl yapıldığını öğrendiniz:

  • Ürün oluşturma ve yayımlama
  • Ürüne API ekleme
  • Ürün API'lerine erişme

Sonraki öğreticiye ilerleyin:

Boş bir API ve sahte API yanıtları oluşturma