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

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

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

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

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

พอร์ทัลแบบผสานรวมมีฟีเจอร์และสิทธิประโยชน์หลักๆ ดังนี้

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