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

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

ลงทะเบียนแอปและจัดการคีย์ 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)

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

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

หน้าแอปของนักพัฒนาแอปจะปรากฏขึ้น

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

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

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

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

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

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

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

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

    		 ใช่
    URL ของ Callback โดยปกติจะระบุ URL ของแอปที่กำหนดให้รับรหัสการให้สิทธิ์ในนามของแอปไคลเอ็นต์ ค่านี้ไม่จำเป็นสำหรับผลิตภัณฑ์ API บางรายการ ไม่
    หมายเหตุ หมายเหตุอธิบายสำหรับแอป ไม่
  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 อีกครั้งได้ทุกเมื่อ

วิธีอนุมัติหรือเพิกถอนคีย์ 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 คุณสามารถนำคีย์ API ออกจากข้อมูลเข้าสู่ระบบที่เชื่อมโยงได้

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

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

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

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

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

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

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

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

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

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

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

การลบแอป

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

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

วิธีลบแอป

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

หมายเหตุ: ใน Apigee Edge for Public Cloud การลบแอปของนักพัฒนาแอปและอาร์ติแฟกต์ที่เชื่อมโยงจะเกิดขึ้นแบบไม่พร้อมกัน ระบบจะลบแอปของนักพัฒนาแอป ทันที แต่ทรัพยากรที่เชื่อมโยงกับแอปของนักพัฒนาแอปนั้น เช่น คีย์แอปหรือโทเค็นการเข้าถึง อาจใช้เวลาตั้งแต่ไม่กี่วินาทีถึงไม่กี่นาทีในการลบโดยอัตโนมัติ

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

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

ดูหัวข้อ นําเข้าคีย์และข้อมูลลับของผู้ใช้ที่มีอยู่ด้วย