ผู้ใช้พอร์ทัลโต้ตอบกับพอร์ทัลของคุณอย่างไร

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

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

ส่วนต่อไปนี้จะอธิบายวิธีที่ผู้ใช้พอร์ทัลโต้ตอบกับพอร์ทัลของคุณ

ลงชื่อเข้าใช้พอร์ทัล

ส่วนต่อไปนี้จะอธิบายวิธีที่ผู้ใช้พอร์ทัลลงชื่อเข้าใช้พอร์ทัลที่ผสานรวมโดยใช้ข้อมูลเข้าสู่ระบบของผู้ใช้ (ผู้ให้บริการข้อมูลประจำตัวในตัว) หรือใช้ SAML (เบต้า)

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

ลงชื่อเข้าใช้พอร์ทัลโดยใช้ข้อมูลเข้าสู่ระบบของผู้ใช้ (ผู้ให้บริการข้อมูลประจำตัวในตัว)

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

• สร้างบัญชีผู้ใช้ในพอร์ทัลแบบผสานรวม
• ลงชื่อเข้าใช้พอร์ทัลแบบผสานรวม
• เปลี่ยนรหัสผ่าน

สร้างบัญชีผู้ใช้ในพอร์ทัลแบบผสานรวม

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

ผู้ใช้พอร์ทัลสร้างบัญชีผู้ใช้ในพอร์ทัลที่ผสานรวมได้โดยทำดังนี้

1. ไปที่พอร์ทัล

2. คลิกลงชื่อเข้าใช้

   หน้าลงชื่อเข้าใช้จะปรากฏขึ้น

3. คลิกสร้างบัญชี

   หน้าสร้างบัญชีจะปรากฏขึ้น

   

4. กรอกข้อมูลในแบบฟอร์มให้ครบถ้วน

   คุณต้องป้อนค่าสำหรับช่องที่ต้องกรอกทั้งหมด รหัสผ่านต้องมีอักขระอย่างน้อย 8 ตัว และต้องมีตัวเลข ตัวอักษรพิมพ์เล็ก ตัวอักษรพิมพ์ใหญ่ และสัญลักษณ์พิเศษ อย่างละ 1 ตัวเป็นอย่างน้อย

5. อ่านและยอมรับข้อกำหนด

6. คลิกสร้างบัญชี

7. กรอกแบบฟอร์ม CAPTCHA แล้วคลิกยืนยัน (หากแสดง)

   ระบบจะสร้างบัญชีผู้ใช้และส่งอีเมลยืนยัน

8. ภายใน 10 นาที ให้คลิกลิงก์ในอีเมลยืนยันเพื่อดำเนินการลงทะเบียนให้เสร็จสมบูรณ์

   หากไม่คลิกลิงก์ภายใน 10 นาที คุณจะต้องทำตามขั้นตอนในกระบวนการนี้อีกครั้งเพื่อสร้างบัญชีและรับข้อความแจ้งอีกครั้ง

9. ลงชื่อเข้าใช้พอร์ทัลที่ผสานรวม (อธิบายไว้ด้านล่าง)

ลงชื่อเข้าใช้พอร์ทัลแบบผสานรวม

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

ผู้ใช้พอร์ทัลลงชื่อเข้าใช้ดังนี้

1. ไปที่พอร์ทัล
2. คลิกลงชื่อเข้าใช้ หน้าลงชื่อเข้าใช้จะแสดงข้อมูลต่อไปนี้
3. ป้อนอีเมลและรหัสผ่าน
4. คลิกลงชื่อเข้าใช้

เปลี่ยนรหัสผ่าน

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

1. ไปที่พอร์ทัล
2. คลิกลงชื่อเข้าใช้
3. คลิกรีเซ็ตรหัสผ่าน
4. ป้อนอีเมลของบัญชีที่จะรีเซ็ต

5. คลิกส่งลิงก์รีเซ็ตรหัสผ่าน

   ระบบจะส่งลิงก์รีเซ็ตรหัสผ่านไปยังอีเมล

