Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Sosyal yayınlama özelliklerine sahip geliştirici portalları, geliştirici topluluğuyla iletişim kurmak için giderek daha fazla kullanılıyor. Buna API dokümanları ve kullanım şartları gibi statik içeriklerin yanı sıra bloglar ve forumlar gibi topluluk tarafından oluşturulan dinamik içerikler de dahildir.
API sağlayıcısı olarak API'lerinizi kullanıma sunmanız, geliştiricilere API'leriniz hakkında bilgi vermeniz, geliştiricileri kaydetmeniz ve geliştiricilerin uygulama kaydettirmesine izin vermeniz gerekir. API'lerinizi geliştiricilere sunmak, gerçekten dinamik bir topluluk oluşturmanın yalnızca bir parçasıdır. Ayrıca geliştirici topluluğunuzun geri bildirim vermesi, destek ve özellik istekleri göndermesi ve diğer geliştiricilerin erişebileceği kendi içeriklerini göndermesi için bir yönteme ihtiyacınız vardır.
Apigee Edge, geliştirme topluluğunuza bu hizmetlerin tümünü sunmak için kendi özelleştirilmiş web sitenizi oluşturup yayınlamak üzere kullanabileceğiniz bir Developer Services portalı sağlar. Her Edge müşterisi, bulutta veya şirket içinde kendi geliştirici portalını oluşturabilir.
Aşağıdaki videoda Apigee Developer Services portalı tanıtılmaktadır.
Aşağıdaki resimde varsayılan geliştirici portalının ana sayfası gösterilmektedir:
Geliştirici portalı, temel olarak açık kaynak Drupal (http://www.drupal.org) projesine dayalı bir içerik yönetim sistemidir (İYS). Drupal, web siteleri için içerik oluşturmayı ve yönetmeyi kolaylaştıran modül biçiminde temel bir özellik grubu sağlar.
Geliştirici portalı, API belgeleri oluşturmanıza olanak tanır, blog yayınlarını destekler ve konularına ayrılmış forumlar sunar. Geliştirici portalını kendi ihtiyaçlarınıza göre özelleştirebilirsiniz. Özelleştirme, portalın görünümünü ve geliştiricilerin portalla etkileşim şeklini değiştirmenize olanak tanır.
Çoğu özelleştirmeyi yapmak için Drupal menüsünü kullanırsınız. Portala yönetici ayrıcalıklarına sahip bir kullanıcı olarak giriş yaparsanız her portal sayfasının üst kısmında Drupal menüsü görünür:
Geliştiricilerin portala erişim isteğinde bulunduğu süreci, geliştiricilerin API'lerinize erişen uygulamaları nasıl kaydettiğini, geliştiricilere API'lerinizle ilgili belirli rolleri ve izinleri nasıl atadığınızı ve geliştiricilerin API'lere erişimini ne zaman iptal edeceğinizi yönetim kontrol eder.
Geliştirici portalını, para kazanma özelliğini yapılandırmak ve kontrol etmek için de kullanırsınız. Para kazanma, geliştiricilere geliştirici portalı üzerinden Faturalandırma ve Raporlar, Katalog ve Planlar'a ve para kazanmaya özel ayarlara self servis erişim sağlar.
Portal kullanıcısı türleri
Aşağıdaki resimde iki tür portal kullanıcısı gösterilmektedir:
- Geliştiriciler, API'lerinizi kullanarak uygulama geliştiren kullanıcı topluluğunu oluşturur. Uygulama geliştiriciler, SmartDocs üzerinden API'leriniz hakkında bilgi edinmek, portalda hesap kaydetmek, API'lerinizi kullanan uygulamaları kaydetmek, geliştirici topluluğuyla etkileşime geçmek ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri kontrol panelinde görüntülemek için portalı kullanır.
-
API ekibi, portal içeriği oluşturan, API'lerini uygulama geliştiricilerine sunan, API belgeleri sağlayan ve geliştiricilerin uygulama kaydettirmesi ve API anahtarları alması için bir mekanizma sunan API sağlayıcısıdır. API ekibi, geliştirici portalının temel yapılandırmasını aşağıdaki amaçlarla gerçekleştirir:
- API anahtarları için otomatik veya manuel istekleri yapılandırma
- API belgelerini, forumları ve blogları yönetme ve isteğe bağlı olarak tüm değişiklikleri düzeltme
- Kullanıcı yorumlarını ve forum moderasyonunu yönetme
- Portaldaki özelliklere erişimi kontrol etmek için rol tabanlı erişim denetimini (RBAC) uygulayın. Örneğin, bir yönetici, kayıtlı bir kullanıcının forum yayını oluşturmasına veya test konsollarını kullanmasına izin vermek için denetimleri etkinleştirebilir.
- Kullanıcı oluşturma ve onaylar için hem yöneticilere hem de geliştiricilere gönderilecek e-posta bildirimlerini özelleştirme
- "Bize ulaşın" sayfaları gibi web formlarını özelleştirme
Bu şekilde üçüncü bir portal kullanıcısı türü gösterilmemiştir: API ürün yöneticisi. API ürün yöneticisi, API ekibinin portalı nasıl oluşturacağını belirlemekten sorumludur. Bu kapsamda:
- API'lerin ürünlere nasıl paketleneceğini tanımlama
- Uygulama onayı için kuralları tanımlama
- Portalda para kazanma özelliği etkinse API ürünlerinin fiyatlandırma ve faturalandırma planlarını tanımlama Para kazanma hakkında daha fazla bilgi için Para kazanmaya genel bakış başlıklı makaleyi inceleyin.
Geliştirici portalını özelleştirme
API sağlayıcısı olarak, geliştirici portalını API'lerinize en uygun şekilde özelleştirmeyi ve geliştirici topluluğunuzun API'lerinizi kullanması için gerekli bilgileri sağlamayı düşünün. Özel portalınız için dikkate almanız gereken bazı noktalar şunlardır:
- API'lerinize kolay erişim
- "Nasıl yapılır?" kılavuzları ve referans dokümanları gibi dokümanlar
- Bloglar ve tartışma forumları gibi topluluk tarafından oluşturulan içerikler
- Örnek kod
- Yeni geliştiricilerin, uygulamaların ve API'lerin hızlı bir şekilde onaylanabileceği kolay bir kayıt süreci
- Yönetilen haklar ve kimlik bilgileri
- Katmanlı erişim denetimi
- Kuruluşunuzla uyumlu bir görünüm ve üslup
Portal, temel bir yapılandırmayla önceden tanımlanmış olarak gelir. Örneğin, portal varsayılan olarak herkesin geliştirici olarak kaydolmasına izin verecek şekilde yapılandırılmıştır ancak geliştiricinin portala giriş yapabilmesi için bir yöneticinin her kaydı onaylaması gerekir. Kayıt onaylandıktan sonra geliştirici, API anahtarı istemek için bir uygulama kaydedebilir ve API kaynaklarına erişmek için portalı kullanabilir.
Varsayılan kayıt sürecindeki adımlar şunlardır:
- Geliştirici, geliştirici portalı üzerinden kayıt yapar. Portal, yanıt olarak yöneticilerin hesabı onaylamasını isteyen bir e-posta gönderir.
- Bir yönetici hesabı onaylar ve geliştiriciye artık giriş yapabileceğini bildiren bir e-posta gönderilir.
- Geliştirici bir uygulama kaydeder ve uygulama tarafından kullanılan API ürünlerini seçer. Buna karşılık, portal uygulamaya benzersiz bir API anahtarı atar.
- Geliştirici, API'nize istek gönderirken API anahtarını iletir.
Bu ilk kullanım deneyimi son derece özelleştirilebilir. Örneğin, yeni bir geliştiricinin kayıttan sonra otomatik olarak onaylanıp oturum açması için varsayılan kayıt ve yetkilendirme şemasını geçersiz kılabilirsiniz. Alternatif olarak, geliştiricinin ilk kez giriş yapabilmesi için bir dizi hüküm ve koşulu kabul etmesini zorunlu kılabilirsiniz.
Ayrıca, geliştirici portalında bulunan içerikler üzerinde tam kontrole sahip olursunuz. Geliştirici portalı, API dokümanları, blog yayınları ve forum tartışmaları gibi örnek içerikler sunar. Kendi içeriğinizi sağlayabilir ve her içerik türünün görünümünü özelleştirebilirsiniz.
Daha fazla bilgi için Görünümü özelleştirme bölümüne bakın.
Geliştirici portalını yönetme
Geliştiriciler, API'nize erişmek ve API'nizi kullanmak için geliştirici portalınızı kullanır. Yöneticiler aşağıdakiler gibi hesap yönetimi görevlerini gerçekleştirir:
- Kayıt alanları, yerleşik Captcha ve otomatik ya da manuel onay dahil olmak üzere geliştirici kayıt sürecini özelleştirme
- Geliştirici ekleme veya onaylama. Varsayılan olarak tüm geliştiriciler geliştirici portalı üzerinden kaydolabilir ancak Dev Portal kullanıcı arayüzü üzerinden bir yönetici tarafından onaylanmaları gerekir. Yöneticiler, geliştiricileri doğrudan portalda da oluşturabilir. Portal, geliştiriciye otomatik olarak bir hesap oluşturulduğunu belirten bir e-posta gönderir.
- Geliştiricinin hesabını değiştirme Örneğin, yöneticiler kullanıcının hesap durumunu etkin olandan engellendi olarak değiştirebilir veya geliştiricinin profil bilgilerini (ör. şirketin adı) değiştirebilir.
- Geliştiriciyi kaldırma Yöneticiler, geliştiricilerin hesaplarını devre dışı bırakabilir veya silebilir.
- Rol ve izin atama: Yöneticiler, geliştirici hesaplarına belirli roller atayabilir. Rol, kitap veya başka içerik oluşturma izni gibi çeşitli izinlerle ilişkilendirilir. Ayrıca, bir rolle ilişkili izinleri değiştirebilir veya yeni roller oluşturabilirsiniz.
Daha fazla bilgi için Kullanıcı hesapları ekleme ve yönetme başlıklı makaleyi inceleyin.
Geliştirici portalı özelliklerinin özeti
Aşağıdaki tabloda geliştirici portalı özelliklerinin özeti yer almaktadır:
| Özellik | Ayrıntılar |
|---|---|
| Tarayıcı desteği |
Desteklenen yazılımlar ve desteklenen sürümler bölümüne göz atın. |
|
Kullanıcı kaydı |
|
|
Kullanıcı yönetimi |
|
|
Portal görünümü |
|
|
İçerik ve topluluk yönetimi |
|
|
İzinler |
|
|
API anahtarı yönetimi |
|
|
E-posta |
|
|
Bloglar |
|
|
Forumlar |
|
|
Belgeler |
|
|
Menüler |
|
|
Arama |
|
|
Bağlantı Kontrol Edici |
|