Uygulama kaydını yapılandırma

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

Geliştiriciler, uygulama kaydettirmek için Developer Services portalındaki Uygulamalarım sayfasını kullanır. Geliştiriciler, portalın ana menüsünden Uygulamalarım sayfasına erişir:

Geliştirici, yeni bir uygulama kaydetmek için Uygulamalarım sayfasındaki Yeni uygulama ekle düğmesini seçer.

Ardından portalda varsayılan uygulama kayıt formu gösterilir:

Varsayılan olarak geliştiricinin yalnızca uygulama adını, geri çağırma URL'sini ve uygulamaya eklenecek API ürünlerinin listesini belirtmesi gerekir.

API sağlayıcı olarak uygulama kaydı süreci üzerinde tam kontrole sahip olursunuz. Örneğin, şunları yapılandırabilirsiniz:

  • Portalda bulunan API ürünlerinin listesi
  • Varsayılan API ürünü olup olmadığı
  • Geri çağırma URL'sinin gerekli olup olmadığı
  • API anahtarının bir API ürünü için manuel olarak mı yoksa otomatik olarak mı onaylandığı
  • Uygulamayı kaydettirmek için Uygulama Ekle sayfasında başka bilgi gerekip gerekmediği

Bu konuda, portalınız için uygulama kaydı sürecinin nasıl yapılandırılacağı açıklanmaktadır. Ancak bu konu, API ürünlerinin nasıl oluşturulacağı hakkında bilgi vermez. Daha fazla bilgi için:

Portalı, geliştiricilere atanan role göre geliştiricilerin uygulama oluşturmasını, silmesini veya düzenlemesini engelleyecek şekilde yapılandırabilirsiniz. Örneğin, geliştirici kaydolduğunda tüm geliştiriciler için tek bir varsayılan uygulama oluşturacak şekilde portalı yapılandırabilirsiniz. Ardından, ücret yapısına veya geliştiricinin diğer özelliklerine bağlı olarak yalnızca bazı geliştiricilerin yeni uygulama eklemesine izin verebilirsiniz. Uygulama oluşturma, silme ve düzenleme işlemlerini kimlerin yapabileceğini kontrol etmek için rolleri ve izinleri kullanın. Daha fazla bilgi için Kullanıcı hesapları ekleme ve yönetme başlıklı makaleyi inceleyin.

Portalda kullanılabilen API ürünlerini belirtme

Bir geliştirici portala eriştiğinde kullanılabilen API ürünlerini belirtmenin iki yolu vardır:

API ürünü oluştururken erişim düzeyini belirtme

API ürünü oluştururken ürünün erişim düzeyi seçeneğini aşağıda gösterildiği gibi belirtirsiniz:

Erişim düzeyinin, Drupal 7 geliştirici portalındaki API ürününün kullanılabilirliğini nasıl etkilediği hakkında daha fazla bilgi için Erişim düzeyi bölümüne bakın.

API ürünlerine erişimi rollere göre kısıtlama

API Ürün Rol Erişimi Drupal modülünü etkinleştirerek her API ürününe erişebilecek rolleri belirtebilirsiniz.

Bir API ürününe erişimi geliştirici rollerine göre kısıtlamak için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Geliştirici portalı rollerini ve kullanıcı atamalarını inceleyin:
    • Drupal yönetim menüsünde Kullanıcılar > İzinler > Roller'i seçin ve geliştirici rollerini ve izinlerini gerektiği gibi ekleyin veya düzenleyin.
    • Drupal yönetim menüsünde Kullanıcılar'ı seçin ve gerektiğinde kullanıcı ile rol atamalarını düzenleyin.
  3. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı > API Ürün Rol Erişimi'ni seçin.
  4. Her API ürününe erişebilmesini istediğiniz rolleri seçin.
  5. Yapılandırmayı kaydet'i tıklayın.

Geliştiricilerin API ürünlerini bir uygulamayla nasıl ilişkilendireceğini yapılandırma

Geliştiriciler, yeni bir uygulama kaydettirmek için Uygulamalarım sayfasında Yeni uygulama ekle düğmesini tıklayarak Uygulama ekle formunu açar:

