Uygulamaları kaydedin ve API anahtarlarını yönetin

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

Uygulamaları kaydedin ve API anahtarlarını aşağıdaki bölümlerde açıklandığı şekilde yönetin.

Giriş

Uygulama kaydı, API'lerinize kimlerin erişebileceğini kontrol eden birincil mekanizmadır.

API sağlayıcısı olarak, API ürünlerini yönetme bölümünde açıklandığı gibi API'lerinizi paket haline getirecek bir veya daha fazla API ürünü oluşturursunuz. Bir uygulamayı kaydederken uygulama geliştirici hangi API ürünlerinin kullanılacağını seçer ve Edge, geliştiricinin bu API ürünlerine erişmek için kullanabileceği tek bir API anahtarı sağlar. Uygulama geliştiricisi, her çağrıdaki API anahtarını API ürünlerinde bulunan API proxy'lerine iletir. Dilediğiniz zaman bir uygulamanın API anahtarını iptal ederek uygulama geliştiricisinin söz konusu uygulama tarafından referans verilen API ürünlerinin tamamına veya alt kümesine erişmesini engelleyebilirsiniz.

Genellikle uygulama geliştiriciler, API ürünlerinizi kullanmak için geliştirici portalınızı kullanarak kaydolur. Portalınızı oluşturma ve API ürünlerinizi yayınlama adımları Portalınızı oluşturma bölümünde açıklanmıştır.

Alternatif olarak, bir API sağlayıcısı olarak uygulama kayıt işlemi üzerinde daha fazla kontrol sahibi olmak isteyebilir ve aşağıdaki bölümlerde açıklandığı gibi uygulamaları Edge'e kaydetmeyi seçebilirsiniz. Örneğin, portalınıza erişmeden dahili geliştirme ekipleriniz için veya bir geliştirici adına uygulama kaydetmek isteyebilirsiniz.

Aşağıdaki bölümlerde, UI ve API kullanılarak uygulamaların nasıl kaydedileceği ve API anahtarlarının nasıl yönetileceği açıklanmaktadır.

Uygulamalar sayfasını keşfetme

Aşağıda açıklandığı şekilde Uygulamalar sayfasına erişin ve sayfayı keşfedin.

Edge

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

  1. apigee.com/edge adresinde oturum açın.
  2. Sol gezinme çubuğunda Yayınla > Uygulamalar'ı seçin.

Uygulamalar sayfası görüntülenir.

Şekilde vurgulandığı gibi Uygulamalar sayfasında şunları yapabilirsiniz:

Klasik Edge (Private Cloud)

Klasik Edge kullanıcı arayüzünü kullanarak Uygulamalar 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. Üst gezinme çubuğunda Yayınla > Geliştirici Uygulamaları'nı seçin.

Geliştirici Uygulamaları sayfası görüntülenir.

Uygulama kaydetme

Bir uygulama, aşağıdaki yöntemlerden biri kullanılarak kaydedilebilir:

  • Uygulama geliştiriciler, Uygulama geliştiricileri portalınızla nasıl etkileşimde bulunur? bölümünde açıklandığı gibi uygulamayı portalınız aracılığıyla kaydedebilir.
  • Bir uygulamayı aşağıda açıklandığı gibi Edge'e kaydedebilirsiniz. Uygulama geliştiriciye anahtarın nasıl sağlanacağını belirlemek size kalmıştır.

Kayıtlı uygulamalar şuraya eklenir:

Edge'de bir uygulamayı kaydetmek için:

  1. Uygulamalar sayfasına erişin.
  2. + Uygulama'yı tıklayın.
  3. Uygulama Ayrıntıları'nı belirtin:
    Alan Açıklama Zorunlu mu?
    Ad Uygulamanın adı. Uygulama oluşturulduktan sonra adı değiştiremezsiniz. Bu ad, Management API çağrılarında kullanılır. Evet
    Görünen Ad Uygulamanın Edge yönetim kullanıcı arayüzünde ve geliştirici portalında görünen adı. Hayır
    Şirket/Geliştirici

    Not: ApigeeHybrid, şirket uygulamalarını desteklemez. Bu alan geçerli değildir.

    Şirket veya Geliştirici'yi seçin ve açılır menüden bir şirket veya geliştirici adı seçin.
    Not: Performans nedeniyle, tüm şirketler veya geliştiriciler açılır menüde gösterilmez. Arama kutusuna şirket adını, geliştirici adını veya e-posta adresini yazmaya başlayın. Uygulama geliştiricilerini kaydetme başlıklı makaleyi de inceleyin.

    Evet
    Geri Çağırma URL'si Genellikle, istemci uygulaması adına yetkilendirme kodu almak üzere atanmış bir uygulamanın URL'sini belirtir. Bu değer tüm API ürünleri için gerekli değildir. Hayır
    Notlar Uygulama için açıklayıcı notlar. Hayır
  4. API anahtarının geçerlilik süresi ve durumu ile ilişkili API ürünleri de dahil olmak üzere Kimlik Bilgileri'ni belirtin.
    Kimlik bilgileri bölümünde simgesini tıklayın ve aşağıdaki bilgileri girin:
    Alan Açıklama
    Geçerlilik süresi Bir son kullanma süresi veya tarihi yapılandırın ya da API anahtarını asla sona ermeyecek şekilde ayarlayın ve Tamam'ı tıklayın.
    Ürünler Bir veya daha fazla API ürününü API anahtarıyla ilişkilendirin:
    1. Ürün ekle'yi tıklayın.
    2. Listeden bir veya daha fazla API ürünü seçin.
    3. Ekle'yi tıklayın.
    4. Her bir API ürünü için Durum'u Onaylandı veya İptal edildi olarak ayarlayın.
    5. Daha fazla API ürünü eklemek için adımları tekrarlayın.
  5. Özel Özellikleri belirtin:
    1. Özel Özellikler bölümünde simgesini tıklayın.
    2. Adı ve değeri girin.
    3. Ekle veya Başka bir tane ekle ve başlat'ı tıklayın.
      Ekleyebileceğiniz maksimum özel özellik sayısı 18'dir.
  6. Create'i (Oluştur) tıklayın.

