Basic terminology

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

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

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

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

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

Facade ที่มาจากพร็อกซี 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 ที่แอปได้รับอนุญาตให้ใช้

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

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

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

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

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

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

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

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

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

เวอร์ชันของอินเทอร์เฟซ API ที่นักพัฒนาแอปเห็น

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

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