คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
พอร์ทัลนักพัฒนาแอปที่มีฟีเจอร์การเผยแพร่แบบโซเชียลมีการใช้งานมากขึ้นเพื่อการสื่อสารกับชุมชนนักพัฒนาแอป ซึ่งรวมถึงการสื่อสารเนื้อหาแบบคงที่ เช่น เอกสารประกอบ API และข้อกำหนดในการใช้งาน ตลอดจนเนื้อหาแบบไดนามิกที่ชุมชนมีส่วนร่วม เช่น บล็อกและฟอรัม
ในฐานะผู้ให้บริการ API คุณต้องมีวิธีแสดง API, แจ้งข้อมูลเกี่ยวกับ API แก่นักพัฒนาแอป, ลงชื่อสมัครใช้นักพัฒนาแอป และอนุญาตให้นักพัฒนาแอปลงทะเบียนแอป การเปิดเผย API แก่นักพัฒนาแอปเป็นเพียงส่วนหนึ่งของการสร้างชุมชนที่มีชีวิตชีวาอย่างแท้จริง นอกจากนี้ คุณต้องมีวิธีให้ชุมชนนักพัฒนาแอปแสดงความคิดเห็น ส่งคำขอรับการสนับสนุนและฟีเจอร์ รวมถึงส่งเนื้อหาของตนเองที่นักพัฒนาแอปคนอื่นๆ จะเข้าถึงได้
Apigee Edge มีพอร์ทัลบริการสำหรับนักพัฒนาซอฟต์แวร์ที่คุณสามารถใช้สร้างและเปิดตัวเว็บไซต์ที่กําหนดเองเพื่อให้บริการเหล่านี้ทั้งหมดแก่ชุมชนนักพัฒนาซอฟต์แวร์ ลูกค้า Edge ทุกคนสามารถสร้างพอร์ทัลนักพัฒนาแอปของตนเองได้ทั้งในระบบคลาวด์หรือในองค์กร
วิดีโอต่อไปนี้จะแนะนำพอร์ทัลบริการสำหรับนักพัฒนาแอปของ Apigee
รูปภาพต่อไปนี้แสดงหน้าแรกของพอร์ทัลนักพัฒนาแอปเริ่มต้น
โดยพื้นฐานแล้ว พอร์ทัลนักพัฒนาซอฟต์แวร์คือระบบจัดการเนื้อหา (CMS) ที่ใช้โปรเจ็กต์ Drupal (http://www.drupal.org) แบบโอเพนซอร์ส Drupal มีชุดฟีเจอร์หลักในรูปแบบโมดูลที่ช่วยให้คุณสร้างเนื้อหาและจัดการเว็บไซต์ได้อย่างง่ายดาย
พอร์ทัลนักพัฒนาซอฟต์แวร์ช่วยให้คุณสร้างเอกสารประกอบ API, รองรับการเขียนบล็อก และมีฟอรัมแบบใช้ชุดข้อความได้ทันที นอกจากนี้ คุณยังปรับแต่งพอร์ทัลนักพัฒนาแอปให้เป็นไปตามข้อกำหนดเฉพาะของคุณได้ด้วย การปรับแต่งช่วยให้คุณแก้ไขลักษณะที่ปรากฏของพอร์ทัลและวิธีที่นักพัฒนาแอปโต้ตอบกับพอร์ทัลได้
คุณใช้เมนู Drupal เพื่อทำการปรับเปลี่ยนส่วนใหญ่ หากคุณเข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบ เมนู Drupal จะปรากฏที่ด้านบนของทุกหน้าในพอร์ทัล
ฝ่ายดูแลระบบจะควบคุมกระบวนการที่นักพัฒนาแอปขอสิทธิ์เข้าถึงพอร์ทัล วิธีที่นักพัฒนาแอปลงทะเบียนแอปที่เข้าถึง API ของคุณ วิธีที่คุณจะกำหนดบทบาทและสิทธิ์ที่เฉพาะเจาะจงให้กับนักพัฒนาแอปที่เกี่ยวข้องกับ API และกรณีที่ควรเพิกถอนสิทธิ์เข้าถึง API ของนักพัฒนาแอป
นอกจากนี้ คุณยังใช้พอร์ทัลนักพัฒนาแอปเพื่อกำหนดค่าและควบคุมการสร้างรายได้ได้ด้วย การสร้างรายได้ช่วยให้นักพัฒนาแอปเข้าถึงการเรียกเก็บเงินและรายงาน แคตตาล็อกและแพ็กเกจ รวมถึงการตั้งค่าเฉพาะการสร้างรายได้ด้วยตนเองผ่านพอร์ทัลนักพัฒนาแอป
ประเภทของผู้ใช้พอร์ทัล
รูปภาพต่อไปนี้แสดงผู้ใช้พอร์ทัล 2 ประเภท ได้แก่
- นักพัฒนาแอปเป็นชุมชนผู้ใช้ที่สร้างแอปโดยใช้ API ของคุณ นักพัฒนาแอปใช้พอร์ทัลเพื่อดูข้อมูลเกี่ยวกับ API ของคุณผ่าน SmartDocs, ลงทะเบียนบัญชีในพอร์ทัล, ลงทะเบียนแอปที่ใช้ API ของคุณ, โต้ตอบกับชุมชนนักพัฒนาแอป และดูข้อมูลสถิติเกี่ยวกับการใช้งานแอปในหน้าแดชบอร์ด
-
ทีม API คือผู้ให้บริการ API ที่สร้างเนื้อหาพอร์ทัล ทำให้ API พร้อมใช้งานสำหรับนักพัฒนาแอป จัดทำเอกสารประกอบ API และจัดเตรียมกลไกให้นักพัฒนาแอปลงทะเบียนแอปและรับคีย์ API ทีม API จะทำการกําหนดค่าพื้นฐานของพอร์ทัลนักพัฒนาแอปเพื่อดำเนินการต่อไปนี้
- กำหนดค่าคําขอคีย์ API แบบอัตโนมัติหรือด้วยตนเอง
- ดูแลรักษาเอกสารประกอบเกี่ยวกับ API, ฟอรัม และบล็อก รวมถึงแก้ไขการเปลี่ยนแปลงทั้งหมด (ไม่บังคับ)
- จัดการความคิดเห็นของผู้ใช้และการดูแลฟอรัม
- บังคับใช้การควบคุมการเข้าถึงตามบทบาท (RBAC) เพื่อควบคุมการเข้าถึงฟีเจอร์ในพอร์ทัล เช่น ผู้ดูแลระบบสามารถเปิดใช้การควบคุมเพื่ออนุญาตให้ผู้ใช้ที่ลงทะเบียนแล้วสร้างโพสต์ในฟอรัมหรือใช้คอนโซลทดสอบ
- ปรับแต่งการแจ้งเตือนทางอีเมลสำหรับทั้งผู้ดูแลระบบและนักพัฒนาแอปสำหรับการสร้างและการอนุมัติผู้ใช้
- ปรับแต่งเว็บฟอร์ม เช่น หน้า "ติดต่อเรา"
ผู้ใช้พอร์ทัลประเภทที่ 3 ซึ่งไม่ได้แสดงในภาพนี้คือผู้จัดการผลิตภัณฑ์ API ผู้จัดการผลิตภัณฑ์ API มีหน้าที่กำหนดวิธีที่ทีม API จะสร้างพอร์ทัล ซึ่งรวมถึงสิ่งต่อไปนี้
- การกำหนดวิธีแพ็กเกจ API ไว้ในผลิตภัณฑ์
- การกําหนดกฎสําหรับการอนุมัติแอป
- หากเปิดใช้การสร้างรายได้ในพอร์ทัล ให้กำหนดราคาและแพ็กเกจการเรียกเก็บเงินสำหรับผลิตภัณฑ์ API ดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างรายได้ได้ที่ภาพรวมการสร้างรายได้
การปรับแต่งพอร์ทัลนักพัฒนาแอป
ในฐานะผู้ให้บริการ API ให้พิจารณาวิธีปรับแต่งพอร์ทัลนักพัฒนาซอฟต์แวร์ให้เหมาะกับ API ของคุณมากที่สุด และเพื่อมอบข้อมูลที่จําเป็นสําหรับชุมชนนักพัฒนาซอฟต์แวร์ของคุณในการใช้ API ข้อควรพิจารณาบางอย่างสำหรับพอร์ทัลที่กำหนดเองมีดังนี้
- เข้าถึง API ได้อย่างง่ายดาย
- เอกสารประกอบ เช่น คู่มือวิธีการและเอกสารอ้างอิง
- เนื้อหาที่สมาชิกชุมชนมีส่วนร่วม เช่น บล็อกและฟอรัมการสนทนา
- โค้ดตัวอย่าง
- ขั้นตอนการลงชื่อสมัครใช้ที่ง่ายดายซึ่งนักพัฒนาแอป แอป และ API รายใหม่จะได้รับอนุมัติอย่างรวดเร็ว
- สิทธิ์และข้อมูลเข้าสู่ระบบที่มีการจัดการ
- การควบคุมการเข้าถึงแบบเป็นชั้น
- รูปลักษณ์และอารมณ์ความรู้สึกที่ตรงกับองค์กรของคุณ
พอร์ทัลมีการกําหนดค่าพื้นฐานที่กําหนดไว้ล่วงหน้า ตัวอย่างเช่น พอร์ทัลจะกําหนดค่าให้อนุญาตทุกคนลงทะเบียนเป็นนักพัฒนาแอปได้ แต่ผู้ดูแลระบบต้องอนุมัติการลงทะเบียนแต่ละรายการก่อน นักพัฒนาแอปจึงจะเข้าสู่ระบบพอร์ทัลได้ หลังจากการอนุมัติการลงทะเบียน นักพัฒนาแอปจะลงทะเบียนแอปเพื่อขอคีย์ API และใช้พอร์ทัลเพื่อเข้าถึงแหล่งข้อมูล API ได้
ขั้นตอนในกระบวนการลงทะเบียนเริ่มต้นมีดังนี้
- นักพัฒนาแอปจะลงทะเบียนผ่านพอร์ทัลนักพัฒนาแอป พอร์ทัลจะส่งอีเมลถึงผู้ดูแลระบบเพื่อขออนุมัติบัญชี
- ผู้ดูแลระบบจะอนุมัติบัญชีและส่งอีเมลแจ้งให้นักพัฒนาแอปทราบว่าสามารถเข้าสู่ระบบได้แล้ว
- นักพัฒนาแอปจะลงทะเบียนแอปและเลือกผลิตภัณฑ์ API ที่แอปใช้ พอร์ทัลจะกำหนดคีย์ API ที่ไม่ซ้ำกันให้กับแอป
- นักพัฒนาแอปจะส่งคีย์ API เมื่อส่งคำขอไปยัง API ของคุณ
ประสบการณ์การใช้งานนี้พร้อมให้ปรับแต่งได้อย่างมาก ตัวอย่างเช่น คุณสามารถลบล้างรูปแบบการจดทะเบียนและการให้สิทธิ์เริ่มต้นเพื่อให้ระบบอนุมัตินักพัฒนาแอปรายใหม่โดยอัตโนมัติและเข้าสู่ระบบหลังจากการจดทะเบียน หรือจะกำหนดให้นักพัฒนาแอปต้องยอมรับข้อกำหนดและเงื่อนไขชุดหนึ่งก่อนจึงจะเข้าสู่ระบบได้เป็นครั้งแรกก็ได้
นอกจากนี้ คุณยังควบคุมเนื้อหาที่มีอยู่ในพอร์ทัลนักพัฒนาแอปได้อย่างเต็มรูปแบบ พอร์ทัลนักพัฒนาซอฟต์แวร์จะแสดงตัวอย่างเนื้อหา เช่น เอกสารประกอบ API, บล็อกโพสต์ และการสนทนาในฟอรัม คุณสามารถใส่เนื้อหาของคุณเองและปรับแต่งลักษณะที่ปรากฏของเนื้อหาแต่ละประเภทได้
ดูข้อมูลเพิ่มเติมได้ที่ปรับแต่งลักษณะที่ปรากฏ
การดูแลพอร์ทัลนักพัฒนาแอป
นักพัฒนาแอปใช้พอร์ทัลนักพัฒนาแอปเพื่อเข้าถึงและใช้ API ของคุณ ผู้ดูแลระบบจะทํางานด้านการจัดการบัญชี เช่น
- การปรับแต่งขั้นตอนการลงทะเบียนของนักพัฒนาแอป ซึ่งรวมถึงช่องการลงทะเบียน แคปtcha ในตัว และการอนุมัติอัตโนมัติหรือด้วยตนเอง
- การเพิ่มหรืออนุมัตินักพัฒนาแอป โดยค่าเริ่มต้น นักพัฒนาแอปทุกคนจะลงทะเบียนผ่านพอร์ทัลนักพัฒนาแอปได้ แต่ต้องได้รับอนุมัติจากผู้ดูแลระบบผ่านอินเทอร์เฟซผู้ใช้ของพอร์ทัลนักพัฒนาแอป นอกจากนี้ ผู้ดูแลระบบยังสร้างนักพัฒนาแอปในพอร์ทัลได้โดยตรง จากนั้นพอร์ทัลจะส่งอีเมลแจ้งให้นักพัฒนาแอปทราบว่าระบบได้สร้างบัญชีให้แล้ว
- การแก้ไขบัญชีของนักพัฒนาแอป เช่น ผู้ดูแลระบบสามารถเปลี่ยนสถานะบัญชีของผู้ใช้จาก "ใช้งานอยู่" เป็น "ถูกบล็อก" หรือเปลี่ยนข้อมูลโปรไฟล์ของนักพัฒนาแอป เช่น ชื่อบริษัท
- การนำนักพัฒนาแอปออก ผู้ดูแลระบบสามารถปิดใช้หรือลบบัญชีของนักพัฒนาแอปได้
- การกำหนดบทบาทและสิทธิ์: ผู้ดูแลระบบสามารถกำหนดบทบาทที่เฉพาะเจาะจงให้กับบัญชีนักพัฒนาแอปได้ บทบาทจะเชื่อมโยงกับสิทธิ์ต่างๆ เช่น สิทธิ์ในการสร้างหนังสือหรือเนื้อหาอื่นๆ นอกจากนี้ คุณยังเปลี่ยนสิทธิ์ที่เชื่อมโยงกับบทบาทหรือสร้างบทบาทใหม่ได้ด้วย
ดูข้อมูลเพิ่มเติมได้ที่เพิ่มและจัดการบัญชีผู้ใช้
สรุปฟีเจอร์ของพอร์ทัลนักพัฒนาแอป
ตารางต่อไปนี้แสดงข้อมูลสรุปของฟีเจอร์ในพอร์ทัลนักพัฒนาแอป
| ฟีเจอร์ | รายละเอียด |
|---|---|
| การสนับสนุนเบราว์เซอร์ | |
|
การลงทะเบียนผู้ใช้ |
|
|
การจัดการผู้ใช้ |
|
|
ลักษณะของพอร์ทัล |
|
|
การจัดการเนื้อหาและชุมชน |
|
|
สิทธิ์ |
|
|
การจัดการคีย์ API |
|
|
อีเมล |
|
|
บล็อก |
|
|
ฟอรั่ม |
|
|
เอกสารประกอบ |
|
|
เมนู |
|
|
ค้นหา |
|
|
ตัวตรวจสอบลิงก์ |
|