สร้างพอร์ทัลแบบผสานรวม

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

Apigee Edge มีพอร์ทัลแบบรวมที่ใช้งานง่ายเพื่อบันทึกและจัดการการเข้าถึง API รวมถึงส่งเสริมชุมชนนักพัฒนาแอป

ผู้ใช้ Apigee Edge ทุกคนมีสิทธิ์เข้าถึงเครื่องมือการพัฒนาพอร์ทัลแบบรวม ซึ่งช่วยให้สร้างพอร์ทัลสําหรับนักพัฒนาแอปของตนเองได้อย่างรวดเร็ว เพื่อเป็นทางเลือกแทนการพัฒนาพอร์ทัลที่ใช้ Drupal ดูการเปรียบเทียบฟีเจอร์ได้ที่การเปรียบเทียบฟีเจอร์ของพอร์ทัลนักพัฒนาแอป

ฟีเจอร์และประโยชน์หลัก

พอร์ทัลแบบรวมนี้มีฟีเจอร์และประโยชน์หลักๆ ดังต่อไปนี้

ฟีเจอร์	ประโยชน์
การพัฒนาเนื้อหาของพอร์ทัล	พัฒนาเนื้อหาในพอร์ทัลได้อย่างรวดเร็วและง่ายดาย สร้างหน้าเว็บโดยใช้เครื่องมือแก้ไขหน้าเว็บที่ใช้งานง่าย ใช้ Markdown และ HTML เพื่อเขียนเนื้อหา เพิ่มเมนูสําหรับไปยังส่วนต่างๆ ของพอร์ทัล
รูปลักษณ์ของพอร์ทัล	ปรับแต่งรูปลักษณ์ของพอร์ทัลได้อย่างเต็มที่โดยใช้สไตล์ชีต SCSS และการสร้างแบรนด์ในแบบของคุณ
เอกสาร API	สร้างเอกสารประกอบข้อมูลอ้างอิงของ API โดยอัตโนมัติตามข้อมูลจำเพาะของ OpenAPI
การลงทะเบียนแบบบริการตนเอง	ให้บริการลงทะเบียนด้วยตนเองสำหรับนักพัฒนาแอปเพื่อสร้างแอปโดยใช้ API ของคุณ
การจัดการกลุ่มเป้าหมาย	ควบคุมผู้ที่มีสิทธิ์เข้าถึงเนื้อหาและ API ของพอร์ทัล
Analytics	กําหนดค่า Google Analytics และการติดตามข้อมูลวิเคราะห์ที่กําหนดเอง
การปรับแต่งขั้นสูง	ปรับแต่งพอร์ทัลขั้นสูง ซึ่งรวมถึง ปรับแต่งโดเมน เพิ่มช่องการลงทะเบียนที่กำหนดเอง ขยายการทำงานของพอร์ทัลโดยใช้สคริปต์ กำหนดค่าอีเมล

เริ่มต้นสร้างพอร์ทัล

วิธีที่ Apigee จัดการความปลอดภัยในพอร์ทัลที่ผสานรวม

ตารางต่อไปนี้อธิบายวิธีที่ Apigee จัดการความปลอดภัยผ่านฟีเจอร์ในตัวในพอร์ทัลที่ผสานรวม

ฟีเจอร์	ที่อยู่
ต้องใช้ HTTPS และ Transport Layer Security (TLS)	บังคับใช้การสื่อสารที่เข้ารหัส
รวมการจดทะเบียนโดเมน apigee.io กับรายการคำต่อท้ายสาธารณะ	ไม่อนุญาตให้ตั้งค่า "Supercookie" ในโดเมนย่อยของ apigee.io
รองรับการกําหนดค่านโยบายรักษาความปลอดภัยเนื้อหา (CSP)	ป้องกัน Cross-site Scripting (XSS) และการโจมตีด้วยการแทรกโค้ดอื่นๆ
ต้องระบุข้อมูลต่อไปนี้ การดูแลรักษาข้อมูลที่ป้อนในแบบฟอร์ม การแทรก JavaScript ทั่วทั้งเว็บไซต์จํากัดไว้สำหรับผู้ดูแลระบบเท่านั้น	ป้องกันไม่ให้มีการโจมตีด้วยการแทรก HTML, SQL หรือแบ็กเอนด์
มีส่วนหัว XSS x-content-type-options: nosniff	ไม่อนุญาตให้เบราว์เซอร์พยายามเดาประเภท MIME
มีส่วนหัว XSS x-frame-options: deny	ไม่อนุญาตให้ฝังเนื้อหาพอร์ทัลใน iFrame
มีส่วนหัว XSS x-xss-protection: 1	ไม่อนุญาตให้หน้าเว็บโหลดเมื่อตรวจพบการโจมตี Cross-site Scripting (XSS) แบบสะท้อน
ใช้โทเค็น CSRF	ป้องกันการปลอมแปลงคำขอข้ามเว็บไซต์
เลเวอเรจ: การเข้ารหัสข้อมูลที่ไม่มีการเคลื่อนไหวของ Google Cloud นโยบายการเก็บรักษาและข้อมูลผู้ใช้ของ Google การแยกผู้เช่า การเก็บรักษาข้อมูลบันทึกและการแก้ไขข้อบกพร่อง (6 สัปดาห์)	การคุ้มครองข้อมูลลูกค้า