Portalı nasıl yapılandırdığınıza bağlı olarak geliştirici, uygulama kaydı sırasında uygulamayla ilişkilendirilecek bir veya daha fazla API ürünü seçebilir. Alternatif olarak, tüm uygulamalara atanan varsayılan bir ürün de belirtebilirsiniz.

Uygulama kaydederken API ürün seçimini kontrol etmek için portalda aşağıdaki yapılandırma seçenekleri kullanılabilir:

  • Uygulamaları herhangi bir API Ürünü ile ilişkilendirmeyin.
  • Tüm uygulamaları bir veya daha fazla Varsayılan API Ürünüyle (aşağıda yapılandırılmıştır) ilişkilendirin. Geliştiriciler uygulamaya başka API ürünü ekleyemez.
  • Tek bir API ürününün seçilmesine izin verin ancak bunu zorunlu kılmayın.
  • Tek bir API ürünü seçmeyi zorunlu kılın.
  • Birden fazla API ürünü seçmelerine izin verin ancak herhangi bir ürün seçmeyi zorunlu kılmayın.
  • Birden fazla API ürünü seçmelerine izin verin ve en az bir ürün seçmeyi zorunlu kılın.

Geliştiricinin API ürününü seçmek için kullandığı formda görünen HTML öğesini de kontrol edebilirsiniz. Seçenekler aşağıdakileri içerir:

  • Açılır listeler.
  • Onay kutuları veya radyo düğmeleri. Geliştirici birden fazla API ürünü seçebiliyorsa onay kutuları, geliştirici yalnızca tek bir API ürünü seçebiliyorsa radyo düğmeleri gösterilir.

API ürün seçimi seçeneğini ayarlamak için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı Ayarları > Uygulama Ayarları'nı seçin.
  3. Uygulama Ayarları sayfasında API Ürün ayarları alanını genişletin.
  4. API Ürün İşleme bölümünde, API ürün seçimini kontrol eden seçeneği belirleyin.
  5. "Tüm uygulamaları bir veya daha fazla Varsayılan API Ürünü ile ilişkilendir (aşağıda yapılandırılır)" seçeneğini belirlerseniz Varsayılan API Ürünü bölümünde bir varsayılan ürün ayarlayın.
  6. API Ürün Widget'ı bölümünde, API ürünlerini seçmek için geliştiriciler tarafından kullanılan HTML öğesini seçin.
  7. Yapılandırmayı kaydedin.

Geri çağırma URL'si işlemeyi yapılandırma

API ürününüzdeki bir API proxy'si "üç ayaklı OAuth" (yetkilendirme kodu verme türü) kullanıyorsa geliştiricilerin uygulamalarını kaydettiklerinde geri çağırma URL'si belirtmesi gerekir. Geri çağırma URL'si genellikle istemci uygulama adına yetkilendirme kodu almak üzere belirlenen bir uygulamanın URL'sini belirtir. Ayrıca bu URL dizesi, doğrulama için kullanılır. İstemcinin, yetkilendirme kodları ve erişim jetonları istediğinde bu URL'yi Apigee Edge'e göndermesi gerekir ve redirect_uri parametresi, kayıtlı parametreyle eşleşmelidir. Daha fazla bilgi için Yetkilendirme kodu izin türünü uygulama başlıklı makaleyi inceleyin.

API ürün seçimi için geri çağırma URL'sini kontrol etmek üzere:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı Ayarları > Uygulama Özellikleri'ni seçin.
  3. Uygulama Ayarları sayfasında Geri çağırma URL'si ayarları bölümünü genişletin.
  4. Geri çağırma URL'si işleme bölümünde aşağıdaki seçeneklerden birini belirleyin.
    • Geri çağırma URL'si tüm geliştirici uygulamaları için gereklidir.
    • Geri çağırma URL'si tüm geliştirici uygulamaları için isteğe bağlıdır.
    • Geri çağırma URL'si gerekli değildir ve gösterilmez.
  5. Yapılandırmayı kaydedin.

