Uygulama kaydını yapılandırma

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

Geliştiriciler uygulamaları kaydetmek için Geliştirici Hizmetleri portalındaki Uygulamalarım sayfasını kullanır. Geliştiriciler Uygulamalarım sayfasına portalın ana menüsünden erişir:

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

Ardından portalda varsayılan uygulama kaydı formu görüntülenir:

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

API sağlayıcısı olarak uygulama kayıt işlemi ü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 veya otomatik olarak onaylanıp onaylanmadığı
• Uygulamayı kaydetmek için Uygulama Ekle sayfasında başka bilgilerin gerekip gerekmediğini

Bu konuda, portalınız için uygulama kayıt işlemini nasıl yapılandıracağınız açıklanmaktadır. Ancak bu bölümde API ürünlerinin nasıl oluşturulacağı açıklanmamaktadır. Daha fazla bilgi için:

• API ürünleri oluşturma
• API'leri Yayınlamak için Edge Management API'yi Kullanma

Portalı, geliştiricilerin, geliştiriciye atanan role göre 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 varsayılan tek bir uygulama oluşturmak amacıyla portalı yapılandırabilirsiniz. Ardından, muhtemelen ücret yapısına veya geliştiricinin diğer özelliklerine dayanarak yalnızca bazı geliştiricilerin yeni uygulamalar eklemesine izin verirsiniz. Hangi geliştiricilerin uygulama oluşturabileceğini, silebileceğini ve düzenleyebileceğini kontrol etmek için rolleri ve izinleri kullanın. Daha fazla bilgi için Kullanıcı hesapları ekleme ve yönetme sayfasına göz atın.

Portalda bulunan API ürünlerini belirtme

Bir geliştirici portala eriştiğinde kullanılabilen API ürünlerini iki şekilde belirtebilirsiniz:

• API ürünü oluştururken erişim düzeyini belirtme
• Bir API ürününe erişimi rollere göre kısıtlama

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

Bir API ürünü oluşturduğunuzda ü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 edinmek için Erişim düzeyi bölümünü inceleyin.

Bir API ürününe erişimi rollere göre kısıtlama

API Ürün Rolü Erişimi Drupal modülünü etkinleştirerek, her bir 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. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Geliştirici portalı rollerini ve kullanıcı atamalarını inceleyin:
   • Drupal yönetim menüsünde Kişiler > İzinler > Roller'i seçin ve geliştirici rollerini ve izinlerini gerektiği şekilde ekleyin veya düzenleyin.
   • Drupal yönetim menüsünde Kişiler'i seçin ve kullanıcı ile rol atamalarını gerektiği gibi 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. Save configuration'ı (Yapılandırmayı kaydet) tıklayın.

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

Yeni bir uygulama kaydetmek için geliştirici, Uygulamalarım sayfasındaki Yeni uygulama ekle düğmesini seçerek 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 atanmış varsayılan bir ürün belirtebilirsiniz.

Bir uygulamayı kaydederken API ürün seçimini kontrol etmek için portalda aşağıdaki yapılandırma seçenekleri mevcuttur:

• Uygulamaları hiçbir API Ürünü ile ilişkilendirmeyin.
• Tüm uygulamaları bir veya daha fazla Varsayılan API Ürünüyle ilişkilendirin (aşağıda yapılandırılmıştır). Geliştiriciler uygulamaya başka bir API ürünü ekleyemez.
• Tek bir API ürününün seçilmesine izin ver, ancak bunu zorunlu kılma.
• Tek bir API ürünü seçilmesini gerektirir.
• Birden fazla API Ürünü seçilmesine izin ver, ancak hiçbirini gerektirme.
• Birden fazla API Ürünü seçilmesine izin verin ve en az bir tane ürün gerektirin.

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çebildiğinde onay kutuları görüntülenir. Geliştirici yalnızca tek bir API ürünü seçebildiğinde ise radyo düğmeleri gösterilir.

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

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak 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üyle ilişkilendir (aşağıda yapılandırılmış)" seçeneğini belirlerseniz Varsayılan API Ürünü altında bir varsayılan ürün ayarlayın.
6. API Ürün Widget'ı bölümünde, geliştiricilerin API ürünlerini seçmek için kullandığı HTML öğesini seçin.
7. Yapılandırmayı kaydedin.

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