วิธีที่พอร์ทัลที่ผสานรวมสื่อสารกับ Edge

ข้อมูลส่วนใหญ่ที่พอร์ทัลนักพัฒนาแอปใช้จะจัดเก็บไว้ใน Apigee Edge พอร์ทัลจะทำหน้าที่เป็นไคลเอ็นต์ของ Edge พอร์ทัลนักพัฒนาแอปจะส่งคําขอ REST ผ่าน HTTP หรือ HTTPS เพื่อดึงข้อมูลจากหรือส่งข้อมูลไปยัง Edge ตามที่จำเป็น ตัวอย่างเช่น เมื่อผู้ใช้พอร์ทัลลงทะเบียนแอปใหม่ในพอร์ทัล พอร์ทัลจะส่งคําขอไปยัง Edge เพื่อจัดเก็บข้อมูลเกี่ยวกับแอป

โปรดดูรายละเอียดเพิ่มเติมในส่วนต่อไปนี้

ตำแหน่งที่จัดเก็บการลงทะเบียนแอปและคีย์ API

เมื่อผู้ใช้พอร์ทัลทำตามขั้นตอนการลงทะเบียนแอปในพอร์ทัลที่ผสานรวมเสร็จแล้ว พอร์ทัลจะส่งข้อมูลเกี่ยวกับแอปไปยัง Apigee Edge ซึ่งรวมถึงชื่อแอปและผลิตภัณฑ์ API ที่เชื่อมโยงกับแอป หาก Edge ลงทะเบียนแอปสําเร็จ Edge จะส่งคีย์ API รายการเดียวไปยังพอร์ทัล ผู้ใช้พอร์ทัลจะใช้คีย์ API ดังกล่าวเพื่อเข้าถึงผลิตภัณฑ์ API ที่เชื่อมโยงกับแอป

ข้อมูลเกี่ยวกับแอปและคีย์ API จะจัดเก็บไว้ใน Edge เท่านั้น โดยจะไม่จัดเก็บไว้ในพอร์ทัล เมื่อผู้ใช้พอร์ทัลใช้พอร์ทัลเพื่อดูข้อมูลเกี่ยวกับแอป เช่น ผ่านหน้า "แอปของฉัน" พอร์ทัลจะส่งคําขอไปยัง Edge ด้วยคีย์ API เพื่อเข้าถึงข้อมูล

ในทํานองเดียวกัน เมื่อผู้ใช้พอร์ทัลเพิ่ม นําออก หรือแก้ไขแอป พอร์ทัลจะส่งการแก้ไขไปยัง Edge เพื่อจัดเก็บ

เนื่องจากข้อมูลทั้งหมดเกี่ยวกับแอปและคีย์ API ได้รับการจัดเก็บไว้ใน Edge ผู้ดูแลระบบ Edge จึงแก้ไขข้อมูลได้โดยใช้ UI ของ Edge หรือ Management API ตัวอย่างเช่น ผู้ดูแลระบบสามารถทำสิ่งต่อไปนี้ได้

• เพิ่ม นำออก หรือแก้ไขแอปของนักพัฒนาแอป
• อนุมัติหรือเพิกถอนคีย์ API สําหรับแอปนักพัฒนาแอป

ดูข้อมูลเพิ่มเติมได้ที่ลงทะเบียนแอปและจัดการคีย์ API