Uygulama kullanımıyla ilgili analizleri görüntüleme

Portal, uygulama kullanımıyla ilgili analitik bilgiler gösterebilir. Analizlerin görüntülenmesi etkinleştirildiyse uygulama geliştiriciler, her uygulamanın analizlerini Uygulamalarım sayfasında görebilir. Örneğin, geliştiriciler bir uygulama için aşağıdaki analizleri görüntüleyebilir:

  • İşleme hızı
  • Maksimum yanıt süresi
  • Minimum yanıt süresi
  • Mesaj sayısı
  • Hata sayısı

Portalda analizleri etkinleştirmek için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı > Uygulama Ayarları'nı seçin.
  3. Uygulama ayarları sayfasında Uygulama performansı ayarları bölümünü genişletin.
  4. Geliştirici uygulaması analizleri sekmesini göster onay kutusunu işaretleyin.
  5. Analytics verilerini sorgulamak için Ortam bölümünde Test veya Üretim'i seçin. Herkese açık bir portal için genellikle Üretim'i seçersiniz.
  6. Yapılandırmayı kaydedin.

Bir uygulamanın analizlerini portalda görüntülemek için:

  1. Uygulamalarım sayfasında uygulama adını seçin.
  2. Uygulamanın Analytics bağlantısını seçin.
  3. Gösterilecek analiz türünü ve tarih aralığını seçin:
  4. Seçilen bilgiler gösterilir:

Bir API ürünü için API anahtarını manuel olarak onama veya iptal etme

Bir geliştirici bir uygulamaya API ürünü ekleyip uygulamayı kaydettiğinde portal, geliştiriciye söz konusu uygulamanın API anahtarını döndürür. Geliştirici daha sonra uygulamayla ilişkili API ürünü tarafından paketlenen API proxy'lerine erişmek için bu API anahtarını kullanır.

API ürünü oluştururken her API ürünü için anahtar onay sürecini siz kontrol edersiniz:

Onay süreci şunlar olabilir:

  • Otomatik: Geliştirici uygulamayı kaydettiğinde API ürünü için portal tarafından onaylanmış bir API anahtarı döndürülür. Otomatik olarak onaylanmış bir anahtarı daha sonra iptal edebilirsiniz.
  • Manuel: Geliştirici uygulamayı kaydettiğinde portal tarafından bir API anahtarı döndürülür ancak anahtar, manuel anahtar onayı kullanan API ürünleri için etkinleştirilmez. Geliştiricinin API ürününe erişmek için API anahtarını kullanabilmesi için bir yöneticinin, API anahtarını Edge yönetim kullanıcı arayüzünde veya API'de manuel olarak onaylaması gerekir. Manuel olarak onaylanan anahtarları daha sonra iptal edebilirsiniz.

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

Portalınız geliştiricilerin bir uygulamaya birden fazla API ürünü eklemesine izin veriyorsa geliştirici bazı ürünleri otomatik anahtar onayı ile, bazılarını ise manuel olarak ekleyebilir. Geliştirici, manuel onay gerektiren ürünlerin nihai onayı için beklerken otomatik olarak onaylanan tüm API ürünleri için döndürülen API anahtarını hemen kullanabilir.

Bir geliştirici, bir uygulamaya ait API ürünlerinin listesini ve API ürünü için anahtar onayının durumunu görmek istediğinde Uygulamalarım sayfasında uygulamanın adını, ardından Ürünler bağlantısını seçer:

Bu örnekte Premium Weather API ürünü manuel onay kullanır ve bir yöneticinin anahtarı onaylamasını bekler. Ücretsiz API Ürünü otomatik onay kullanır ve anahtarın bu ürüne erişmek için kullanılması onaylanmıştır.

