ลงทะเบียนแอปและจัดการคีย์ API

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

ลงทะเบียนแอปและจัดการคีย์ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

เกริ่นนำ

การลงทะเบียนแอปมีกลไกหลักในการควบคุมผู้ที่เข้าถึง API ของคุณได้

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

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

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

ส่วนต่อไปนี้อธิบายวิธีลงทะเบียนแอปและจัดการคีย์ API โดยใช้ UI และ API

การสำรวจหน้าแอป

เข้าถึงและสำรวจหน้าแอปตามที่อธิบายไว้ด้านล่าง

Edge

วิธีเข้าถึงหน้าแอปโดยใช้ Edge UI

  1. ลงชื่อเข้าใช้ apigee.com/edge
  2. เลือกเผยแพร่ > แอปในแถบนำทางด้านซ้าย

หน้าแอปจะปรากฏขึ้น

ตามที่ไฮไลต์ในรูป หน้าแอปช่วยให้คุณทำสิ่งต่อไปนี้ได้

Classic Edge (Private Cloud)

วิธีเข้าถึงหน้าแอปโดยใช้ UI แบบคลาสสิกของ Edge

  1. ลงชื่อเข้าใช้ http://ms-ip:9000 โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ
  2. เลือกเผยแพร่ > แอปของนักพัฒนาซอฟต์แวร์ในแถบนำทางด้านบน

หน้าแอปของนักพัฒนาซอฟต์แวร์จะปรากฏขึ้น

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

คุณลงทะเบียนแอปได้โดยใช้วิธีใดวิธีหนึ่งต่อไปนี้

ระบบจะเพิ่มแอปที่ลงทะเบียนแล้วไปยัง

วิธีลงทะเบียนแอปใน Edge

  1. เข้าถึงหน้าแอป
  2. คลิก + แอป
  3. ระบุรายละเอียดแอป
    ฟิลด์ คำอธิบาย จำเป็นหรือไม่
    ชื่อ ชื่อแอป คุณจะเปลี่ยนชื่อไม่ได้เมื่อสร้างแอปแล้ว ชื่อนี้จะใช้ในการเรียก Management API ใช่
    ชื่อที่แสดง ชื่อที่แสดงของแอปที่ปรากฏใน UI การจัดการ Edge และพอร์ทัลนักพัฒนาซอฟต์แวร์ ไม่ได้
    บริษัท/ผู้พัฒนา

    หมายเหตุ: Apigee แบบผสมไม่รองรับแอปของบริษัท ช่องนี้ใช้ไม่ได้

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

    		 ใช่
    URL โค้ดเรียกกลับ โดยปกติแล้วจะระบุ URL ของแอปที่กำหนดให้รับรหัสการให้สิทธิ์ในนามของแอปไคลเอ็นต์ ผลิตภัณฑ์ API ทั้งหมดไม่จำเป็นต้องระบุค่านี้ ไม่ได้
    Notes โน้ตอธิบายสำหรับแอป ไม่ได้
  4. ระบุข้อมูลเข้าสู่ระบบ รวมถึงวันหมดอายุและสถานะของคีย์ API และผลิตภัณฑ์ API ที่เกี่ยวข้อง
    ในส่วนข้อมูลเข้าสู่ระบบ ให้คลิก แล้วป้อนข้อมูลต่อไปนี้
    ฟิลด์ คำอธิบาย
    วันหมดอายุ กำหนดค่าระยะเวลาหรือวันที่หมดอายุ หรือตั้งค่าคีย์ API ไม่ให้หมดอายุ แล้วคลิกตกลง
    ผลิตภัณฑ์ เชื่อมโยงผลิตภัณฑ์ API อย่างน้อย 1 รายการกับคีย์ API ดังนี้
    1. คลิกเพิ่มผลิตภัณฑ์
    2. เลือกผลิตภัณฑ์ API อย่างน้อย 1 รายการจากรายการ
    3. คลิกเพิ่ม
    4. กำหนดสถานะเป็น "อนุมัติ" หรือ "เพิกถอน" สำหรับผลิตภัณฑ์ API แต่ละรายการ
    5. ทำตามขั้นตอนซ้ำเพื่อเพิ่มผลิตภัณฑ์ API อื่นๆ
  5. ระบุแอตทริบิวต์ที่กำหนดเอง ดังนี้
    1. ในส่วนแอตทริบิวต์ที่กำหนดเอง ให้คลิก
    2. ป้อนชื่อและค่า
    3. คลิกเพิ่มหรือเพิ่มและเริ่มรายการอื่น
      คุณเพิ่มแอตทริบิวต์ที่กำหนดเองได้สูงสุด 18 รายการ
  6. คลิกสร้าง

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

การดูแอปที่ลงทะเบียนสำหรับนักพัฒนาซอฟต์แวร์

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

การดูและแก้ไขแอป

วิธีดูและแก้ไขแอป

  1. เข้าถึงหน้าแอป
  2. คลิกในแถวของแอปที่ต้องการดูและแก้ไข
    รายละเอียดแอปจะปรากฏขึ้น
  3. หากต้องการแก้ไขแอป ให้คลิกแก้ไข
  4. ทำงานต่อไปนี้อย่างน้อย 1 อย่าง
  5. คลิกบันทึก