ตำแหน่งที่จัดเก็บข้อมูลบัญชีนักพัฒนาแอป

ข้อมูลบัญชีนักพัฒนาแอปจะจัดเก็บไว้ใน Edge ดังนี้

• เมื่อใช้ผู้ให้บริการข้อมูลระบุตัวตนในตัว เมื่อผู้ใช้พอร์ทัลสร้างบัญชี ระบบจะจัดเก็บข้อมูลไว้ในผู้ให้บริการข้อมูลระบุตัวตนและแสดงในหน้าผู้ใช้
• เมื่อใช้ผู้ให้บริการข้อมูลประจำตัว SAML เมื่อผู้ใช้พอร์ทัลลงชื่อเข้าใช้พอร์ทัล ระบบจะจัดเก็บระเบียนข้อมูลเงาไว้ในผู้ให้บริการข้อมูลประจำตัวและแสดงในหน้าผู้ใช้
• หลังจากผู้ใช้พอร์ทัลลงทะเบียนแอปของนักพัฒนาแอป ระบบจะซิงค์ข้อมูลบัญชีผู้ใช้และข้อมูลดังกล่าวจะพร้อมใช้งานใน Edge ในหน้าสำหรับนักพัฒนาแอป

ข้อมูลบัญชีผู้ใช้ต่อไปนี้จะจัดเก็บไว้ใน Edge

• ชื่อและนามสกุล
• อีเมล
• ชื่อผู้ใช้
• สถานะบัญชีพอร์ทัล (ใช้งานอยู่หรือไม่ใช้งาน)
• บทบาทในพอร์ทัล (ผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ผู้ดูแลระบบ อื่นๆ)
• สิทธิ์ตามบทบาท
• ทีมที่ผู้ใช้พอร์ทัลเป็นสมาชิก (หากคุณลงทะเบียนใช้ฟีเจอร์ทีมรุ่นเบต้า)

อีเมลคือคีย์หลักที่ Edge ใช้เพื่อระบุนักพัฒนาแอป และอีเมลแต่ละรายการต้องไม่ซ้ำกัน Edge จะสร้างรหัสนักพัฒนาแอปที่ไม่ซ้ำกันสำหรับองค์กรแต่ละแห่งที่นักพัฒนาแอปสังกัดอยู่จากคีย์หลัก

ดูข้อมูลเพิ่มเติมได้ที่ลงทะเบียนนักพัฒนาแอป

ตำแหน่งที่จัดเก็บข้อมูลทีมนักพัฒนาแอป (เบต้า)

เมื่อผู้ใช้พอร์ทัลสร้างทีมนักพัฒนาแอปในพอร์ทัล ระบบจะจัดเก็บข้อมูลทีมนักพัฒนาแอปไว้ใน Edge ซึ่งรวมถึงข้อมูลต่อไปนี้

• ชื่อและคำอธิบายทีมนักพัฒนาแอป
• สมาชิกในทีมนักพัฒนาแอปและบทบาทของสมาชิก
• แอปที่กําหนดให้ทีมนักพัฒนาแอป
• กลุ่มเป้าหมายที่กำหนดให้กับทีมนักพัฒนาซอฟต์แวร์
• เวลาสร้างทีมนักพัฒนาแอป

ระบบจะสร้างอีเมลที่ไม่ซ้ำกันซึ่งสร้างขึ้นโดยอัตโนมัติสำหรับทีมนักพัฒนาแอป และใช้เป็นคีย์หลักที่ Edge ใช้เพื่อระบุทีมนักพัฒนาแอป

ดูข้อมูลเพิ่มเติมได้ที่แชร์ความรับผิดชอบสำหรับแอปโดยใช้ทีมนักพัฒนาแอป (เบต้า) และจัดการทีมนักพัฒนาแอป

เกี่ยวกับพอร์ทัลตัวอย่าง

เมื่อสร้างพอร์ทัลใหม่ ระบบจะจัดเตรียมชุดหน้าเริ่มต้นไว้ให้คุณใช้เป็นจุดเริ่มต้น หน้าเริ่มต้นมีเนื้อหาสาธิตเพื่อช่วยสร้างแรงบันดาลใจในการพัฒนาพอร์ทัลของคุณเองเมื่อคุณแทนที่ข้อความและรูปภาพด้วยเนื้อหาที่เป็นเอกลักษณ์ ธีมพอร์ทัลตัวอย่างใช้ธีม Material Design และ SCSS