Bir anahtarı manuel olarak onaylamak veya iptal etmek için:

  1. Kuruluşunuzda yönetim ayrıcalıklarına sahip bir kullanıcı olarak Edge yönetim kullanıcı arayüzüne giriş yapın.
  2. Sağ üst köşedeki açılır kutuda API Platformu'nu seçin.
  3. Geliştirici uygulamalarının listesini açmak için Yayınla > Geliştirici uygulamaları'nı seçin.
  4. Beklemedeki anahtar istekleri olan uygulamaların listesini görmek için Beklemedeki düğmesini seçin:

  5. Onaylamak istediğiniz uygulama adını seçin.
  6. Uygulama ayrıntıları sayfasında, sağ üst köşedeki Düzenle düğmesini seçin.
  7. Uygulamanın API ürünleri listesinde, İşlemler bölümünde:
    • Anahtarı onaylamak için manuel onay gerektiren her API ürünü için Onayla düğmesini seçin.

    • Onaylanmış bir anahtarı iptal etmek için, erişimi iptal etmek üzere API ürünündeki İşlemler bölümünde İptal et düğmesini seçin.

  8. Uygulamayı kaydedin. API anahtarı artık onaylanmıştır.

API ürünü ve uygulama önbelleğe alma işlemlerini kontrol etme

API ürünleri ve geliştirici uygulamalarıyla ilgili bilgiler, Apigee Edge'deki portaldan uzaktan saklanır. Yani API ürünlerinde ve uygulamalarında portaldan geçmeden Edge kullanıcı arayüzünden veya API'den değişiklik yapılabilir. Örneğin, arka uç yöneticisi yeni bir API ürünü eklediğinde portal bu bilgilerle hemen güncellenmez.

Portalın Edge arka ucuyla senkronize kalmasını sağlamak için portal önbelleğini manuel olarak güncelleyebilir, portalın cron işi çalıştırıldığında önbellekleri otomatik olarak güncelleyebilir veya ikisini birden yapabilirsiniz. Örneğin, cron işini 5 veya 10 dakikada bir gibi sık bir şekilde çalışacak şekilde yapılandırırsanız API ürünlerini ve geliştirici uygulama önbelleğini bu kadar sık güncellemenin yükünü almak istemeyebilirsiniz. Bu durumda, önbelleği manuel olarak güncelleyebilirsiniz. Ancak cron işi her saat veya iki saatte bir çalışıyorsa önbellekleri güncellemek için gereken sürenin çok fazla etkisi olmayabilir.

Varsayılan olarak portal, cron her çalıştırıldığında API ürünü ve geliştirici uygulaması önbelleğini yeniden oluşturacak şekilde yapılandırılır.

API ürünü ve geliştirici uygulaması önbelleklerinin cron her çalıştırıldığında yeniden oluşturulup oluşturulmayacağını belirtmek için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal menüsünde Yapılandırma > Geliştirici Portalı Ayarları > Uygulama Ayarları'nı seçin.
  3. cron her çalıştırıldığında API ürünü ve geliştirici uygulaması önbelleğini yeniden oluştur seçeneğini işaretleyin veya bu seçeneğin işaretini kaldırın.
  4. Ayarlarınızı kaydedin.

Önbellekleri manuel olarak güncellemek için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal menüsünden Ana Sayfa simgesi > Tüm önbellekleri temizle'yi seçin.

Uygulama kaydettirmek için kullanılan form alanlarını özelleştirme

Geliştirici bir uygulama kaydettiğinde portalda varsayılan form gösterilir:

API sağlayıcı olarak, geliştiriciden müşteri kimliği, uygulamanın hedef platformu veya başka bilgiler gibi ek bilgiler sağlamasını istemek için bu formu değiştirmek isteyebilirsiniz. Portal, bu forma yeni alanlar eklemenize olanak tanır. Bu alanlar şunlar olabilir:

  • Zorunlu veya isteğe bağlı
  • Metin kutuları, radyo düğmeleri, onay kutuları ve daha fazlası gibi farklı HTML öğeleriyle gösterilir
  • Formda Geri Çağırma URL'si alanı ile Ürün alanı arasında herhangi bir yerde görünecek şekilde ayarlanabilir

Geliştirici portalında bulunan uygulama kaydı formunu nasıl özelleştireceğinizi öğrenmek için bu videoyu izleyin.

