คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
พอร์ทัลนักพัฒนาซอฟต์แวร์ที่มีฟีเจอร์การเผยแพร่โซเชียลต่างก็มีการใช้เพื่อสื่อสารกับชุมชนนักพัฒนาซอฟต์แวร์เพิ่มมากขึ้น ซึ่งรวมถึงการสื่อสารเกี่ยวกับเนื้อหาแบบคงที่ เช่น เอกสารประกอบเกี่ยวกับ 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 ผ่าน SmartGoogle, ลงทะเบียนบัญชีในพอร์ทัล, ลงทะเบียนแอปที่ใช้ 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 ผู้ดูแลระบบดำเนินการต่างๆ ด้านการจัดการบัญชี เช่น
- การปรับแต่งกระบวนการลงทะเบียนนักพัฒนาซอฟต์แวร์ รวมถึงช่องการลงทะเบียน, CAPTCHA ในตัว และการอนุมัติแบบอัตโนมัติหรือด้วยตนเอง
- การเพิ่มหรืออนุมัตินักพัฒนาแอป โดยค่าเริ่มต้น นักพัฒนาซอฟต์แวร์ทุกคนจะลงทะเบียนผ่านพอร์ทัลนักพัฒนาซอฟต์แวร์ได้ แต่ต้องได้รับการอนุมัติจากผู้ดูแลระบบผ่านอินเทอร์เฟซผู้ใช้ของพอร์ทัลนักพัฒนาซอฟต์แวร์ นอกจากนี้ผู้ดูแลระบบยังสร้างนักพัฒนาซอฟต์แวร์ในพอร์ทัลได้โดยตรงอีกด้วย จากนั้นพอร์ทัลจะส่งอีเมลถึงนักพัฒนาแอปโดยอัตโนมัติว่ามีการสร้างบัญชีให้
- การแก้ไขบัญชีนักพัฒนาแอป เช่น ผู้ดูแลระบบอาจเปลี่ยนสถานะบัญชีของผู้ใช้จากใช้งานอยู่เป็นถูกบล็อก หรือเปลี่ยนข้อมูลโปรไฟล์ของนักพัฒนาซอฟต์แวร์ได้ เช่น ชื่อบริษัท
- การนำนักพัฒนาแอปออก ผู้ดูแลระบบสามารถปิดใช้หรือลบบัญชีนักพัฒนาแอปได้
- การกำหนดบทบาทและสิทธิ์: ผู้ดูแลระบบสามารถมอบหมายบทบาทที่เฉพาะเจาะจงให้กับบัญชีนักพัฒนาซอฟต์แวร์ได้ บทบาทจะเชื่อมโยงกับสิทธิ์ต่างๆ เช่น สิทธิ์ในการสร้างหนังสือหรือเนื้อหาอื่นๆ นอกจากนี้ คุณยังเปลี่ยนสิทธิ์ที่เชื่อมโยงกับบทบาทหรือสร้างบทบาทใหม่ได้ด้วย
ดูข้อมูลเพิ่มเติมได้ที่เพิ่มและจัดการบัญชีผู้ใช้
สรุปฟีเจอร์ของพอร์ทัลนักพัฒนาซอฟต์แวร์
ตารางต่อไปนี้มีข้อมูลสรุปเกี่ยวกับฟีเจอร์ของพอร์ทัลนักพัฒนาซอฟต์แวร์
| ฟีเจอร์ | รายละเอียด |
|---|---|
| การสนับสนุนเบราว์เซอร์ | |
|
การลงทะเบียนผู้ใช้ |
|
|
การจัดการผู้ใช้ |
|
|
ลักษณะที่ปรากฏของพอร์ทัล |
|
|
การจัดการชุมชนและเนื้อหา |
|
|
สิทธิ์ |
|
|
การจัดการคีย์ API |
|
|
อีเมล |
|
|
บล็อก |
|
|
ฟอรั่ม |
|
|
เอกสารประกอบ |
|
|
เมนู |
|
|
ค้นหา |
|
|
ตัวตรวจสอบลิงก์ |
|