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

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

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

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

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

Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)

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

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

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

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

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

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

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

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

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

    หมายเหตุ: 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

  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. (ไม่บังคับ) เพิกถอนคีย์ 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 ด้วย

ดูข้อมูลเพิ่มเติมได้ที่นําเข้าคีย์และข้อมูลลับของผู้บริโภคที่มีอยู่