Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Apigee Edge, API'lerinize erişimi belgeleyip yönetmek ve uygulama geliştirici topluluğunuzu teşvik etmek için kullanımı kolay, entegre bir portal sunar.
Tüm Apigee Edge kullanıcıları, kendi geliştirici portallarını hızlı bir şekilde oluşturmalarını sağlayan ve Drupal tabanlı portal geliştirmeye bir alternatif sağlayan entegre portal geliştirme araçlarına erişime sahiptir. Özellik karşılaştırması için Geliştirici portalı özelliklerinin karşılaştırması bölümüne bakın.
Entegre portalınızı oluşturma ve yayınlamaya giriş niteliğindeki bu kısa videoyu izleyin.
Temel özellikler ve avantajlar
Entegre portal aşağıdaki temel özellikleri ve avantajları sunar:| Öne Çıkarın | Avantajları |
|---|---|
| Portal içeriği geliştirme | Portal içeriğinizi hızlı ve kolay bir şekilde geliştirin.
|
| Portal görünümü ve tarzı | SCSS stil sayfalarını ve kişiselleştirilmiş marka bilinci oluşturma öğelerini kullanarak portalınızın görünümünü ve tarzını tamamen özelleştirin. |
| API belgeleri | OpenAPI spesifikasyonlarınıza göre API referans belgelerini otomatik olarak oluşturun. |
| Self servis kaydı | Geliştiricilerin API'lerinizi kullanarak uygulama derlemesi için self servis kayıt sağlayın. |
| Kitle yönetimi | Portal içeriğine ve API'lere kimlerin erişebileceğini kontrol edin |
| Analizler | Google Analytics'i ve özel analiz izlemeyi yapılandırın. |
| Gelişmiş özelleştirmeler | Aşağıdakiler dahil olmak üzere gelişmiş portal özelleştirmeleri gerçekleştirin:
|
Portalınızı oluşturmaya başlayın
Apigee, entegre portalda güvenliği nasıl ele alıyor?
Aşağıdaki tabloda, Apigee'nin entegre portaldaki yerleşik özelliklerle güvenliği nasıl ele aldığı açıklanmaktadır.
| Öne Çıkarın | Adresler |
|---|---|
| HTTPS ve aktarım katmanı güvenliği (TLS) kullanılmasını gerektirir | Şifreli iletişimi zorunlu kılar |
Genel Son Ek Listesi ile apigee.io alan kaydını içerir
|
"Süper çerezlerin" apigee.io alt alan adlarında ayarlanmasına izin vermez
|
| İçerik güvenliği politikası (İGP) yapılandırmasını destekler | Siteler arası komut dosyası çalıştırma (XSS) ve diğer kod yerleştirme saldırılarına karşı koruma sağlar |
Gerekenler:
|
HTML, SQL veya arka uç yerleştirme saldırılarına karşı koruma sağlar |
x-content-type-options: nosniff XSS başlığı içeriyor
|
Tarayıcıların MIME türlerini tahmin etmeye çalışmasını engeller |
x-frame-options: deny XSS başlığı içeriyor
|
Portal içeriğinin iFrame'e yerleştirilmesine izin vermez |
x-xss-protection: 1 XSS başlığı içeriyor
|
Yansıtılmış siteler arası komut dosyası (XSS) saldırıları algılandığında sayfaların yüklenmesine izin vermez |
| CSRF jetonları kullanıyor | Siteler arası istek sahtekarlığına karşı koruma |
Şu özellikleri kullanır:
|
Müşteri verilerinin korumaları |
Entegre portalın Edge ile nasıl iletişim kurduğu
Geliştirici portalı tarafından kullanılan bilgilerin çoğu Apigee Edge'de saklanır. Portal, Edge için bir istemci işlevi görür. Gerektiğinde geliştirici portalı, Edge'den bilgi almak veya Edge'e bilgi göndermek için HTTP veya HTTPS REST isteği gönderir. Örneğin, bir portal kullanıcısı portala yeni bir uygulama kaydettiğinde portal, uygulama hakkındaki bilgilerin depolanması için Edge'e bir istek gönderir.
Aşağıdaki bölümlerde daha ayrıntılı bilgi verilmektedir.
Uygulama kaydının ve API anahtarlarının depolandığı yer
Bir portal kullanıcısı entegre portalda uygulama kayıt işlemini tamamladığında portal, uygulama hakkında, uygulama adı ve uygulamayla ilişkili API ürünleri de dahil olmak üzere uygulamayla ilgili bilgileri Apigee Edge'e gönderir. Edge, uygulamayı başarıyla kaydederse Edge, portala tek bir API anahtarı döndürür. Portal kullanıcısı, uygulamayla ilişkilendirilmiş API ürünlerine erişmek için bu API anahtarını kullanır.
Uygulamalar ve API anahtarlarıyla ilgili bilgiler yalnızca Edge'de saklanır, portalda saklanmaz. Portal kullanıcısı, örneğin Uygulamalarım sayfası aracılığıyla bir uygulamayla ilgili bilgileri görüntülemek için portalı kullandığında portal, bilgilere erişmek için API anahtarıyla Edge'e istek gönderir.
Benzer şekilde, bir portal kullanıcısı uygulama eklediğinde, kaldırdığında veya değiştirdiğinde portal değişiklikleri kaydedilmesi için Edge'e gönderir.
Uygulamalar ve API anahtarlarıyla ilgili tüm bilgiler Edge'de saklandığından, bir Edge yöneticisi Edge kullanıcı arayüzünü veya yönetim API'sini kullanarak bu bilgileri değiştirebilir. Örneğin, bir yönetici:
- Geliştirici uygulaması ekleme, kaldırma veya değiştirme
- Bir geliştirici uygulaması için API anahtarını onaylama veya iptal etme
Daha fazla bilgi için Uygulamaları kaydetme ve API anahtarlarını yönetme konusuna bakın.
Uygulama geliştirici hesap bilgilerinin depolandığı yer
Geliştirici hesabı bilgileri aşağıdaki şekilde Edge'de depolanır:
- Yerleşik kimlik sağlayıcı kullanılarak, bir portal kullanıcısı hesap oluşturduğunda bilgiler kimlik sağlayıcıda depolanır ve Kullanıcılar sayfasında gösterilir.
- SAML kimlik sağlayıcı kullanılarak, bir portal kullanıcısı portalda oturum açtığında, bilgilerin gölge kaydı kimlik sağlayıcıda depolanır ve Kullanıcılar sayfasında gösterilir.
- Portal kullanıcısı bir geliştirici uygulaması kaydettirdikten sonra, kullanıcı hesabı bilgileri Edge ile senkronize edilir ve Geliştiriciler sayfasındaki Edge'de kullanılabilir.
Aşağıdaki kullanıcı hesabı bilgileri Edge'de saklanır:
- Ad ve soyadı
- E-posta adresi
- Kullanıcı adı
- Portal hesap durumu (etkin veya etkin değil)
- Portal rolü (kimliği doğrulanmış kullanıcı, yönetici, diğer)
- Rol tabanlı izinler
- Portal kullanıcısının üyesi olduğu ekipler (ekipler özelliğinin beta sürümüne kaydolduysanız)
E-posta adresi, geliştiriciyi tanımlamak için Edge tarafından kullanılan birincil anahtardır ve her biri benzersiz olmalıdır. Edge, birincil anahtardan geliştiricinin ait olduğu her kuruluş için benzersiz bir geliştirici kimliği oluşturur.
Daha fazla bilgi için Uygulama geliştiricilerini kaydetme konusuna bakın.
Geliştirici ekibi bilgilerinin depolandığı yer (beta)
Portalda bir geliştirici ekibi oluşturulduğunda geliştirici ekibi aşağıdaki gibi bilgiler Edge'de saklanır:
- Geliştirici ekibinin adı ve açıklaması
- Geliştirici ekibi üyeleri ve rolleri
- Geliştirici ekibinin atandığı uygulamalar
- Geliştirici ekibine atanan kitleler
- Geliştirici ekibinin oluşturulduğu zaman
Geliştirici ekibi için otomatik olarak oluşturulan benzersiz bir e-posta adresi oluşturulur ve Edge tarafından geliştirici ekibini tanımlamak için kullanılan birincil anahtar görevi görür.
Daha fazla bilgi için Geliştirici ekiplerini kullanarak bir uygulamanın sorumluluğunu paylaşma (beta) ve Geliştirici ekiplerini yönetme başlıklı makaleleri inceleyin.
Örnek portal hakkında
Yeni bir portal oluşturduğunuzda başlangıç sayfası olarak kullanabileceğiniz bir dizi başlangıç sayfası sağlanır. Başlangıç sayfaları, metin ve resimleri benzersiz içeriğinizle değiştirirken kendi portalı geliştirme sürecinize ilham verecek demo içeriği içerir. Örnek portal temasında materyal tasarım teması ve SCSS kullanılmaktadır.
Aşağıda, örnek portalın ana sayfası gösterilmektedir.
Örnek portalla sağlanan başlangıç sayfaları şunlardır:
| Sayfa | Açıklama |
|---|---|
| Ana Sayfa | Sunulan API'leri açıklayan portal ana sayfası. Portalınız (index.html) için varsayılan ana sayfa olarak hizmet verir. Açısal malzeme bileşenleri ekleme bölümünde açıklandığı gibi açısal malzeme bileşenlerinin kullanımını gösterir. |
| Hızlı Başlangıç Kılavuzu | Portalın nasıl özelleştirileceğini gösteren hızlı başlangıç adımları grubu. Başlayın sayfasına içerik eklemek için örnek portalda Hızlı Başlangıç seçeneğini tıklayın. |
| Başlayın | Örnek içerik sayfası. Bu sayfayı nasıl düzenleyeceğinizi ve üst gezinme menüsüne nasıl ekleyeceğinizi öğrenmek için örnek portaldaki Başlarken sayfasına bakın. |
| API'ler | Kullanılabilir API'lerin listesi. Etkileşimli API referans belgeleri oluşturduğunuzda, içerik bağlantıları bu sayfaya otomatik olarak eklenir. Not: Bu sayfanın içeriği, portalınızda yayınladığınız API'lere göre otomatik olarak oluşturulur. Sayfa listesinde görünmediğinden, bu sayfanın içeriğini doğrudan düzenleyemezsiniz. Portalı teması düzenleyiciyi kullanarak sayfanın stilini değiştirebilirsiniz. |
| Uygulamalarım | Yetkili bir kullanıcının kayıtlı uygulamalarının listesi. Portal kullanıcılarının portalınızla nasıl etkileşimde bulunduğu başlıklı makaleyi inceleyin. Not: Bu sayfanın içeriği, kayıtlı kullanıcı uygulamalarına göre otomatik olarak oluşturulur. Sayfanın içeriğini doğrudan düzenleyemezsiniz; sayfa listesinde görünmez. Tema düzenleyiciyi kullanarak sayfanın stilini değiştirebilirsiniz. |
| Oturum aç | Kayıtlı kullanıcılar için oturum açma sayfası. Yeni kullanıcılar Oturum Aç'ı tıklayarak bu sayfadan kaydolabilir. Portal kullanıcılarının portalınızla nasıl etkileşimde bulunduğu başlıklı makaleyi inceleyin. Not: Oturum Açma sayfası, portalınıza otomatik olarak eklenir. Oturum Açma sayfasında logoyu özelleştirebilir ve Hesap Oluştur sayfasına özel kayıt alanları ekleyebilirsiniz. Sayfanın içeriğini doğrudan düzenleyemezsiniz; sayfa listesinde görünmez. |
| Hükümler ve Koşullar | Örnek şartlar ve koşullar sayfası. |
Tarayıcı desteği
Apigee entegre portalları Apigee Edge ile aynı tarayıcı sürümlerini destekler.