การจัดการข้อมูลเข้าสู่ระบบ

เมื่อแก้ไขแอป คุณสามารถจัดการข้อมูลเข้าสู่ระบบของแอปได้ในส่วนข้อมูลเข้าสู่ระบบ ดังที่แสดงในรูปภาพต่อไปนี้

ตามที่ไฮไลต์ในรูปก่อนหน้านี้ ในส่วนข้อมูลเข้าสู่ระบบ คุณสามารถทำงานต่อไปนี้โดยใช้ UI

หากต้องการใช้ API เพื่อจัดการข้อมูลเข้าสู่ระบบ โปรดดูหัวข้อต่อไปนี้

การดูคีย์ API และข้อมูลลับ

วิธีดูคีย์ API และข้อมูลลับ

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

การอนุมัติหรือเพิกถอนคีย์ API

โดยปกติแล้วการเรียก API ไปยังพร็อกซี API จะต้องใช้คีย์ API Edge อนุญาตให้เรียกก็ต่อเมื่อคีย์ API ได้รับอนุมัติ ใช้งานได้ และเป็นไปตามเงื่อนไขที่กำหนดโดยผลิตภัณฑ์ API ที่มี API ดังกล่าว

คุณกำหนดค่าผลิตภัณฑ์ API เพื่อให้อนุมัติคีย์ API โดยอัตโนมัติได้ตามที่อธิบายไว้ในจัดการผลิตภัณฑ์ API อย่างไรก็ตาม หากผลิตภัณฑ์ API ต้องอนุมัติคีย์ API ด้วยตนเอง คุณจะต้องอนุมัติคีย์ด้วยตนเอง

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

หากต้องการอนุมัติหรือเพิกถอนคีย์ API ให้ทำดังนี้

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

การจัดการผลิตภัณฑ์ API ในแอป

จัดการผลิตภัณฑ์ API ในแอปโดยดำเนินการต่อไปนี้

การเพิ่มผลิตภัณฑ์ API ลงในแอป

วิธีเพิ่มผลิตภัณฑ์ API ลงในแอป

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

การนำผลิตภัณฑ์ API ออกจากแอป

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

  1. เข้าถึงหน้าแอป
  2. คลิกในแถวของแอปที่ต้องการดูและแก้ไข
  3. คลิกแก้ไข
  4. คลิก ที่อยู่ติดกับผลิตภัณฑ์ API
  5. คลิกบันทึก

คุณจะเพิ่มผลิตภัณฑ์ที่นำออกไปแล้วอีกครั้งได้

การสร้างข้อมูลเข้าสู่ระบบใหม่

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

วิธีสร้างคีย์ API ใหม่

  1. เข้าถึงหน้าแอป
  2. คลิกในแถวของแอปที่ต้องการดูและแก้ไข
  3. คลิกแก้ไข
  4. ในส่วนข้อมูลเข้าสู่ระบบ ให้คลิก
  5. ระบุวันหมดอายุ เพิ่มผลิตภัณฑ์ API และตั้งค่าสถานะ
  6. (ไม่บังคับ) revokeคีย์ API อื่นๆ ได้ตามต้องการ
  7. คลิกบันทึก

การอนุมัติหรือเพิกถอนแอป

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

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

หากต้องการอนุมัติหรือเพิกถอนแอป ให้ทำดังนี้

  1. เข้าถึงหน้าแอป
  2. คลิกในแถวของแอปที่ต้องการดูและแก้ไข
  3. คลิกแก้ไข
  4. เลือกอนุมัติหรือเพิกถอนในช่องสถานะแอปเพื่ออนุมัติหรือเพิกถอนแอปตามลำดับ
  5. คลิกบันทึก

การลบแอป

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

หากคิดว่าต้องการคืนสิทธิให้แอปของนักพัฒนาซอฟต์แวร์ในอนาคต ทางเลือกอื่นนอกเหนือจากการลบคือการเพิกถอนแอป

วิธีลบแอป

  1. เข้าถึงหน้าแอป
  2. วางเคอร์เซอร์ในแถวของแอปที่ต้องการลบ
  3. คลิก ในคอลัมน์การดำเนินการ

หมายเหตุ: เมื่อใช้ Apigee Edge สำหรับระบบคลาวด์สาธารณะ การลบแอปนักพัฒนาซอฟต์แวร์และอาร์ติแฟกต์ที่เกี่ยวข้องจะเกิดขึ้นแบบไม่พร้อมกัน ระบบลบแอปนักพัฒนาซอฟต์แวร์ออกทันที แต่ทรัพยากรที่เชื่อมโยงกับแอปของนักพัฒนาซอฟต์แวร์ดังกล่าว เช่น คีย์แอปหรือโทเค็นเพื่อการเข้าถึง อาจใช้เวลา 2-3 วินาทีไปจนถึง 2-3 นาทีเพื่อลบโดยอัตโนมัติ

การลงทะเบียนแอปและการจัดการคีย์ API โดยใช้ API

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

โปรดดูเพิ่มเติมที่นำเข้าคีย์และข้อมูลลับของผู้ใช้ที่มีอยู่