ส่วนที่ 2: สร้างและทดสอบคีย์ API

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

เปลี่ยนโครงสร้างภายในและเปลี่ยนเส้นทางไปยังรักษาความปลอดภัย API โดยต้องใช้คีย์ API

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลเบื้องต้นเกี่ยวกับการเผยแพร่

ตารางต่อไปนี้ระบุคำศัพท์ที่ใช้ในการลงทะเบียนแอปและสร้างคีย์

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

ข้อกำหนดเบื้องต้นสำหรับบทแนะนำนี้

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

ขั้นตอนที่ 1: สร้างผลิตภัณฑ์ API

1. ใน UI การจัดการ ให้คลิกแท็บเผยแพร่ แล้วคลิกผลิตภัณฑ์
2. คลิก (+) ผลิตภัณฑ์
3. ป้อนหรือเลือกรายการต่อไปนี้ในกล่องโต้ตอบเพิ่มผลิตภัณฑ์

   ฟิลด์	ค่า
   ชื่อ	ผลิตภัณฑ์ API ฟรี
   ชื่อที่แสดง	ผลิตภัณฑ์ API ฟรี
   คำอธิบาย	ผลิตภัณฑ์ API ฟรี
   สภาพแวดล้อม	ทดสอบ
   การเข้าถึง	ภายในเท่านั้น
   ประเภทการอนุมัติคีย์	อัตโนมัติ (คีย์ API จะได้รับอนุมัติโดยอัตโนมัติหลังจากที่สร้างขึ้น)
   โควต้า	10 คำขอต่อ 1 ชั่วโมง (จํากัดจํานวนคําขอเป็น 10 รายการต่อชั่วโมง)
   ขอบเขต OAuth ที่อนุญาต	เว้นว่างไว้

   กล่องโต้ตอบที่กรอกมาควรมีลักษณะเช่นนี้

   

4. ในส่วนแหล่งข้อมูล ให้เลือกตัวเลือกต่อไปนี้
   • พร็อกซี API: weatherapikey
   • การแก้ไข: 1
   • เส้นทางทรัพยากร: /forecastrs**
     
     เส้นทางทรัพยากรจะระบุ URI ทรัพยากรที่ผลิตภัณฑ์อนุญาตให้แอปเข้าถึงได้ ในตัวอย่างนี้ แอปเข้าถึงได้เฉพาะทรัพยากร /forecastrss บนพร็อกซี weatherapikey ผ่านผลิตภัณฑ์ API นี้เท่านั้น ระบบจะไม่อนุญาตให้พยายามใช้ผลิตภัณฑ์ API นี้เพื่อเข้าถึงทรัพยากรอื่นบนพร็อกซี weatherapiproxy หรือบนพร็อกซีอื่น
     
     อนุญาตให้ใช้อักขระไวลด์การ์ดสำหรับเส้นทางทรัพยากร ไวลด์การ์ด "/**" จะระบุว่ารวม URI ย่อยทั้งหมดไว้ด้วย ซึ่งหมายถึงทรัพยากรในรูปแบบ /forecastrss/foo/bar ไวลด์การ์ด "/" จะระบุว่ารวม URI เพียง 1 ระดับเท่านั้น ดูข้อมูลเพิ่มเติมได้ที่สร้างผลิตภัณฑ์ API
     
     โปรดทราบว่ารายการแบบเลื่อนลงเส้นทางทรัพยากรจะแสดงโฟลว์แบบมีเงื่อนไขทั้งหมดที่กำหนดไว้ในพร็อกซี API ที่ระบุ ขั้นตอนแบบมีเงื่อนไขของพร็อกซี API จะกำหนดตรรกะหรือขั้นตอนการประมวลผลที่เชื่อมโยงกับเส้นทางทรัพยากร ผลิตภัณฑ์ API ควบคุมการเข้าถึงเส้นทางทรัพยากรเหล่านั้น
     
5. คลิกนำเข้าทรัพยากร ระบบจะเพิ่มเส้นทางทรัพยากร และจะเพิ่มพร็อกซี weatherapikey API ลงในส่วน พร็อกซี API สำหรับผลิตภัณฑ์โดยอัตโนมัติ
6. คลิกบันทึก ผลิตภัณฑ์ใหม่ของคุณจะแสดงในหน้าผลิตภัณฑ์

ดูข้อมูลเพิ่มเติม

• สร้างผลิตภัณฑ์ API

ขั้นตอนที่ 2: ลงทะเบียนนักพัฒนาแอป

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

