Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. info
Apigee Edge, API'lerinize erişimi belgelemek ve yönetmek, ayrıca uygulama geliştirici topluluğunuzu desteklemek için kullanımı kolay, entegre bir portal sunar.
Apigee Edge'in tüm kullanıcıları, kendi geliştirici portallarını hızlı bir şekilde oluşturmalarını sağlayan entegre portal geliştirme araçlarına erişebilir. Bu araçlar, Drupal tabanlı portal geliştirme için alternatif bir seçenek sunar. Özellikleri karşılaştırmak için Geliştirici portalı özelliklerinin karşılaştırması başlıklı makaleyi inceleyin.
Entegre portalınızı oluşturma ve yayınlama hakkında bilgi edinmek için bu kısa videoyu izleyin.
Temel özellikler ve avantajlar
Entegre portal size aşağıdaki temel özellikleri ve avantajları sunar:| Özellik | Avantajları |
|---|---|
| Portal içeriği geliştirme | Portal içeriğinizi hızlı ve kolay bir şekilde geliştirin.
|
| Portalın görünümü ve tarzı | SCSS stil sayfalarını ve kişiselleştirilmiş markalama öğ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 dokümanlarını otomatik olarak oluşturun. |
| Self servis kayıt | Geliştiricilerin API'lerinizi kullanarak uygulama oluşturması için self servis kayıt hizmeti sunun. |
| Kitle yönetimi | Portal içeriğine ve API'lere kimlerin erişebileceğini kontrol etme |
| Analiz | Google Analytics ve özel analiz izlemeyi yapılandırın. |
| Gelişmiş özelleştirmeler | Aşağıdakiler dahil olmak üzere gelişmiş portal özelleştirmeleri yapın:
|
Portalınızı oluşturmaya başlayın
Apigee, entegre portalda güvenliği nasıl ele alır?
Aşağıdaki tabloda, Apigee'nin entegre portaldaki yerleşik özellikler aracılığıyla güvenliği nasıl ele aldığı açıklanmaktadır.
| Özellik | Adresler |
|---|---|
| HTTPS ve taşıma katmanı güvenliği (TLS) gerektirir | Şifrelenmiş iletişimi zorunlu kılar |
Herkese Açık Son Ek Listesi ile apigee.io alan kaydı içerir
|
"Süper çerezlerin" apigee.io alt alan adlarında ayarlanmasını engeller
|
| İç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 |
Gerekli:
|
HTML, SQL veya arka uç ekleme saldırılarına karşı koruma sağlar |
x-content-type-options: nosniff XSS başlığı içerir
|
Tarayıcıların MIME türlerini tahmin etmesine izin vermez |
x-frame-options: deny XSS başlığı içerir
|
Portal içeriğinin iFrame'e yerleştirilmesine izin vermez. |
x-xss-protection: 1 XSS başlığı içerir
|
Yansıtılan siteler arası komut dosyası çalıştırma (XSS) saldırıları algıladığında sayfaların yüklenmesine izin vermez |
| CSRF jetonları kullanılır | Siteler arası istek sahtekarlığına karşı koruma sağlar |
Avantajlar:
|
Müşteri verilerini koruma |
Entegre portal, Edge ile nasıl iletişim kurar?
Geliştirici portalının kullandığı bilgilerin çoğu Apigee Edge'de depolanır. Portal, Edge için istemci görevi görür. Geliştirici portalı, gerektiğinde Edge'den bilgi almak veya Edge'e bilgi göndermek için bir HTTP veya HTTPS REST isteği gönderir. Örneğin, bir portal kullanıcısı portala yeni bir uygulama kaydettiğinde portal, uygulamayla ilgili bilgileri depolamak için Edge'e bir istek gönderir.
Aşağıdaki bölümlerde daha ayrıntılı bilgi verilmektedir.
Uygulama kaydı ve API anahtarları nerede depolanır?
Bir portal kullanıcısı, entegre portalda uygulama kaydı sürecini tamamladığında portal, 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 kaydettiğinde portala tek bir API anahtarı döndürür. Portal kullanıcısı, uygulamayla ilişkili API ürünlerine erişmek için bu API anahtarını kullanır.
Uygulamalar ve API anahtarları hakkındaki bilgiler yalnızca Edge'de depolanır, portalda depolanmaz. Bir portal kullanıcısı, örneğin Uygulamalarım sayfası üzerinden 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 Edge'e göndererek saklar.
Uygulamalar ve API anahtarlarıyla ilgili tüm bilgiler Edge'de depolandığından Edge yöneticisi, Edge kullanıcı arayüzünü veya yönetim API'sini kullanarak bilgileri değiştirebilir. Örneğin, yöneticiler:
- Geliştirici uygulaması ekleme, kaldırma veya değiştirme
- Geliştirici uygulaması için API anahtarını onaylama veya iptal etme
Daha fazla bilgi için Uygulama kaydetme ve API anahtarlarını yönetme başlıklı makaleyi inceleyin.
Uygulama geliştirici hesabı bilgilerinin saklandığı yer
Geliştirici hesabı bilgileri Edge'de aşağıdaki şekilde saklanı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ısı 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ı geliştirici uygulaması kaydettikten sonra kullanıcı hesabı bilgileri senkronize edilir ve Edge'deki Geliştiriciler sayfasında kullanılabilir.
Edge'de aşağıdaki kullanıcı hesabı bilgileri saklanır:
- Ad ve soyadı
- E-posta adresi
- Kullanıcı adı
- Portal hesap durumu (etkin veya etkin değil)
- Portal rolü (kimlik 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, Edge'in geliştiriciyi tanımlamak için kullandığı 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ştiricileri kaydetme başlıklı makaleyi inceleyin.
Geliştirici ekibi bilgilerinin depolandığı yer (beta)
Portal kullanıcısı tarafından portalda bir geliştirici ekibi oluşturulduğunda geliştirici ekibi bilgileri Edge'de depolanır. Bu bilgiler şunlardı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 benzersiz, otomatik olarak oluşturulan bir e-posta adresi oluşturulur ve Edge'in geliştirici ekibini tanımlamak için kullandığı birincil anahtar olarak kullanılı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ıç noktası olarak kullanabileceğiniz bir dizi başlangıç sayfası sağlanır. Başlangıç sayfaları, metinleri ve resimleri benzersiz içeriğinizle değiştirirken kendi portalınızı geliştirmenize ilham verecek demo içerikler içerir. Örnek portal temasında materyal tasarım temaları ve SCSS kullanılmaktadır.
Aşağıda örnek portalın ana sayfası gösterilmektedir.
Örnek portalda sağlanan başlangıç sayfaları şunlardır:
| Sayfa | Açıklama |
|---|---|
| Ana Sayfa | Sergilenen API'leri açıklayan portal ana sayfası. Portalınızın varsayılan ana sayfası olarak kullanılır (index.html). Angular materyal bileşenleri ekleme bölümünde açıklandığı gibi angular materyal bileşenlerinin kullanımını gösterir. |
| Hızlı Başlangıç | Portalın nasıl özelleştirileceğini gösteren hızlı başlangıç adımları grubu. Başlayın sayfasına içerik ekleme adımlarını uygulamak için örnek portalda Hızlı Başlangıç'ı 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şlayın sayfasına bakın. |
| API'ler | Kullanılabilir API'lerin listesi. Etkileşimli API referans dokümanı oluşturduğunuzda içeriğin 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. Bu sayfanın içeriğini doğrudan düzenleyemezsiniz. Sayfa, sayfa listesinde görünmez. Portal tema düzenleyicisini kullanarak sayfanın stilini değiştirebilirsiniz. |
| Uygulamalarım | Yetkili bir kullanıcı için kayıtlı uygulamaların listesi. Portal kullanıcıları portalınızla nasıl etkileşimde bulunur? 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, 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ğunu inceleyin. Not: Oturum açma sayfası, portalınıza otomatik olarak eklenir. Oturum açma sayfasındaki logoyu özelleştirebilir ve Hesap Oluştur sayfasına özel kayıt alanları ekleyebilirsiniz. Sayfanın içeriğini doğrudan düzenleyemezsiniz. Sayfa, sayfa listesinde görünmez. |
| Hükümler ve Koşullar | Örnek hükümler ve koşullar sayfası. |
Tarayıcı desteği
Apigee entegre portalları, Apigee Edge ile aynı tarayıcı sürümlerini destekler.