API ürününüzdeki bir API proxy'si "üç aşamalı OAuth" (yetkilendirme kodu atama türü) kullanıyorsa geliştiricilerin uygulamalarını kaydederken bir geri çağırma URL'si belirtmeleri gerekir. Geri çağırma URL'si genellikle istemci uygulaması adına yetkilendirme kodu almak üzere atanmış bir uygulamanın URL'sini belirtir. Ayrıca, bu URL dizesi doğrulama için de kullanılır. İstemcinin, yetkilendirme kodu ve erişim jetonları isterken bu URL'yi Apigee Edge'e göndermesi ve redirect_uri parametresinin kayıtlı olanla eşleşmesi gerekir. Daha fazla bilgi için Yetkilendirme kodu izin türünü uygulama bölümüne bakın.

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

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak 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ı alanını genişletin.
4. Geri Arama URL'si İş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ğil veya gösterilmiyor.
5. Yapılandırmayı kaydedin.

Uygulama kullanımıyla ilgili analizler gösteriliyor

Portal, uygulama kullanımıyla ilgili analiz bilgileri gösterebilir. Analiz gösterimi etkinse uygulama geliştiriciler, her bir uygulama için Uygulamalarım sayfasında analizleri görebilir. Örneğin, bir geliştirici 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. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak 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ı alanını genişletin.
4. Geliştirici Uygulama analizi sekmesini göster onay kutusunu seçin.
5. Analiz verilerinin sorgulanacağı ortam için Test veya Üretim'i seçin. Herkese açık bir portal için genellikle Üretim seçeneğini kullanırsınız.
6. Yapılandırmayı kaydedin.

Bir uygulamanın portalında analizleri 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örüntülenecek analiz türünü ve tarih aralığını seçin:
4. Seçilen bilgiler şu şekilde görünür:
   

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

Bir geliştirici bir uygulamaya API ürünü ekleyip uygulamayı kaydettirdiğinde, portal tekrar geliştiriciye söz konusu uygulamanın API anahtarını döndürür. Ardından geliştirici, bu API anahtarını kullanarak uygulamayla ilişkilendirilmiş API ürünü tarafından paketlenen API proxy'lerine erişir.

API ürününü oluşturduğunuzda her API ürünü için anahtar onay sürecini kontrol edersiniz:

Onay süreci şöyle olabilir:

• Otomatik - Geliştirici uygulamayı kaydettirdiğinde, portal tarafından API ürünü için onaylanmış bir API anahtarı döndürülür. Daha sonra otomatik olarak onaylanan bir anahtarı iptal edebilirsiniz.
• Manuel: Geliştirici uygulamayı kaydettirdiğinde portal tarafından bir API anahtarı döndürülür. Ancak anahtar, manuel anahtar onayı kullanan hiçbir API ürünü için etkinleştirilmez. API ürününe geliştirici tarafından erişilebilmesi için API anahtarının Edge yönetim kullanıcı arayüzünde veya API'de bir yönetici tarafından manuel olarak onaylanması gerekir. Daha sonra manuel olarak onaylanan bir anahtarı iptal edebilirsiniz.

Daha fazla bilgi için API ürünleri oluşturma bölümüne bakın.

Portalınız bir geliştiricinin bir uygulamaya birden fazla API ürünü eklemesine izin veriyorsa geliştirici, bazı ürünleri Otomatik anahtar onayıyla, bazılarını da Manuel olarak ekleyebilir. Geliştirici, manuel onay gerektiren ürünler için son onayı beklerken, otomatik olarak onaylanan tüm API ürünleri için döndürülen API anahtarını hemen kullanabilir.

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

Bu örnekte, Premium Weather API ürünü, Manuel onay kullanmaktadır ve anahtarın yönetici tarafından onaylanmasını beklemektedir. Ücretsiz API Ürünü, Otomatik onay kullanmaktadır ve anahtarın erişim için kullanımı onaylanmıştır.

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