1. ใน UI การจัดการ ให้คลิกแท็บเผยแพร่ จากนั้นคลิกนักพัฒนาซอฟต์แวร์
2. คลิก (+) นักพัฒนาซอฟต์แวร์
3. ในกล่องโต้ตอบ "นักพัฒนาซอฟต์แวร์ใหม่" ให้ป้อนค่าต่อไปนี้
   • ชื่อ: เจน
   • นามสกุล: บทแนะนำ
   • อีเมล: janetutorial@example.com
   • ชื่อผู้ใช้: jtutorial
4. คลิกบันทึก นักพัฒนาซอฟต์แวร์คนใหม่จะปรากฏในรายการนักพัฒนาซอฟต์แวร์ในหน้านักพัฒนาซอฟต์แวร์

ดูข้อมูลเพิ่มเติม

• การจัดการนักพัฒนาแอป

ขั้นตอนที่ 3: ลงทะเบียนแอป

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

1. ใน UI แพลตฟอร์ม API ให้คลิกแท็บเผยแพร่ จากนั้นคลิกแอปของนักพัฒนาซอฟต์แวร์
2. คลิก (+) แอปนักพัฒนาซอฟต์แวร์
3. ในกล่องโต้ตอบเพิ่มแอป ให้ป้อนค่าต่อไปนี้
   • ชื่อที่แสดง: แอปคีย์ API ของ Weather
   • นักพัฒนาซอฟต์แวร์: บทแนะนำของเจน (janetutorial@example.com)
   • URL เรียกกลับ: เว้นว่างไว้
4. เชื่อมโยงแอปกับผลิตภัณฑ์ ดังนี้
   1. ในส่วนผลิตภัณฑ์ ให้คลิก + ผลิตภัณฑ์
   2. เลือกผลิตภัณฑ์ API ฟรี
   3. คลิกไอคอนเครื่องหมายถูกเพื่อยอมรับการเปลี่ยนแปลง
5. คลิกบันทึก แอปใหม่จะปรากฏขึ้นในรายการแอปบนหน้าแอป สำหรับนักพัฒนาซอฟต์แวร์
6. เลือกแอปคีย์ API ของ Weather ในรายการแอป แล้วหน้ารายละเอียดของแอปจะเปิดขึ้น
7. เนื่องจากคุณเลือกประเภทการอนุมัติคีย์: อัตโนมัติเมื่อสร้างผลิตภัณฑ์ API คีย์ API จึงได้รับอนุมัติโดยอัตโนมัติและคุณดูคีย์ API ได้ทันที (หากเลือกประเภทการอนุมัติ: ด้วยตนเอง คุณจะต้องคลิกอนุมัติในคอลัมน์การดำเนินการสำหรับผลิตภัณฑ์ API ฟรี เพื่ออนุมัติคีย์ API)
8. ในส่วนผลิตภัณฑ์ถัดจากรายการผลิตภัณฑ์ API ฟรี ให้คลิกแสดงในคอลัมน์คีย์ผู้ใช้และข้อมูลลับของผู้ใช้เพื่อแสดงคีย์ที่สร้างขึ้น
   

   คีย์ผู้บริโภคเป็นอีกชื่อหนึ่งของคีย์ API และเป็นคีย์เดียวที่แอปจำเป็นต้องเข้าถึงทรัพยากรการคาดการณ์ผ่านพร็อกซี API ต้องมีข้อมูลลับของผู้บริโภค (พร้อมกับคีย์ผู้ใช้) ในการรักษาความปลอดภัยให้ API ผ่าน OAuth 2.0 เช่น OAuth 2.0: การกำหนดค่าพร็อกซี API ใหม่

ดูข้อมูลเพิ่มเติม

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

ขั้นตอนที่ 4: ใช้คีย์ API ในคำขอ

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

http://{org-name}-test.apigee.net/v1/weatherapikey/forecastrss?w=12797282&apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

แทนที่ชื่อองค์กร Apigee ของคุณด้วย {org-name} และค่า apikey ที่ถูกต้อง

มองหาเนื้อหาต่อไปนี้ในการตอบกลับ

<rss xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" version="2.0"> 
<channel> <title>Yahoo! Weather - Palo Alto, CA</title> 
<link>http://us.rd.yahoo.com/dailynews/rss/weather/Palo_Alto__CA/*http://weather.yahoo.com/forecast/USCA1093_f.html</link> 
<description>Yahoo! Weather for Palo Alto, CA</description> <language>en-us</language>

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

{"fault":{"faultstring":"Failed to resolve API Key variable null","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

ขั้นตอนที่ 5: ขั้นตอนถัดไป

เมื่อคุณส่งคำขอไปยัง API โดยใช้พารามิเตอร์การค้นหาเพื่อส่งคีย์ API แล้ว ให้แก้ไข API ให้ส่งคีย์เป็นส่วนหัว

ดำเนินการต่อที่หัวข้อรักษาความปลอดภัย API โดยการกำหนดให้ใช้คีย์ API