คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
พอร์ทัลสำหรับนักพัฒนาซอฟต์แวร์ที่พร้อมใช้งานทันทีช่วยให้นักพัฒนาแอปของคุณสามารถลงทะเบียน ลงชื่อเข้าใช้ และจัดการแอปที่ใช้ API ของคุณได้
ส่วนต่อไปนี้อธิบายวิธีที่นักพัฒนาแอปโต้ตอบกับพอร์ทัลของคุณ
วิธีติดตามการลงทะเบียนและลงชื่อเข้าใช้ของนักพัฒนาแอปใน Edge
ระบบจะติดตามการลงทะเบียนนักพัฒนาแอปและการลงชื่อเข้าใช้พอร์ทัลโดยใช้แอตทริบิวต์ที่กำหนดเองของ _apiportal ใน Edge
เมื่อนักพัฒนาแอปลงทะเบียนด้วยตนเอง ระบบจะเพิ่มแอตทริบิวต์ที่กำหนดเอง _apiportal ลงในการกำหนดค่านักพัฒนาซอฟต์แวร์ และตั้งค่าสถานะนักพัฒนาแอปเป็น unverified เพื่อระบุว่านักพัฒนาแอปไม่ได้ลงชื่อเข้าใช้พอร์ทัลดังกล่าว ตัวอย่าง: {"status":"unverified","portals":{}}
ครั้งแรกที่นักพัฒนาแอปลงชื่อเข้าใช้พอร์ทัล ระบบจะอัปเดตแอตทริบิวต์ที่กำหนดเองของ _apiportal เพื่อติดตามชื่อพอร์ทัลและเวลาที่มีการเข้าถึง รวมถึงตั้งค่าสถานะนักพัฒนาแอปเป็น active ทุกครั้งที่นักพัฒนาซอฟต์แวร์ลงชื่อเข้าใช้พอร์ทัล ระบบจะอัปเดตแอตทริบิวต์ที่กำหนดเองเพื่อรีเซ็ตค่า lastVisit (ในรูปแบบ Epoch) สำหรับพอร์ทัลนั้น ตัวอย่าง: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}
ลงทะเบียนบัญชีนักพัฒนาแอปแอป
ก่อนที่นักพัฒนาแอปจะใช้ API ของคุณได้ นักพัฒนาแอปต้องลงทะเบียนโดยการสร้างบัญชี
เมื่อนักพัฒนาแอปลงทะเบียนกับพอร์ทัลของคุณ
- ระบบจะสร้างและจัดเก็บข้อมูลนักพัฒนาแอปไว้ใน Edge โปรดดูตำแหน่งที่ใช้จัดเก็บข้อมูลบัญชีนักพัฒนาแอป
- นักพัฒนาแอปจะปรากฏในรายชื่อนักพัฒนาแอปที่ลงทะเบียน ดูสำรวจหน้าสำหรับนักพัฒนาซอฟต์แวร์
หรือคุณอาจลงทะเบียนนักพัฒนาแอปในนามของนักพัฒนาแอปโดยใช้ Edge UI ตามที่อธิบายไว้ในการลงทะเบียนนักพัฒนาแอป
นักพัฒนาแอปรายใหม่สามารถลงทะเบียนด้วยตนเองกับพอร์ทัลของคุณได้ดังนี้
- ไปที่พอร์ทัล
- คลิกลงชื่อเข้าใช้
คลิกลงชื่อสมัครใช้
กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น
ป้อนข้อมูลที่จำเป็น (ชื่อ นามสกุล และอีเมล)
คลิกสร้าง
กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น
คลิกลิงก์ที่ปลอดภัยในอีเมลเพื่อเปิดพอร์ทัลและสร้างเซสชันการตรวจสอบสิทธิ์
ลงชื่อเข้าใช้พอร์ทัลของคุณ
หลังจากที่นักพัฒนาแอปลงทะเบียนกับพอร์ทัลของคุณแล้ว พวกเขาจะลงชื่อเข้าใช้โดยใช้หน้าลงชื่อเข้าใช้
ทุกครั้งที่นักพัฒนาแอปลงชื่อเข้าใช้พอร์ทัล แทนที่จะใช้ข้อมูลลับที่แชร์ เช่น รหัสผ่านในการตรวจสอบสิทธิ์นักพัฒนาแอป ระบบจะส่งลิงก์ที่ปลอดภัยเพื่อยืนยันตัวตนและสร้างเซสชันกับพอร์ทัลนั้น
นักพัฒนาแอปสามารถลงชื่อเข้าใช้พอร์ทัลของคุณได้ดังนี้
- ไปที่พอร์ทัล
- คลิกลงชื่อเข้าใช้
- ป้อนอีเมลที่ผูกกับบัญชี
คลิกเข้าสู่ระบบ
กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น
คลิกลิงก์ที่ปลอดภัยในอีเมลเพื่อเปิดพอร์ทัลและสร้างเซสชันการตรวจสอบสิทธิ์
ลงทะเบียนแอป
หลังจากลงชื่อเข้าใช้พอร์ทัลแล้ว นักพัฒนาแอปสามารถลงทะเบียนแอปเพื่อใช้ผลิตภัณฑ์ API ที่คุณเผยแพร่ได้ ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิก + แอปเพื่อสร้างแอปใหม่
- ป้อนชื่อและคำอธิบายสำหรับแอปในกล่องโต้ตอบ "สร้างแอป"
- คลิกสร้าง
- จัดการผลิตภัณฑ์ API ในแอปตามที่อธิบายไว้ด้านล่าง
จัดการผลิตภัณฑ์ API ในแอป
นักพัฒนาแอปสามารถจัดการผลิตภัณฑ์ API ในแอปของตนได้ ระบบจะเพิ่มผลิตภัณฑ์ API ลงในหน้ารายละเอียดแอป การอนุมัติจะไม่เป็นแบบอัตโนมัติสำหรับผลิตภัณฑ์ API บางรายการ สถานะรอดำเนินการบ่งบอกถึงผลิตภัณฑ์ API ที่มีการขอการเข้าถึงแล้ว แต่ยังไม่ได้ให้สิทธิ์การเข้าถึง
นักพัฒนาแอปสามารถจัดการผลิตภัณฑ์ API ในแอปจากพอร์ทัลของคุณได้ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- คลิก Manage Products
คลิกปุ่มสลับการเข้าถึงเพื่อเปิดหรือปิดสิทธิ์การเข้าถึงผลิตภัณฑ์ API จากแอป
หมายเหตุ: หากนักพัฒนาแอปปิดการเข้าถึงผลิตภัณฑ์ API แบบส่วนตัวหรือภายในเท่านั้น ผลิตภัณฑ์ API จะถูกนำออกจากแอปและต้องเพิ่มด้วยตนเองโดยผู้ดูแลระบบพอร์ทัลอีกครั้ง ตามที่อธิบายไว้ในหัวข้อลงทะเบียนแอปและจัดการคีย์ API
คลิกส่งคำขอเพื่อขออนุมัติผลิตภัณฑ์ API ที่ยังไม่ได้รับอนุญาต
คลิกบันทึก
ดูคีย์ API สำหรับแอป
นักพัฒนาแอปจะจัดการคีย์ API สำหรับแอปจากพอร์ทัลของคุณได้ด้วยวิธีต่อไปนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- ดูคีย์ API ในส่วนคีย์
- คลิก View Secret เพื่อแสดงคีย์ API Secret
- ยืนยันว่าสถานะของคีย์ API เป็น "อนุมัติ"
หมุนเวียนคีย์ API สำหรับแอป
นักพัฒนาแอปสามารถหมุนเวียนคีย์ API ของแอปเป็นระยะๆ หรือตอบสนองต่อการรั่วไหลหรือช่องโหว่ที่อาจเกิดขึ้น เมื่อนักพัฒนาแอปหมุนเวียนคีย์ API ระบบจะสร้างคีย์ API ใหม่โดยให้สิทธิ์ผลิตภัณฑ์ API เดียวกันกับคีย์เดิม คีย์ API เดิมได้รับการทำเครื่องหมายว่าเลิกใช้งาน แต่คีย์ดังกล่าวจะยังคงใช้งานได้ขณะที่คุณเปลี่ยนรุ่น คุณต้องปิดใช้งานคีย์ที่เลิกใช้งานแล้วเพื่อป้องกันไม่ให้ระบบยอมรับข้อมูลเข้าสู่ระบบ ตามที่อธิบายไว้ในหัวข้อการปิดใช้งานคีย์ API สำหรับแอป
นักพัฒนาแอปสามารถหมุนเวียนคีย์ API หลักสำหรับแอปจากพอร์ทัลของคุณได้ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- ในส่วนคีย์ ให้วางเคอร์เซอร์เหนือคีย์ API ปัจจุบันเพื่อแสดงเมนูการทำงาน
- คลิก
เพื่อขยายเมนูการทำงาน - คลิกหมุน
- คลิกสร้างในกล่องโต้ตอบเพื่อยืนยันการดำเนินการ
- (ไม่บังคับ) ปิดใช้งานคีย์ API ตามที่อธิบายไว้ด้านล่าง
ปิดใช้งานคีย์ API สำหรับแอป
เมื่อนักพัฒนาแอปหมุนเวียนคีย์ API ดังที่อธิบายในส่วนก่อนหน้านี้ ระบบจะทำเครื่องหมายคีย์ API ว่าเลิกใช้งานแล้ว แต่คีย์ API จะยังคงใช้งานได้ขณะที่คุณเปลี่ยนออกจากการใช้งาน คุณต้องปิดใช้งานคีย์ที่เลิกใช้งานแล้วเพื่อป้องกันไม่ให้ระบบยอมรับข้อมูลเข้าสู่ระบบของคีย์นั้น
นักพัฒนาแอปสามารถปิดใช้งานคีย์ API สำหรับแอปจากพอร์ทัลของคุณได้ ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- ในส่วนคีย์ ให้คลิกประวัติคีย์เพื่อแสดงรายการคีย์ที่เลิกใช้
- วางเคอร์เซอร์เหนือคีย์ API ที่เลิกใช้งานแล้วซึ่งคุณต้องการปิดใช้งานเพื่อแสดงเมนูการทำงาน
- คลิก เพื่อขยายเมนูการทำงาน
- คลิกปิดใช้งาน
- คลิกปิดใช้งานเพื่อยืนยันการดำเนินการ
สถานะของคีย์จะเปลี่ยนเป็น "เพิกถอนแล้ว"
แก้ไขรายละเอียดแอป
นักพัฒนาแอปสามารถแก้ไขรายละเอียดแอปได้ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- แก้ไขฟิลด์ "ชื่อ" หรือ "คำอธิบาย"
- คลิกบันทึก
ระบบจะลบและนำแอปออกจากรายการ "แอปของฉัน"
ลบแอป
นักพัฒนาแอปสามารถลบแอปออกจากพอร์ทัลของคุณได้ดังนี้
- เลือกแอปของฉันจากรายการแบบเลื่อนลงของผู้ใช้
- คลิกชื่อแอป
- คลิกลบที่มุมขวาบนของหน้า
ระบบจะลบและนำแอปออกจากรายการ "แอปของฉัน"