Basic terminology

Application Programming Interface - อินเทอร์เฟซที่ช่วยให้การใช้ความสามารถหรือข้อมูลจากแอปพลิเคชันอื่นเป็นเรื่องง่าย

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

Apigee มีข้อมูลมากมายเกี่ยวกับ API และแนวทางปฏิบัติแนะนำสำหรับการพัฒนาและการใช้ API หากต้องการเริ่มต้นใช้งาน โปรดดูเว็บแคสต์การออกแบบ API หรือดาวน์โหลด eBook ฟรี การออกแบบ Web API: แนวทางปฏิบัติแนะนำที่ขาดหายไปในการสร้างอินเทอร์เฟซที่นักพัฒนาซอฟต์แวร์ชื่นชอบ

หน้าเว็บใน Edge สำหรับ API, บริการ HTTP ทั่วไป หรือแอปพลิเคชันอย่างน้อย 1 รายการ (เช่น Node.js)

พร็อกซี API ติดตั้งใช้งานเป็นชุดไฟล์การกําหนดค่า นโยบาย และโค้ดที่อาศัยชุดทรัพยากรที่ Apigee Edge มีให้ คุณสามารถสร้างและกําหนดค่าพร็อกซี API โดยใช้ UI การจัดการ Apigee Edge หรือติดตั้งใช้งานในเครื่องในเครื่องมือแก้ไขข้อความหรือ IDE

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

API ที่กําหนดโดยที่อยู่เครือข่ายและ URI API ประกอบด้วย เส้นทางฐานและชุดทรัพยากร API พารามิเตอร์พร็อกซี API ทุกรายการจะกําหนดเส้นทางฐานและเส้นทางทรัพยากร API หลายเส้นทาง (ไม่บังคับ) คุณอาจคิดว่า API เป็นชุด URI ทั้งหมดที่ใช้เส้นทางฐานเดียวกัน

Apigee จะเพิ่มชื่อที่แสดงและคําอธิบายลงใน URI ดิบเหล่านี้เพื่อให้จัดการ API ได้ง่ายขึ้น Edge ให้คุณแนบนโยบายและโค้ดกับ URI ได้ ซึ่งช่วยให้คุณควบคุมและจัดการลักษณะการทํางานของ API ได้อย่างละเอียด

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

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

อักษรย่อของแอปพลิเคชัน คําว่า แอป หมายถึงแอปพลิเคชันบนอุปกรณ์เคลื่อนที่ที่ใช้ API นักพัฒนาแอปใช้แอปในภาษาโปรแกรมที่หลากหลาย รวมถึงใช้เทคโนโลยีและแพลตฟอร์มต่างๆ นักพัฒนาแอปที่ต้องการใช้ API จะลงทะเบียนแอปในองค์กรของผู้ให้บริการ API ใน Apigee Edge

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

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

• โดยทั่วไปแล้ว สภาพแวดล้อมทดสอบจะใช้เพื่อติดตั้งใช้งานพร็อกซี API ในระหว่างการพัฒนา
• โดยทั่วไปแล้ว สภาพแวดล้อม prod จะใช้เพื่อโปรโมตพร็อกซี API จากสภาพแวดล้อมการทดสอบหลังจากที่พัฒนาและทดสอบอย่างสมบูรณ์แล้ว

คอนเทนเนอร์สําหรับออบเจ็กต์ทั้งหมดในบัญชี Apigee Edge ซึ่งรวมถึงพร็อกซี API, ผลิตภัณฑ์ API, แพ็กเกจ API, แอป และผู้พัฒนาแอป

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

ขั้นตอนการประมวลผลที่ทำงานเป็นหน่วยตรรกะแบบอะตอมที่ใช้ซ้ำได้ภายในขั้นตอนการประมวลผลพร็อกซี API

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

ระบบอาจเรียกใช้นโยบายแบบมีเงื่อนไขตามเนื้อหาหรือบริบทของคำขอหรือข้อความตอบกลับ ตัวอย่างเช่น ระบบอาจใช้นโยบายการเปลี่ยนรูปแบบเพื่อปรับแต่งรูปแบบการตอบกลับหากข้อความคําขอส่งมาจากสมาร์ทโฟน

เวอร์ชันของอินเทอร์เฟซ API ที่แสดงต่อนักพัฒนาซอฟต์แวร์

เช่น pivotaltracker.com/services/v3 หรือ api.enterprise.apigee.com/v1

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