6. คลิกลิงก์ในอีเมลยืนยัน

7. ป้อนรหัสผ่านใหม่และยืนยัน

   รหัสผ่านต้องมีอักขระอย่างน้อย 8 ตัว และต้องมีตัวเลข ตัวอักษรพิมพ์เล็ก ตัวอักษรพิมพ์ใหญ่ และสัญลักษณ์พิเศษ อย่างละ 1 ตัวเป็นอย่างน้อย

8. คลิกสร้างรหัสผ่านใหม่

ลงชื่อเข้าใช้พอร์ทัลโดยใช้การตรวจสอบสิทธิ์ SAML (เบต้า)

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

1. ไปที่พอร์ทัล
2. คลิกลงชื่อเข้าใช้

3. คลิก login with SAML

   ระบบจะเปลี่ยนเส้นทางคุณไปยังผู้ให้บริการ SAML

4. หากได้รับข้อความแจ้ง ให้ป้อนข้อมูลเข้าสู่ระบบสำหรับผู้ให้บริการข้อมูลประจำตัว SAML

ดูเอกสารอ้างอิง API

ผู้ใช้พอร์ทัลจะดูเอกสารอ้างอิง API ที่คุณเผยแพร่ไปยังพอร์ทัลได้โดยทำดังนี้

1. ไปที่พอร์ทัล

2. คลิก API ในแถบนำทางด้านบน หน้า API จะปรากฏขึ้น ตัวอย่าง
   
   

3. กรองรายการ API ตามหมวดหมู่ ชื่อ หรือคำอธิบาย หากต้องการ โดยใช้เครื่องมือในแผงด้านซ้าย

4. คลิกการ์ด API เพื่อดูเอกสารอ้างอิง API ระบบจะแสดงเอกสารอ้างอิง API

ผู้ใช้พอร์ทัลสามารถดูข้อมูลและลองใช้ API หรือดาวน์โหลดเอกสารที่ใช้ในการแสดงผลเอกสารอ้างอิง API ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีแสดงผลเอกสารอ้างอิง API ได้ที่เผยแพร่ API

แชร์ความรับผิดชอบสำหรับแอปโดยใช้ทีมของนักพัฒนาแอป (เบต้า)

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

เกี่ยวกับบทบาทของทีมนักพัฒนาแอป

ตารางต่อไปนี้สรุปบทบาทที่กำหนดให้กับสมาชิกในทีมพัฒนาได้

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

ดูหน้าทีม

หน้าทีมจะแสดงทีมของนักพัฒนาแอปที่คุณเป็นสมาชิก

วิธีเข้าถึงหน้าทีม

1. ลงชื่อเข้าใช้พอร์ทัล
2. เลือกทีมจากเมนูแบบเลื่อนลงบัญชีผู้ใช้ในพอร์ทัล

หน้าทีมจะแสดงขึ้นเพื่อให้คุณทำสิ่งต่อไปนี้ได้

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

เพิ่มทีมพัฒนาแอป

วิธีเพิ่มทีมพัฒนาแอป

1. ลงชื่อเข้าใช้พอร์ทัล
2. เลือกทีมจากเมนูแบบเลื่อนลงบัญชีผู้ใช้ในพอร์ทัล
3. คลิก + ทีมใหม่
4. ใส่ชื่อและคำอธิบาย

5. หากต้องการเพิ่มสมาชิกในทีมพัฒนาแอป ให้คลิก + เพิ่มสมาชิกอีกคน ป้อนอีเมลของผู้ใช้พอร์ทัล แล้วเลือกบทบาทในทีมพัฒนาแอป

   ทำซ้ำเพื่อเพิ่มสมาชิกรายอื่นๆ

6. หากต้องการลบสมาชิกออกจากทีมพัฒนาแอป ให้คลิก ข้างสมาชิกในทีมพัฒนาแอปที่ต้องการลบ

7. คลิกสร้าง

