Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Sosyal yayınlama özelliklerine sahip geliştirici portalları, geliştirici topluluğuyla iletişim kurmak için giderek daha fazla kullanılıyor. API belgeleri ve kullanım şartları gibi statik içeriğin yanı sıra blog ve forum gibi topluluğun katkıda bulunduğu dinamik içerikleri iletme de buna dahildir.
API sağlayıcısı olarak API'lerinizi açığa çıkarmanın, geliştiricileri API'leriniz hakkında eğitmenin, geliştiricilere kaydolmanın ve geliştiricilerin uygulamaları kaydettirmesine izin vermenin bir yolunu bulmanız 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 sağlaması, destek ve özellik isteğinde bulunması 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, tüm bu hizmetleri geliştirme topluluğunuza sunmak amacıyla kendi özelleştirilmiş web sitenizi oluşturmak ve kullanıma sunmak için kullanabileceğiniz bir Geliştirici Hizmetleri portalı sağlar. Her Edge müşterisi, bulutta veya şirket içinde kendi geliştirici portalını oluşturabilir.
Aşağıdaki videoda Apigee Geliştirici Hizmetleri portalı tanıtılmaktadır.
Aşağıdaki şekilde, varsayılan geliştirici portalının ana sayfası gösterilmektedir:
Geliştirici portalı, temelde 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şturmanızı ve yönetmenizi kolaylaştıran modüller halinde bir dizi temel özellik sunar.
Geliştirici portalı kullanıma hazır API belgeleri oluşturmanızı sağlar, blog oluşturmayı destekler ve mesaj dizili forumlar sunar. Ayrıca geliştirici portalını belirli gereksinimlerinizi karşılayacak şekilde özelleştirebilirsiniz. Özelleştirme, portalın görünümünü ve geliştiricilerin portalla etkileşimde bulunma şeklini değiştirmenize olanak tanır.
En fazla ö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:
Yönetim; geliştiricilerin portala erişim isteğinde bulunma süreci, geliştiricilerin API'lerinize erişen uygulamaları nasıl kaydettiği, API'lerinizle ilgili belirli rolleri ve izinleri nasıl atadığınızı ve geliştiricilerin API'lere erişiminin ne zaman iptal edileceğini kontrol eder.
Para kazanma özelliğini yapılandırmak ve kontrol etmek için de geliştirici portalını kullanırsınız. Para kazanma özelliği sayesinde geliştiriciler, geliştirici portalı üzerinden Faturalandırma ve Raporlar, Kataloglar ve Planlar ile para kazanmaya özel ayarlara self servis şekilde erişebilirler.
Portal kullanıcılarının türleri
Aşağıdaki resimde iki tür portal kullanıcısı gösterilmektedir:
- Geliştiriciler, API'lerinizi kullanarak uygulama oluşturan kullanıcı topluluğunu oluşturur. Uygulama geliştiriciler, portalı kullanarak SmartDokümanlar aracılığıyla API'leriniz hakkında bilgi edinebilir, portalda hesap kaydedebilir, API'lerinizi kullanan uygulamaları kaydedebilir, geliştirici topluluğuyla etkileşimde bulunabilir ve uygulama kullanımlarıyla ilgili istatistiksel bilgileri bir kontrol panelinde görüntüleyebilirler.
-
API ekibi, portal içeriği oluşturan, API'lerini uygulama geliştiricilerin kullanımına sunan, API belgeleri sağlayan ve geliştiricilerin uygulamaları kaydedip API anahtarları alması için bir mekanizma sağlayan API sağlayıcısıdır. API ekibi, geliştirici portalının temel yapılandırmasını şu amaçlarla gerçekleştirir:
- API anahtarları için otomatik veya manuel istekleri yapılandırma
- API belgelerini, forumları ve blogları tutma ve isteğe bağlı olarak tüm değişiklikleri düzeltme
- Kullanıcı yorumlarını ve forum denetimini ele alın
- Portaldaki özelliklere erişimi kontrol etmek için Rol Tabanlı Erişim Denetimi'ni (RBAC) zorunlu kılın. Örneğin, bir yönetici, kayıtlı bir kullanıcının forum yayınları oluşturmasına veya test konsollarını kullanmasına izin veren kontrolleri etkinleştirebilir.
- Kullanıcı oluşturma işlemi ve onaylar için hem yöneticilere hem de geliştiricilere gönderilen e-posta bildirimlerini özelleştirin
- "Bize ulaşın" sayfaları gibi web formlarını özelleştirin
Bu şekilde, üçüncü bir portal kullanıcısı türü olan API ürün yöneticisi gösterilmez. API ürün yöneticisi, aşağıdakiler de dahil olmak üzere API ekibinin portalı nasıl derlediğini tanımlamaktan sorumludur:
- API'lerin ürünlere nasıl paketleneceğini tanımlama
- Uygulama onayında kullanılacak 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ış sayfasını inceleyin.
Geliştirici portalını özelleştirme
API sağlayıcısı olarak, geliştirici portalını API'lerinize en uygun şekilde nasıl özelleştireceğinizi ve geliştirici topluluğunuzun API'lerinizi kullanabilmesi için gerekli bilgileri nasıl sağlayacağınızı düşünün. Özel portalınız için dikkat edilmesi gereken noktalardan bazıları şunlardır:
- API'lerinize kolay erişim
- "Nasıl Yapılır?" kılavuzları ve referans belgeleri gibi belgeler
- Bloglar ve tartışma forumları gibi topluluğun katkıda bulunduğu içerikler
- Örnek kod
- Yeni geliştiricilerin, uygulamaların ve API'lerin hızla onaylanabileceği kolay bir kayıt işlemi
- Yönetilen haklar ve kimlik bilgileri
- Katmanlı erişim denetimi
- Kuruluşunuza uygun bir görünüm ve tarz
Portal, önceden tanımlanmış temel bir yapılandırmaya sahiptir. Örneğin, portal zahmetsizce herkesin geliştirici olarak kaydolmasına izin verecek şekilde yapılandırılmıştır ancak geliştiricinin portala giriş yapabilmesi için her kaydı yöneticinin onaylaması gerekir. Kayıt onayından sonra geliştirici, API anahtarı istemek için bir uygulamayı kaydedebilir ve API kaynaklarına erişmek için portalı kullanabilir.
Varsayılan kayıt işlemindeki adımlar şu şekildedir:
- Geliştirici, geliştirici portalı üzerinden kaydolur. Buna yanıt olarak portal, hesabı onaylamaları için yöneticilere 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 uygulamayı 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 istekte bulunurken API anahtarını iletir.
Bu kullanıma hazır deneyim büyük ölçüde özelleştirilebilir. Örneğin, varsayılan kayıt ve yetkilendirme şemasını geçersiz kılarak yeni bir geliştiricinin kayıttan sonra otomatik olarak onaylanmasını ve giriş yapmasını sağlayabilirsiniz. Alternatif olarak, geliştiricinin ilk kez giriş yapabilmesi için bir dizi şart ve koşulu kabul etmesini zorunlu kılabilirsiniz.
Ayrıca, geliştirici portalındaki içerikler üzerinde tam kontrole sahip olursunuz. Geliştirici portalında kullanıma hazır API belgeleri, blog yayınları ve forum tartışmaları gibi örnek içerikler sunulur. 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 konusuna 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ı, Captcha'da yerleşik olarak sunulanlar ve otomatik veya manuel onay dahil 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 Geliştirici Portalı kullanıcı arayüzü üzerinden bir yönetici tarafından onaylanması gerekir. Yöneticiler, geliştiricileri doğrudan portalda da oluşturabilir. Daha sonra portal, geliştiriciye kendisi için bir hesap oluşturulduğunu otomatik olarak e-postayla bildirir.
- Geliştirici hesabını değiştirme Örneğin, yöneticiler kullanıcının hesap durumunu etkin yerine engellendi olarak değiştirebilir veya geliştiricinin profil bilgilerini (ör. şirketin adı) değiştirebilir.
- Bir geliştiriciyi kaldırma. Yöneticiler bir geliştiricinin hesabını devre dışı bırakabilir veya silebilir.
- Rol ve izin atama: Yöneticiler bir geliştirici hesabına belirli bir rol 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 bir özeti bulunmaktadır:
| Öne Çıkarın | Ayrıntılar |
|---|---|
| Tarayıcı desteği |
Desteklenen yazılımlar ve desteklenen sürümler bölümüne bakı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 |
|