1. Edge yönetim kullanıcı arayüzüne, kuruluşunuz için yönetim ayrıcalıklarına sahip bir kullanıcı olarak 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. Bekleyen anahtar istekleri olan uygulamaların listesini görmek için Beklemede 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'in altında:
   • Anahtarı onaylamak için manuel onay gerektiren her API ürünü için Onayla düğmesini seçin.
     

     

   • Onaylanan bir anahtarı iptal etmek için erişimi iptal etmek üzere bir API ürünü için işlemler altında İptal et düğmesini seçin.
     

     

8. Uygulamayı kaydedin. API anahtarı onaylandı.

API ürün ve uygulama önbelleğe almayı kontrol etme

API ürünleri ve geliştirici uygulamalarıyla ilgili bilgiler, Apigee Edge'deki portaldan uzaktan depolanır. Bu, API ürünleri ve uygulamalarında yapılan değişikliklerin, portaldan gitmeden Edge kullanıcı arayüzünden veya API'den yapılabileceği anlamına gelir. Örneğin, bir arka uç yöneticisi yeni bir API ürünü eklediğinde portal bu bilgilerle hemen güncellenmez.

Portalın Edge arka ucuyla senkronize durumda kalmasını sağlamak için portal önbelleği güncellemesini manuel olarak tetikleyebilir, 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 çalışacak şekilde yapılandırırsanız API ürünlerini ve geliştirici uygulaması önbelleklerini sık sık güncellemenin ek yükünü istemeyebilirsiniz. Bu durumda, önbellek güncellemesini manuel olarak tetikleyebilirsiniz. Ancak cron işi saatte bir veya iki saatte bir çalışırsa önbellekleri güncellemek için gereken sürenin fazla bir etkisi olmayabilir.

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

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

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak 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ı önbelleklerini 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. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. Drupal menüsünden Ana sayfa simgesi > Tüm önbellekleri temizle'yi seçin.

Uygulamayı kaydetmek için kullanılan form alanlarını özelleştirme

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

Bir API sağlayıcısı olarak bu formu değiştirerek geliştiriciden müşteri kimliği, uygulamanın hedef platformu veya diğer bilgileri gibi ek bilgiler sağlamasını 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ı gibi farklı HTML öğeleri tarafından görüntülenir
• Formda, Geri Çağırma URL'si alanı ile Ürün alanı arasındaki herhangi bir yerde görünecek şekilde ayarlanabilir.

Ö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 otomatik olarak Edge'e yüklenir. Yani bu alanları Edge'de görüntüleyebilir veya değiştirebilir ya da bu alanlara bir komut dosyasından erişmek için Edge Management API'yi 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 alanının altında, alanın dahili adına karşılık gelen bir adla görüntülenir:

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

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, uygulama oluşturma formlarının yönetici arayüzü kullanılarak nasıl yapılandırılacağı açıklanmaktadır. Bir Drupal geliştiricisi, özel kancalar kullanarak "Uygulamalarım" sayfasını değiştirmek de dahil olmak üzere ek özelleştirmeler yapabilir. Davranışların kod aracılığıyla nasıl değiştirildiği hakkında daha fazla bilgi edinmek için dosyadaki uygulama API örneklerini inceleyin: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Uygulama kayıt formuna alan eklemek için:

1. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak giriş yapın.
2. DevConnect Uygulama Özellik Yönetimi modülünün etkin olduğundan 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
   • Description = Müşteri kimliğinizi girin.
   • Bu özelliği zorunlu kıl onay kutusunu işaretleyin.
   • Bu özelliği görüntüle 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 formda görünmeden önce tarayıcınızın önbelleğini temizlemeniz gerekebilir.

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

• Dahili Ad = Purpose_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 kutusundaki işareti kaldırın
• Bu özelliği görüntüle 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. Portalınıza yönetici veya içerik oluşturma ayrıcalıklarına sahip bir kullanıcı olarak 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.