ต่อไปนี้แสดงหน้าแรกของพอร์ทัลตัวอย่าง

หน้าเริ่มต้นที่มาพร้อมกับพอร์ทัลตัวอย่างมีดังนี้

หน้าเว็บ	คำอธิบาย
เคหสถาน	หน้าแรกของพอร์ทัลที่อธิบาย API ที่แสดง ใช้เป็นหน้าแรกเริ่มต้นสำหรับพอร์ทัล (index.html) สาธิตการใช้คอมโพเนนต์ Angular Material ตามที่อธิบายไว้ในเพิ่มคอมโพเนนต์ Angular Material
คู่มือเริ่มต้นฉบับย่อ	ชุดขั้นตอนเริ่มต้นฉบับย่อที่แสดงวิธีปรับแต่งพอร์ทัล คลิกเริ่มต้นใช้งานอย่างรวดเร็วในพอร์ทัลตัวอย่างเพื่อดูขั้นตอนการเพิ่มเนื้อหาในหน้าเริ่มต้นใช้งาน
เริ่มต้นใช้งาน	หน้าเนื้อหาตัวอย่าง ดูหน้าเริ่มต้นใช้งานในพอร์ทัลตัวอย่างเพื่อดูวิธีแก้ไขหน้านี้และเพิ่มลงในการนำทางด้านบน
API	รายการ API ที่พร้อมใช้งาน เมื่อคุณสร้างเอกสารอ้างอิงแบบอินเทอร์แอกทีฟของ API ระบบจะเพิ่มลิงก์ไปยังเนื้อหาในหน้านี้โดยอัตโนมัติ หมายเหตุ: เนื้อหาของหน้านี้จะสร้างขึ้นโดยอัตโนมัติตาม API ที่คุณเผยแพร่ในพอร์ทัล คุณแก้ไขเนื้อหาของหน้านี้โดยตรงไม่ได้ เนื่องจากหน้านี้จะไม่ปรากฏในรายการหน้าเว็บ คุณแก้ไขการจัดรูปแบบของหน้าเว็บได้โดยใช้เครื่องมือแก้ไขธีมพอร์ทัล
แอปของฉัน	รายชื่อแอปที่ลงทะเบียนไว้สำหรับผู้ใช้ที่ได้รับอนุญาต ดูวิธีที่ผู้ใช้พอร์ทัลโต้ตอบกับพอร์ทัลของคุณ หมายเหตุ: เนื้อหาของหน้านี้สร้างขึ้นโดยอัตโนมัติตามแอปของผู้ใช้ที่ลงทะเบียน คุณจะแก้ไขเนื้อหาของหน้าเว็บโดยตรงไม่ได้ เนื่องจากหน้าเว็บดังกล่าวจะไม่ปรากฏในรายการหน้าเว็บ คุณแก้ไขการจัดรูปแบบของหน้าเว็บได้โดยใช้เครื่องมือแก้ไขธีม
ลงชื่อเข้าใช้	หน้าลงชื่อเข้าใช้สำหรับผู้ใช้ที่ลงทะเบียน ผู้ใช้ใหม่จะลงทะเบียนจากหน้านี้ได้โดยคลิกลงชื่อเข้าใช้ ดูวิธีที่ผู้ใช้พอร์ทัลโต้ตอบกับพอร์ทัล หมายเหตุ: หน้าลงชื่อเข้าใช้จะรวมอยู่ในพอร์ทัลโดยอัตโนมัติ คุณสามารถปรับแต่งโลโก้ในหน้าลงชื่อเข้าใช้ และเพิ่มช่องการลงทะเบียนที่กำหนดเองลงในหน้าสร้างบัญชี คุณจะแก้ไขเนื้อหาของหน้าเว็บโดยตรงไม่ได้ เนื่องจากหน้าเว็บดังกล่าวจะไม่ปรากฏในรายการหน้าเว็บ
ข้อกำหนดและเงื่อนไข	ตัวอย่างหน้าข้อกำหนดและเงื่อนไข

การสนับสนุนเบราว์เซอร์

พอร์ทัลที่ผสานรวมของ Apigee รองรับเบราว์เซอร์เวอร์ชันเดียวกับ Apigee Edge