แก้ไขการเป็นสมาชิกและบทบาทของทีมพัฒนาแอป

วิธีแก้ไขการเป็นสมาชิกและบทบาทของทีมพัฒนาแอป

1. ลงชื่อเข้าใช้พอร์ทัล
2. เลือกทีมจากเมนูแบบเลื่อนลงบัญชีผู้ใช้ในพอร์ทัล
3. คลิกแถวของทีมพัฒนาแอปที่คุณต้องการแก้ไขและคุณเป็นเจ้าของ

4. ทำตามขั้นตอนต่อไปนี้อย่างน้อย 1 ขั้นตอน

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

5. คลิกบันทึก

นำตัวเองออกจากทีมพัฒนาแอป

วิธีนำตัวเองออกจากทีมพัฒนาแอป

1. ลงชื่อเข้าใช้พอร์ทัล
2. เลือกทีมจากเมนูแบบเลื่อนลงบัญชีผู้ใช้ในพอร์ทัล
3. คลิกในแถวของทีมพัฒนาแอปที่คุณต้องการนำตัวเองออก
4. คลิกออกจากทีม

ลบทีมพัฒนาแอป

วิธีลบทีมพัฒนาแอป

1. ลงชื่อเข้าใช้พอร์ทัล
2. เลือกทีมจากเมนูแบบเลื่อนลงบัญชีผู้ใช้ในพอร์ทัล
3. คลิกในแถวของทีมพัฒนาแอปที่ต้องการลบ
4. คลิก
5. คลิกยืนยันเพื่อยืนยันการลบ

ลงทะเบียนแอป

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

ลงทะเบียนแอปนักพัฒนาแอป

ผู้ใช้พอร์ทัลสามารถลงทะเบียนแอปเพื่อใช้ API ที่คุณเผยแพร่ได้ โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิก + แอปใหม่เพื่อสร้างแอปใหม่
3. ป้อนชื่อและคำอธิบายสำหรับแอปในกล่องโต้ตอบ "แอปใหม่"

4. เลือกเจ้าของแอปในรายการแบบเลื่อนลงเจ้าของ

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

5. ในส่วนแคตตาล็อก API ให้เลือก API อย่างน้อย 1 รายการ

   API ในแคตตาล็อกจะจัดหมวดหมู่เป็น API ที่ต้องมีการตรวจสอบสิทธิ์ ซึ่งต้องใช้ URL เรียกกลับ หรือ API สาธารณะ คุณต้องเลือก API อย่างน้อย 1 รายการเพื่อสร้างแอป

6. หากเลือก API ในส่วน API ที่ตรวจสอบสิทธิ์แล้ว ให้ป้อน URL เรียกกลับ

   ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับ URL เรียกกลับ

7. คลิกสร้าง

ลงทะเบียนแอปของทีมพัฒนาแอป

สมาชิกในทีมนักพัฒนาแอปสามารถลงทะเบียนแอปสำหรับทีมนักพัฒนาแอปเพื่อใช้ API ที่คุณเผยแพร่ได้ตามที่อธิบายไว้ด้านล่าง

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธี

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

วิธีลงทะเบียนแอปของทีมนักพัฒนาแอป

1. เลือกทีมจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแถวของทีมพัฒนาแอปที่คุณต้องการลงทะเบียน
3. คลิก + แอปใหม่เพื่อสร้างแอปใหม่
4. ป้อนชื่อและคำอธิบายสำหรับแอปในกล่องโต้ตอบ "แอปใหม่"

5. เลือกเจ้าของแอปในรายการแบบเลื่อนลงเจ้าของ

   โดยค่าเริ่มต้น ทีมพัฒนาแอปจะเป็นเจ้าของแอป หากต้องการ ให้เลือกทีมพัฒนาแอปอื่นหรือเลือกตัวคุณเองเป็นเจ้าของจากเมนูแบบเลื่อนลง

