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

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

พอร์ทัลนักพัฒนาซอฟต์แวร์ที่พร้อมใช้งานทันทีจะช่วยให้ผู้ใช้พอร์ทัลสามารถสร้างบัญชีผู้ใช้ ลงชื่อเข้าใช้ และจัดการแอปที่ใช้ 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 Identity Provider ผู้ใช้พอร์ทัลจะลงชื่อเข้าใช้พอร์ทัลที่ผสานรวมโดยใช้การตรวจสอบสิทธิ์ SAML ดังนี้

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

  3. คลิก login with SAML

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

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

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

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

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

  2. คลิก API ในแถบนำทางด้านบน หน้า 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 ในแคตตาล็อกจัดอยู่ในหมวดหมู่ Authenticated API ซึ่งต้องใช้ URL เรียกกลับหรือ API สาธารณะ คุณต้องเลือก API อย่างน้อย 1 รายการเพื่อสร้างแอป

  6. หากคุณเลือก API ในส่วน Authenticated API ให้ป้อน URL เรียกกลับ

    สำหรับข้อมูลเพิ่มเติม โปรดดูเกี่ยวกับ URL เรียกกลับ

  7. คลิกสร้าง

ลงทะเบียนแอปของทีมนักพัฒนาซอฟต์แวร์

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

หากต้องการทราบข้อมูลเพิ่มเติม ให้ทำดังนี้

วิธีลงทะเบียนแอปทีมนักพัฒนาซอฟต์แวร์

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

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

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

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

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

  7. หากคุณเลือก API ในส่วน Authenticated API ให้ป้อน URL เรียกกลับ

    สำหรับข้อมูลเพิ่มเติม โปรดดูเกี่ยวกับ URL เรียกกลับ

  8. คลิกสร้าง

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

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

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

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

  1. เลือกแอปจากรายการแบบเลื่อนลงของบัญชีผู้ใช้
  2. คลิกแอปในรายการ
  3. ในส่วน API ให้คลิก ไอคอนเปิดใช้งาน หรือ ไอคอนปิดใช้งาน เพื่อเปิดหรือปิดใช้การเข้าถึง API จากแอปตามลำดับ
  4. สำหรับ Authenticated 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 ให้คลิก Add Key
  4. คลิกยืนยันในกล่องโต้ตอบเพื่อยืนยันการดำเนินการ
  5. (ไม่บังคับ) เพิกถอนคีย์ API เก่าตามที่อธิบายไว้ด้านล่าง

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

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

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

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

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

    สถานะของคีย์จะอัปเดตเป็น "เพิกถอนแล้ว"

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

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

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

ลบแอป

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

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

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