Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi
Apigee Edge, API'lerinize erişimi belgelemek ve yönetmek için kullanımı kolay, entegre bir portal sunar ve uygulama geliştirici topluluğunuzu destekler.
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ştirmeye alternatif bir çözüm sunar. Özellik karşılaştırması 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, 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 özelliklerini 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şturabilmesi için self servis kayıt imkanı sunun. |
| Kitle yönetimi | Portal içeriğine ve API'lere kimlerin erişebileceğini kontrol etme |
| Analytics | Google Analytics'i ve özel analiz izlemeyi yapılandırın. |
| Gelişmiş özelleştirmeler | Aşağıdakiler dahil 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ıyor?
Aşağıdaki tabloda, Apigee'nin entegre portalda 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.
|
apigee.io alt alan adlarında "süper çerezlerin" 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. |
Gerekli:
|
HTML, SQL veya arka uç ekleme saldırılarına karşı koruma sağlar. |
x-content-type-options: nosniff XSS üstbilgisi içerir
|
Tarayıcıların MIME türlerini tahmin etmesini engeller. |
x-frame-options: deny XSS üstbilgisi içerir
|
Portal içeriğinin iFrame'e yerleştirilmesine izin vermez. |
x-xss-protection: 1 XSS üstbilgisi içerir
|
Yansıtılan siteler arası komut dosyası çalıştırma (XSS) saldırıları algılandığında sayfaların yüklenmesini engeller. |
| CSRF jetonları kullanılır | Siteler arası istek sahtekarlığına karşı koruma sağlar |
Avantajlar:
|
Müşteri verilerini koruma |
Entegre portalın Edge ile iletişimi
Geliştirici portalı tarafından kullanılan bilgilerin çoğu Apigee Edge'de depolanır. Portal, Edge'in istemcisi olarak işlev 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ı portalda yeni bir uygulama kaydettiğinde portal, uygulama hakkındaki 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ının depolandığı yer
Portal kullanıcısı, entegre portalda uygulama kayıt işlemini 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 kaydederse Edge, 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. Portal kullanıcısı, bir uygulama hakkındaki bilgileri görüntülemek için portalı kullandığında (ör. Uygulamalarım sayfası aracılığıyla) portal, bilgilere erişmek üzere 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 depolanmak üzere Edge'e gönderir.
Uygulamalar ve API anahtarlarıyla ilgili tüm bilgiler Edge'de depolandığından bir Edge yöneticisi, Edge kullanıcı arayüzünü veya yönetim API'sini kullanarak bilgileri değiştirebilir. Örneğin, bir yönetici şunları yapabilir:
- 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 Uygulamaları kaydetme ve API anahtarlarını yönetme başlıklı makaleyi inceleyin.
Uygulama geliştirici hesabı bilgilerinin depolandığı yer
Geliştirici hesabı bilgileri, Edge'de aşağıdaki şekilde saklanır:
- Yerleşik kimlik sağlayıcı kullanıldığında, 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ılırken 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.
- Bir portal kullanıcısı geliştirici uygulaması kaydettikten sonra kullanıcı hesabı bilgileri Geliştiriciler sayfasında Edge ile senkronize edilir ve kullanılabilir.
Aşağıdaki kullanıcı hesabı bilgileri Edge'de saklanır:
- Ad ve soyadı
- E-posta adresi
- Kullanıcı adı
- Portal hesabı durumu (etkin veya etkin değil)
- Portal rolü (kimliği doğrulanmış kullanıcı, yönetici, diğer)
- Role-based permissions
- Portal kullanıcısının üyesi olduğu ekipler (Ekipler özelliğinin beta sürümüne kaydolduysanız)
E-posta adresi, Edge tarafından geliştiriciyi tanımlamak için 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ş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 arasında şunlar yer alı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şturulma zamanı
Geliştirici ekibi için benzersiz ve otomatik olarak oluşturulan bir e-posta adresi oluşturulur. Bu adres, Edge tarafından geliştirici ekibini tanımlamak için kullanılan birincil anahtar olarak işlev 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ıç noktası olarak kullanabileceğiniz bir dizi başlangıç sayfası sağlanır. Başlangıç sayfalarında, metin ve resimleri kendi benzersiz içeriğinizle değiştirirken kendi portalınızı geliştirmenize yardımcı olacak demo içerikler bulunur. Örnek portal teması, Materyal Tasarım temalandırması ve SCSS kullanır.
Aşağıda örnek portalın ana sayfası gösterilmektedir.
Örnek portal ile birlikte verilen 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ı (index.html) olarak kullanılır. Angular Material bileşenlerinin Angular Material bileşenleri ekleme bölümünde açıklandığı şekilde kullanımını gösterir. |
| Hızlı Başlangıç | Portalı özelleştirme yöntemini gösteren hızlı başlangıç adımları. Örnek portalda Başlarken sayfasında içerik ekleme adımlarını incelemek için Hızlı Başlangıç'ı tıklayın. |
| Başlayın | Örnek içerik sayfası. Bu sayfayı nasıl düzenleyeceğinizi ve üst gezinmeye nasıl ekleyeceğinizi öğrenmek için örnek portaldaki Başlangıç sayfasına bakın. |
| API'ler | Kullanılabilir API'lerin listesi. Etkileşimli API referans belgeleri oluşturduğunuzda, içeriğe giden 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, sayfalar 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, sayfalar 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ı portalınızla nasıl etkileşimde bulunur? başlıklı makaleyi inceleyin. Not: Oturum açma sayfası, portalınıza otomatik olarak eklenir. Oturum açma sayfasındaki logoyu özelleştirebilir ve Hesap Oluşturma sayfasına özel kayıt alanları ekleyebilirsiniz. Sayfanın içeriğini doğrudan düzenleyemezsiniz. Sayfa, sayfalar 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.