6. ในส่วนแคตตาล็อก API ให้เลือก API อย่างน้อย 1 รายการ

   API ในแคตตาล็อกจะจัดหมวดหมู่เป็น API ที่ต้องมีการตรวจสอบสิทธิ์ ซึ่งต้องใช้ URL เรียกกลับ หรือ API สาธารณะ คุณต้องเลือก API อย่างน้อย 1 รายการเพื่อสร้างแอป

7. หากเลือก API ในส่วน API ที่ตรวจสอบสิทธิ์แล้ว ให้ป้อน URL เรียกกลับ

   ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับ URL เรียกกลับ

8. คลิกสร้าง

จัดการ API ในแอป

ในฐานะผู้ผลิต API คุณจะเผยแพร่ API เพื่อให้ผู้ใช้พอร์ทัลใช้ผลิตภัณฑ์ API ของคุณได้

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

ผู้ใช้พอร์ทัลสามารถจัดการ API ในแอปจากพอร์ทัลของคุณได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแอปในรายการ
3. ในส่วน API ให้คลิก หรือ เพื่อเปิดหรือปิดใช้การเข้าถึง API จากแอปตามลำดับ
4. สำหรับ API ที่ผ่านการตรวจสอบสิทธิ์ ให้เพิ่มหรือแก้ไข URL เรียกกลับตามที่จำเป็น

ดูคีย์ API และข้อมูลลับของแอป

ผู้ใช้พอร์ทัลสามารถจัดการคีย์ API สำหรับแอปจากพอร์ทัลได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแอปในรายการ
3. ดูคีย์ API ในส่วนคีย์ API
4. ตรวจสอบว่าสถานะของคีย์ API เป็น "ใช้งานอยู่" หากคีย์ API ของคุณต้องได้รับการอนุมัติและยังไม่ได้รับอนุมัติ สถานะจะแสดงเป็นรออนุมัติ
5. คลิกแสดงข้อมูลลับเพื่อดูข้อมูลลับ
6. วางเคอร์เซอร์เหนือคีย์ API หรือข้อมูลลับ แล้วคลิก เพื่อคัดลอกไปยังคลิปบอร์ด

หมุนเวียนคีย์ API สำหรับแอป

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

ผู้ใช้พอร์ทัลสามารถหมุนเวียนคีย์ API สำหรับแอปจากพอร์ทัลได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแอปในรายการ
3. ในส่วนคีย์ API ให้คลิกเพิ่มคีย์
4. คลิกยืนยันในกล่องโต้ตอบเพื่อยืนยันการดำเนินการ
5. ไม่บังคับ เพิกถอนคีย์ API เก่าตามที่อธิบายไว้ด้านล่าง

เพิกถอนคีย์ API สำหรับแอป

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

ผู้ใช้พอร์ทัลสามารถเพิกถอนคีย์ API สำหรับแอปจากพอร์ทัลของคุณได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกชื่อแอป
3. ในส่วนคีย์ API ให้คลิก ในคอลัมน์การดำเนินการที่เชื่อมโยงกับคีย์ API ที่ต้องการเพิกถอน

4. คลิกยืนยันเพื่อยืนยันการดำเนินการ

   ระบบจะอัปเดตสถานะของคีย์เป็น "ถูกเพิกถอน"

แก้ไขรายละเอียดแอป

ผู้ใช้ Portal สามารถแก้ไขรายละเอียดแอปได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแอปในรายการ
3. แก้ไขช่องชื่อหรือคำอธิบายในแท็บรายละเอียดแอป
4. จัดการ API ในแอปตามที่จำเป็น
5. คลิกบันทึก

ลบแอป

ผู้ใช้พอร์ทัลสามารถลบแอปออกจากพอร์ทัลของคุณได้โดยทำดังนี้

1. เลือกแอปจากเมนูแบบเลื่อนลงของบัญชีผู้ใช้
2. คลิกแอปในรายการ
3. คลิกลบ
4. คลิกยืนยันเพื่อยืนยันการดำเนินการ

ระบบจะลบแอปและนำออกจากรายการแอป