Uygulamayla ilişkilendirdiğiniz API ürünlerinin API anahtarları için manuel olarak onaylanması gerekiyorsa bunları API anahtarlarını onaylama veya iptal etme bölümünde açıklandığı gibi onaylayın.

Bir geliştirici için kayıtlı uygulamaları görüntüleme

Belirli bir geliştirici için kaydedilmiş uygulamaları görüntülemek için aşağıdaki yöntemlerden birini kullanın:

Bir uygulamayı görüntüleme ve düzenleme

Bir uygulamayı görüntülemek ve düzenlemek için:

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
    Uygulama ayrıntıları görüntülenir.
  3. Bir uygulamayı düzenlemek için Düzenle'yi tıklayın.
  4. Aşağıdaki görevlerden birini veya daha fazlasını gerçekleştirin:
  5. Kaydet'i tıklayın.

Kimlik bilgilerini yönetme

Bir uygulamayı düzenlerken, uygulamanın kimlik bilgilerini aşağıdaki resimde gösterildiği gibi Kimlik Bilgileri bölümünden yönetebilirsiniz:

Önceki şekilde vurgulandığı gibi, Kimlik Bilgileri bölümünde kullanıcı arayüzünü kullanarak aşağıdaki görevleri gerçekleştirebilirsiniz:

Kimlik bilgilerini yönetmek üzere API'yi kullanmak için aşağıdaki bölümlere bakın:

API anahtarını ve gizli anahtarını görüntüleme

Bir API anahtarını ve gizli anahtarını görüntülemek için:

  1. Uygulamalar sayfasına erişin.
  2. API anahtarını ve gizli anahtarını görüntülemek istediğiniz uygulamanın satırını tıklayın.
  3. Kimlik bilgileri bölümünde, görüntülemek istediğiniz API anahtarı veya gizli anahtarla ilişkilendirilmiş Göster seçeneğini tıklayın.

API anahtarını onaylama veya iptal etme

API proxy'lerine yapılan API çağrıları genellikle bir API anahtarı gerektirir. Edge, yalnızca API anahtarı onaylanmış, geçerli ve API'yi içeren API ürünü tarafından tanımlanan koşulları karşılıyorsa çağrılara izin verir.

Bir API ürününü, API anahtarlarının otomatik olarak onaylanması için API ürünlerini yönetme bölümünde yapılandırabilirsiniz. Bununla birlikte, API ürünü için API anahtarlarının manuel olarak onaylanması gerekiyorsa anahtarı manuel olarak onaylamanız gerekir.

Bir API ürününü tümü veya tek bir API ürünü için iptal edebilirsiniz. Bu durumda, API anahtarı ve gizli anahtarı geçersizdir ve ilişkili API ürünlerindeki API'lere erişmek için kullanılamaz. Bir API anahtarını istediğiniz zaman yeniden onaylayabilirsiniz.

Bir API anahtarını onaylamak veya iptal etmek için:

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
  3. Düzenle'yi tıklayın.
  4. Aşağıdaki görevlerden birini gerçekleştirin:
    • Bir API anahtarıyla ilişkilendirilmiş tüm API ürünleri için API anahtarını onaylamak veya iptal etmek üzere API anahtarıyla ilişkili Onaylandı veya İptal edildi'yi seçin.
    • Belirli bir API ürünü için API anahtarını onaylamak veya iptal etmek üzere API ürününün Durum sütununda Onaylandı veya İptal edildi'yi seçin.
  5. Kaydet'i tıklayın.

Bir uygulamadaki API ürünlerini yönetme

Aşağıdaki görevleri gerçekleştirerek uygulamanızdaki API ürünlerini yönetin:

Bir uygulamaya API ürünü ekleme