Örneğin, aşağıdaki formda müşteri kimliği için zorunlu bir alan ve hedef platform için isteğe bağlı bir alan gösterilmektedir:

Forma yeni alanlar eklediğinizde, geliştirici formu gönderdiğinde alan değerleri diğer tüm alanlarla birlikte Edge'e otomatik olarak yüklenir. Yani bu alanları Edge'de görüntüleyebilir veya değiştirebilir ya da bir komut dosyasından bu alanlara erişmek için Edge yönetim API'sini kullanabilirsiniz.

Örneğin, Yayınla > Geliştirici Uygulamaları'na gidip uygulama adını seçerek Edge yönetim kullanıcı arayüzünde yeni form alanlarını görüntüleyin. Yeni alan değerleri, sayfanın Özel Özellikler bölümünde, alanın dahili adına karşılık gelen bir adla görünür:

Alan değerleri, geliştiricinin Uygulamalarım sayfasında uygulamanın Ayrıntılar alanında da gösterilir:

Geliştirici, Uygulamalarım sayfasında uygulamanın Düzenle bağlantısını seçerek de değerleri düzenleyebilir.

Aşağıdaki prosedürlerde, yönetici arayüzünü kullanarak uygulama oluşturma formlarının nasıl yapılandırılacağı açıklanmaktadır. Drupal geliştiricileri, özel kancaları kullanarak "Uygulamalarım" sayfasını değiştirmek de dahil olmak üzere ek özelleştirmeler yapabilir. Kod aracılığıyla davranışları nasıl değiştireceğiniz hakkında daha fazla bilgi edinmek için /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php dosyasında bulunan uygulama API'si örneklerine bakın.

Uygulama kayıt formuna alan eklemek için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. DevConnect Uygulama Özelliği Yönetimi modülünün etkinleştirildiğinden emin olun.
  3. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı Ayarları > Geliştirici Portalı Uygulama Özellikleri'ni seçin.
  4. Sayfanın üst kısmındaki Dev Portal Uygulama Özelliği Ekle düğmesini seçin.
  5. Alanı yapılandırın. Örneğin, yukarıda gösterilen Müşteri Kimliği alanı için aşağıdaki ayarları kullanın:
    • Dahili Ad = cust_id. Bu, alan değerini depolamak için kullanılan değişkenin adıdır.
    • Herkese açık ad = Müşteri kimliği
    • Açıklama = Müşteri kimliğinizi girin.
    • Bu özelliği zorunlu tut onay kutusunu işaretleyin.
    • Bu özelliği göster onay kutusunu işaretleyin.
    • Widget = Metin Kutusu
    • Geliştirici Portalı Uygulama Özellikleri sayfasına dönmek için Kaydet'i seçin.
  6. Değişiklikleri kaydet'i seçin.
  7. Drupal menüsünden Ana Sayfa simgesi > Tüm önbellekleri temizle'yi seçin.
    Yeni alanın formda görünmesi için tarayıcınızın önbelleğini temizlemeniz gerekebilir.

Geliştiricinin uygulamanın platformunu belirtmesi için isteğe bağlı bir alan eklemek isterseniz alan özelliklerini şu şekilde ayarlayın:

  • Dahili Ad = intended_platforms
  • Herkese Açık Ad = Platformlar
  • Açıklama = Uygulamanız için bir veya daha fazla platform belirtin.
  • Bu özelliği zorunlu kıl onay kutusunun işaretini kaldırın.
  • Bu özelliği göster onay kutusunu işaretleyin.
  • Widget = Onay kutuları listesi
  • Geliştirici Portalı Uygulama Özellikleri sayfasına dönmek için Kaydet'i seçin.

Formdaki özellikleri yeniden sıralamak için:

  1. Yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak portalınıza giriş yapın.
  2. Drupal yönetim menüsünde Yapılandırma > Geliştirici Portalı Ayarları > Geliştirici Portalı Uygulama Özellikleri'ni seçin.
  3. Ad sütununun altındaki artı + simgesini seçin ve mülkü formda görüntülemek istediğiniz konuma sürükleyin.
  4. Değişikliklerinizi kaydedin.