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

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

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

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

ดูวิดีโอสั้นๆ นี้สำหรับคำแนะนำเกี่ยวกับการสร้างและเผยแพร่พอร์ทัลที่ผสานรวม

ฟีเจอร์และประโยชน์ที่สำคัญ

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

เริ่มสร้างพอร์ทัลของคุณ

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

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

ฟีเจอร์ ที่อยู่
ต้องใช้ HTTPS และ Transport Layer Security (TLS) บังคับใช้การสื่อสารที่เข้ารหัส
รวมการจดทะเบียนโดเมน apigee.io กับรายการคำต่อท้ายสาธารณะ ไม่อนุญาตให้ตั้งค่า "supercookies" ในโดเมนย่อยของ 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 ป้องกันการปลอมแปลงคำขอข้ามเว็บไซต์
ประโยชน์ใช้สอย การคุ้มครองข้อมูลลูกค้า

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ตำแหน่งที่เก็บข้อมูลทีมนักพัฒนาซอฟต์แวร์ (เบต้า)

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

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

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

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

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

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

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

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

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

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

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

หมายเหตุ: หน้าลงชื่อเข้าใช้จะรวมอยู่ในพอร์ทัลโดยอัตโนมัติ คุณสามารถปรับแต่งโลโก้ในหน้าลงชื่อเข้าใช้และเพิ่มช่องการลงทะเบียนที่กำหนดเองลงในหน้าสร้างบัญชี คุณแก้ไขเนื้อหาของหน้าโดยตรงไม่ได้ เนื่องจากไม่ปรากฏในรายการหน้าเว็บ
ข้อกำหนดและเงื่อนไข หน้าข้อกำหนดและเงื่อนไขตัวอย่าง

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

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