Bir uygulamaya API ürünü eklemek için:

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
  3. Düzenle'yi tıklayın.
  4. Aşağıdaki görevlerden birini gerçekleştirin:
    • Yeni bir API anahtarına bir API ürünü eklemek için simgesini tıklayarak yeni bir kimlik bilgisi oluşturun, bir deneme seçin ve API ürününü API anahtarına ekleyin.
    • Mevcut bir API anahtarına API ürünü eklemek için Kimlik Bilgisi bölümünde Ürün ekle'yi tıklayın ve açılır listeden API ürününü seçin.
  5. Kaydet'i tıklayın.

Bir API ürününü bir uygulamadan kaldırma

Bir API anahtarını etkin tutmak ancak bir API ürünü tarafından kullanılmasına izin vermek istemiyorsanız ilgili kimlik bilgilerinden kaldırabilirsiniz.

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
  3. Düzenle'yi tıklayın.
  4. API ürününün yanındaki simgesini tıklayın.
  5. Kaydet'i tıklayın.

Kaldırılan bir ürünü yeniden ekleyebilirsiniz.

Yeni kimlik bilgileri oluşturuluyor

Bir uygulama için yeni kimlik bilgileri oluşturabilirsiniz. Örneğin, API anahtarı rotasyonu kullanıyorsanız son kullanımları sona erdiğinde rotasyon dışında olacak anahtarlarla çakışan yeni anahtarlar oluşturabilirsiniz. Ayrıca, orijinal anahtarın/gizlinin güvenliği ihlal edilirse yeni bir anahtar/gizli anahtar da oluşturabilirsiniz. Yeni bir anahtar oluşturursanız mevcut API anahtarları, süreleri dolana veya siz bunları açıkça iptal edene kadar çalışmaya devam eder.

Yeni bir API anahtarı oluşturmak için:

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
  3. Düzenle'yi tıklayın.
  4. Kimlik bilgileri bölümünde simgesini tıklayın.
  5. Son kullanma tarihini belirtin, API ürünlerini ekleyin ve durumlarını ayarlayın.
  6. İsteğe bağlı olarak, diğer API anahtarlarından istediklerinizi gerektiği şekilde revoke.
  7. Kaydet'i tıklayın.

Bir uygulamayı onaylama veya iptal etme

Bir uygulamayı aşağıda açıklandığı şekilde onaylayabilir veya iptal edebilirsiniz. Bir uygulamayı iptal ettiğinizde, onaylanmış API anahtarları artık Edge'e yapılan API çağrılarında kullanılamaz. Bir uygulamayı yeniden onayladığınızda, onaylanmış ve geçerli tüm API anahtarları API çağrıları yapmak için kullanılabilir.

Uygulama başka kuruluşlarda kayıtlıysa bu kuruluşların her birinde uygulamayı iptal etmeniz gerekir. Değişikliklerin tüm ileti işleyicileri tarafından tanınması birkaç dakika sürebilir.

Bir uygulamayı onaylamak veya iptal etmek için:

  1. Uygulamalar sayfasına erişin.
  2. Görüntülemek ve düzenlemek istediğiniz uygulamanın satırını tıklayın.
  3. Düzenle'yi tıklayın.
  4. Uygulamayı onaylamak veya iptal etmek için sırasıyla Uygulama Durumu alanında Onayla'yı veya İptal Et'i seçin.
  5. Kaydet'i tıklayın.

Uygulama silme

Bir uygulamayı sildiğinizde, uygulamalarla ilişkili tüm istemci anahtarları geçersiz hale gelir. Bir istekte geçersiz anahtar kullanılması, isteğin başarısız olmasına neden olur.

İleride bir geliştirici uygulamasını yeniden etkinleştirmek isteyebileceğinizi düşünüyorsanız silme işlemine alternatif olarak uygulamayı iptal edebilirsiniz.

Bir uygulamayı silmek için:

  1. Uygulamalar sayfasına erişin.
  2. İmleci, silmek istediğiniz uygulamanın satırına getirin.
  3. İşlemler sütununda simgesini tıklayın.

Not: Public Cloud için Apigee Edge ile geliştirici uygulaması ve ilişkili yapıların silinmesi eşzamansız olarak gerçekleştirilir. Geliştirici uygulaması hemen silinir ancak söz konusu geliştirici uygulamasıyla ilişkili kaynakların (ör. uygulama anahtarları veya erişim jetonları) otomatik olarak silinmesi birkaç saniye ile birkaç dakika arasında sürebilir.

API'yi kullanarak uygulamaları kaydetme ve API anahtarlarını yönetme

API'yi kullanarak uygulamaları kaydetmek ve yönetmek için Geliştirici uygulamalarını kaydetme konusuna bakın. Ayrıca, API referans dokümanlarında bulunan aşağıdaki bölümlere de bakın:

Mevcut tüketici anahtarlarını ve gizli anahtarları içe aktarma bölümüne de göz atın.