อภิธานศัพท์

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

มีแนวคิดมากมายที่เป็นแนวคิดทั่วไปซึ่งมีความหมายเป็นเอกลักษณ์ใน Apigee

คำศัพท์	คำจำกัดความ
API	พร็อกซีที่ทำหน้าที่เป็นส่วนหน้าสำหรับ API ที่มีอยู่ โดยนักพัฒนาซอฟต์แวร์จะเริ่มเรียกใช้ API ใหม่ที่สร้างโดย Apigee แทนการเรียก API ที่มีอยู่ ส่วนหน้านี้จะแยกอินเทอร์เฟซสาธารณะออกจาก API แบ็กเอนด์เพื่อป้องกันไม่ให้นักพัฒนาซอฟต์แวร์เปลี่ยนแปลงแบ็กเอนด์ ขณะเดียวกันก็ช่วยให้คุณสร้างสรรค์สิ่งใหม่ๆ ได้อย่างเต็มที่โดยไม่ส่งผลกระทบต่อทีมพัฒนาภายใน เมื่อคุณทำการเปลี่ยนแปลงแบ็กเอนด์ นักพัฒนาแอปจะยังคงเรียกใช้ API เดียวกันต่อไปแบบไม่ขาดตอน ในสถานการณ์ขั้นสูงขึ้น Apigee คือให้คุณแสดงอินเทอร์เฟซหลายรายการไปยัง API เดียวกัน ทำให้คุณปรับแต่งลายเซ็นของ API ให้ตอบสนองความต้องการของนักพัฒนาซอฟต์แวร์เฉพาะกลุ่มได้ในเวลาเดียวกัน
เส้นทางฐานและทรัพยากร API	API ประกอบด้วยเส้นทางฐานและชุดทรัพยากร (หรือที่เรียกว่าเส้นทางทรัพยากร) สำหรับ API แต่ละรายการ คุณจะต้องกำหนด URL รูท 1 รายการและเส้นทางทรัพยากรหลายเส้นทาง อาจคิดว่า API เป็นชุด URI ก็ได้ ซึ่ง URL ทั้งหมดมีเส้นทางฐานร่วมกัน Apigee จะเสริม URI ดิบเหล่านี้ด้วยชื่อที่แสดงและคำอธิบายเพื่อให้จัดการ API ได้ง่ายขึ้น
ผู้บริโภค API	มีความหมายเหมือนกันกับ "นักพัฒนาแอป" ซึ่งใช้ API ที่สร้างโดยผู้ให้บริการ API
นักพัฒนา API	วิศวกรซอฟต์แวร์ในองค์กรผู้ให้บริการ API ที่สร้าง API โดยนักพัฒนาแอป (ผู้บริโภค API) จะใช้ API ดังกล่าวในการสร้างแอป
แพ็กเกจ API	คอลเล็กชันของผลิตภัณฑ์ API ที่แสดงต่อผู้ใช้เป็นกลุ่ม และมักเชื่อมโยงกับแพ็กเกจราคา
ผลิตภัณฑ์ API	คอลเล็กชันของทรัพยากร API (URI) รวมกับแพ็กเกจบริการและนำเสนอต่อนักพัฒนาซอฟต์แวร์เป็นกลุ่ม ผลิตภัณฑ์ API ยังอาจรวมข้อมูลเมตาที่เฉพาะเจาะจงสำหรับธุรกิจของคุณเพื่อการตรวจสอบหรือการวิเคราะห์ได้อีกด้วย คุณสามารถใช้ทรัพยากรอย่างน้อย 1 รายการเพื่อสร้างรายได้โดยการรวมทรัพยากรเหล่านั้นในผลิตภัณฑ์ API ซึ่งจะรวมอยู่ในแพ็กเกจ API สำหรับการสร้างรายได้
ผู้ให้บริการ API	ผู้ให้บริการ API สร้าง API (โดยใช้ Edge) เพื่อให้ผู้บริโภค API (นักพัฒนาแอป) ใช้งาน
นักพัฒนาแอป	ใน Edge นักพัฒนาแอปจะลงทะเบียนแอปกับผู้ให้บริการ API ซึ่งเป็นวิธีที่นักพัฒนาแอปได้รับคีย์ API ที่ต้องใช้เพื่อเรียกใช้พร็อกซี API ของผู้ให้บริการ
แอป	นักพัฒนาซอฟต์แวร์ของคุณใช้แอปเพื่อเข้าถึงทรัพยากรในผลิตภัณฑ์ API ของคุณ เมื่อสร้าง แอป คุณจะต้องเลือกผลิตภัณฑ์ API ที่จะรวม และ Apigee จะสร้างคีย์ แต่ละแอปมีคีย์เดียวที่ให้สิทธิ์เข้าถึงผลิตภัณฑ์ API หลายรายการ แอปจะช่วยให้คุณควบคุมได้ว่าจะให้ใครเข้าถึงทรัพยากรของคุณได้บ้าง คุณควบคุมผู้ที่มีสิทธิ์เข้าถึงผลิตภัณฑ์ API ได้โดยเพิกถอนและรีเฟรชคีย์ของแอป และคุณยังควบคุมการเข้าถึงกลุ่มทรัพยากรได้ด้วยการเพิกถอนหรือลบสิทธิ์เข้าถึงผลิตภัณฑ์ในแอป
รายละเอียดยอดคงเหลือ	สำหรับนักพัฒนาซอฟต์แวร์ที่ชำระเงินล่วงหน้า เงินคงเหลือในบัญชีของนักพัฒนาซอฟต์แวร์
การปรับเปลี่ยนแบบปิด	การปรับค่าใช้จ่ายที่ใช้กับเอกสารการเรียกเก็บเงินที่เผยแพร่แล้ว
เดือนที่ปิดการเรียกเก็บเงิน	ทั้งเดือนตามปฏิทินที่มีการเผยแพร่เอกสารการเรียกเก็บเงิน
ขีดจำกัดที่กำหนดเอง	ขีดจำกัด (เช่น ขีดจำกัดจำนวนธุรกรรมในผลิตภัณฑ์ API) ที่คุณตั้งค่าอย่างชัดแจ้งได้โดยใช้การสร้างรายได้ หรือเรียกว่าขีดจำกัดที่ชัดเจน
แพ็กเกจอัตราหมวดหมู่สำหรับนักพัฒนาซอฟต์แวร์	แพ็กเกจราคาที่ใช้กับนักพัฒนาแอปทุกรายในหมวดหมู่หนึ่งๆ และพร้อมให้ ซื้อได้โดยนักพัฒนาแอปทุกรายในหมวดหมู่นั้น
แพ็กเกจราคาสำหรับนักพัฒนาแอป	แพ็กเกจราคาที่ใช้กับนักพัฒนาแอปรายใดรายหนึ่งและพร้อมให้ซื้อโดยนักพัฒนาแอปรายนั้นเท่านั้น
ตัวแทนที่เปิดเผย	ตามกฎหมายเชิงพาณิชย์ บุคคลที่ได้รับอนุญาตให้ดำเนินการในนามของบุคคลอื่น (หรือที่เรียกว่าผู้มอบฉันทะ) ในการสร้างความสัมพันธ์ทางกฎหมายกับบุคคลที่สาม ในการสร้างรายได้ คุณอาจตั้งค่ารูปแบบภาษีสำหรับแผนรายได้ที่แชร์ เพื่อให้ผู้ให้บริการ API ทำหน้าที่เป็นตัวแทนที่เปิดเผยของนักพัฒนาซอฟต์แวร์ในการเก็บรายได้ (และอาจรวมถึงภาษีการขาย) ในนามของนักพัฒนาแอป
รูปแบบภาษีที่เปิดเผย	โมเดลภาษีที่ผู้ให้บริการ API ทำหน้าที่เป็นตัวแทนที่เปิดเผยของนักพัฒนาแอป
สภาพแวดล้อม	บริบทการดำเนินการรันไทม์สำหรับ API ต้องทำให้ API ใช้งานได้กับสภาพแวดล้อมก่อนจึงจะเข้าถึงขณะรันไทม์ได้ โดยค่าเริ่มต้น องค์กร Apigee จะได้รับการจัดสรรด้วยสภาพแวดล้อม 2 แบบ ได้แก่ "test" และ "prod" โดยทั่วไปแล้ว สภาพแวดล้อม "ทดสอบ" จะใช้สำหรับการทำให้ API อยู่ระหว่างการทดสอบใช้งานได้ โดยทั่วไป สภาพแวดล้อม "prod" จะใช้สำหรับการทำให้ API ใช้งานได้สำหรับการใช้งานจริง
รูปแบบภาษีแบบผสม	โมเดลภาษีที่ผู้ให้บริการ API ทำหน้าที่เป็นตัวแทนที่เปิดเผยของนักพัฒนาแอป อย่างไรก็ตาม ผู้ให้บริการ API จะจ่ายภาษีการขายที่รวบรวมจากผู้สมัครใช้บริการให้กับหน่วยงานด้านภาษีในท้องถิ่นในนามของนักพัฒนาแอป
ขีดจำกัดโดยนัย	ขีดจำกัด (เช่น ขีดจำกัดยอดเงินชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์) ที่กําหนดโดยการสร้างรายได้
การสร้างรายได้	คอมโพเนนต์ของ Apigee Edge Developer Services ที่ช่วยให้มีวิธีสร้างรายได้จากผลิตภัณฑ์ API ที่ใช้งานง่ายและยืดหยุ่น
จำนวนเงินที่ใช้ต่อเดือน	การใช้งานรวมของนักพัฒนาแอปในเดือนหนึ่งๆ ซึ่งประกอบด้วยค่าธรรมเนียมการตั้งค่า + ค่าธรรมเนียมธุรกรรม + ค่าธรรมเนียมที่เกิดซ้ำ
การชำระเงินรายเดือน	การชำระเงินตามรอบที่นักพัฒนาแอปชำระโดยอิงตามแพ็กเกจที่ซื้อ แพ็กเกจราคาอาจมีค่าธรรมเนียมที่เกิดซ้ำซึ่งเรียกเก็บจากนักพัฒนาแอปทุกเดือนโดยไม่คำนึงถึงการใช้งาน
ใบแจ้งยอดสุทธิ	เอกสารทางการเงินที่แสดงยอดคงเหลือสุทธิระหว่างใบแจ้งหนี้และใบแจ้งยอดส่วนแบ่งรายได้
การปรับแบบเปิด	การปรับค่าใช้จ่ายที่ยังไม่มีผลในเอกสารการเรียกเก็บเงินที่เผยแพร่แล้ว
เปิดเดือนสำหรับการเรียกเก็บเงิน	เดือนตามปฏิทินที่สมบูรณ์ซึ่งยังไม่ได้เผยแพร่เอกสารการเรียกเก็บเงิน "ขั้นสุดท้าย"
องค์กร	คอนเทนเนอร์สำหรับออบเจ็กต์ทั้งหมดในบัญชี Apigee รวมถึง API, ผลิตภัณฑ์ API, แพ็กเกจ API, แอป และนักพัฒนาซอฟต์แวร์ ต้องระบุบัญชีผู้ใช้สำหรับแต่ละองค์กรที่คุณอาจเป็นสมาชิก (ผู้ใช้ส่วนใหญ่จะมีบัญชีในองค์กรเดียวเท่านั้น) คุณต้องระบุข้อมูลเข้าสู่ระบบ (ชื่อผู้ใช้และรหัสผ่าน) และชื่อองค์กรพร้อมกับคำขอ API แต่ละรายการที่ส่ง
แคตตาล็อกแพ็กเกจ	รายการแพ็กเกจ API แพ็กเกจแต่ละรายการจะแสดงพร้อมกับผลิตภัณฑ์ API และแพ็กเกจราคา
ยอดเติมเงิน	จำนวนเงินที่นักพัฒนาแอปแบบชำระล่วงหน้ามีเพื่อชำระเงินล่วงหน้าสำหรับแพ็กเกจ API
นักพัฒนาแอปแบบชำระเงินล่วงหน้า	นักพัฒนาซอฟต์แวร์ที่ชำระเงินล่วงหน้าสำหรับการใช้ผลิตภัณฑ์ API ระบบจะหักเงินจากยอดคงเหลือของนักพัฒนาซอฟต์แวร์ที่ชำระล่วงหน้าเมื่อมีการใช้ผลิตภัณฑ์ API นักพัฒนาแอปต้องมียอดคงเหลือที่ชำระล่วงหน้าเพียงพอที่จะซื้อผลิตภัณฑ์ API ผู้ให้บริการ API ได้กำหนดสถานะการชำระเงินภายหลังหรือชำระเงินภายหลังให้แก่นักพัฒนาแอป
นโยบาย	ขั้นตอนการประมวลผลที่ดำเนินการเป็นหน่วยตรรกะระดับอะตอมที่นำมาใช้ใหม่ได้ภายในโฟลว์ API นโยบายทั่วไปจะรวมถึงการกำหนดเส้นทางคำขอไปยังปลายทางที่เหมาะสม การเปลี่ยนรูปแบบข้อความ การบังคับใช้การควบคุมการเข้าถึง การเรียกใช้บริการระยะไกลเพื่อขอข้อมูลเพิ่มเติม การมาสก์ข้อมูลที่ละเอียดอ่อนจากผู้ใช้ภายนอก การตรวจสอบเนื้อหาข้อความเพื่อหาภัยคุกคามที่อาจเกิดขึ้น การแคชคำตอบทั่วไปเพื่อปรับปรุงประสิทธิภาพ และอื่นๆ นโยบายอาจดำเนินการอย่างมีเงื่อนไขโดยอิงตามเนื้อหาหรือบริบทของคำขอหรือข้อความตอบกลับ เช่น อาจมีการใช้นโยบายการเปลี่ยนรูปแบบเพื่อปรับแต่งรูปแบบการตอบสนองหากข้อความคำขอส่งจากสมาร์ทโฟน
นักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลัง	นักพัฒนาซอฟต์แวร์ที่มีการเรียกเก็บเงินรายเดือน (ผ่านใบแจ้งหนี้) สำหรับการใช้ผลิตภัณฑ์ API นักพัฒนาแอปชำระเงินสำหรับการใช้ผลิตภัณฑ์ API ตามเงื่อนไขการชำระเงินที่กำหนดโดยแพ็กเกจ ในใบแจ้งหนี้ ผู้ให้บริการ API เป็นผู้กำหนดสถานะการชำระเงินภายหลังหรือชำระล่วงหน้าให้แก่นักพัฒนาแอป
จุดราคา	ช่วงของราคาที่เป็นไปได้ที่สินค้าบางอย่างอาจมีการตลาด
แพ็กเกจราคาบัตรราคา	แพ็กเกจราคาที่นักพัฒนาแอปถูกเรียกเก็บเงินในอัตราคงที่หรือแปรผันสำหรับธุรกรรมแต่ละรายการที่เกี่ยวข้องกับผลิตภัณฑ์ API ที่สร้างรายได้
แพ็กเกจราคา	ข้อกำหนดของค่าธรรมเนียม ค่าใช้จ่ายอื่นๆ และส่วนแบ่งรายได้สำหรับการใช้ผลิตภัณฑ์ API ที่นำเสนอในแพ็กเกจ API ที่สร้างรายได้
เส้นทางทรัพยากร	แนวคิด RESTful เส้นทางทรัพยากรคือทรัพยากรแบบเดียวกันที่ระบุ (URI) ที่ระบุเส้นทางเครือข่ายไปยังทรัพยากรที่ระบุ
แผนอัตราส่วนแบ่งรายได้	แพ็กเกจราคาที่มีการแชร์เปอร์เซ็นต์ของรายได้ที่เกิดจากธุรกรรมแต่ละรายการที่เกี่ยวข้องกับผลิตภัณฑ์ API ที่สร้างรายได้กับนักพัฒนาแอปที่ส่งคำขอ
ส่วนแบ่งรายได้และแผนบัตรราคา	แพ็กเกจราคาที่มีการแชร์เปอร์เซ็นต์ของรายได้ที่เกิดจากธุรกรรมแต่ละรายการที่เกี่ยวข้องกับผลิตภัณฑ์ API ที่สร้างรายได้กับนักพัฒนาแอปที่ส่งคำขอ นักพัฒนาซอฟต์แวร์ยังถูกเรียกเก็บค่าธรรมเนียมคงที่หรือเปลี่ยนแปลงได้สำหรับแต่ละธุรกรรมด้วย
ใบแจ้งหนี้ที่เรียกเก็บเงินด้วยตนเอง	เอกสารทางการเงินที่สร้างขึ้นแทนใบแจ้งยอดส่วนแบ่งรายได้ ซึ่งจะแสดงรายละเอียดจำนวนเงินที่ต้องชำระให้กับนักพัฒนาแอปและทำหน้าที่เป็นใบแจ้งหนี้ไปยังผู้ให้บริการ API ในนามของนักพัฒนาแอป
แพ็กเกจราคามาตรฐาน	แพ็กเกจราคาที่นักพัฒนาแอปทุกคนซื้อได้
tax	ภาษีทั้งหมดที่คิดจากการใช้งานและค่าธรรมเนียมของนักพัฒนาแอป
เติมเงิน	การดำเนินการโดยนักพัฒนาซอฟต์แวร์แบบชำระล่วงหน้าเพื่อเพิ่มเงินลงในยอดคงเหลือที่ชำระล่วงหน้า
นโยบายการบันทึกธุรกรรม	กลไกที่เปิดใช้การสร้างรายได้เพื่อบันทึกพารามิเตอร์ธุรกรรมและแอตทริบิวต์ที่กำหนดเอง การสร้างรายได้ต้องใช้ข้อมูลนี้ในการประมวลผลการสร้างรายได้ เช่น การใช้แพ็กเกจราคากับคำขอ API และการตอบกลับตามแอตทริบิวต์ที่กำหนดเองที่บันทึกไว้ในธุรกรรมแต่ละรายการ
ตัวแทนที่ไม่เปิดเผย	องค์กร (หรือผู้ให้บริการ) ที่มีส่วนร่วมในการจัดหาแอปพลิเคชันที่เกี่ยวข้อง โดยจะถือว่าเป็นการซื้อเนื้อหาในนามของนักพัฒนาแอป (เพื่อจุดประสงค์ด้านภาษีเท่านั้น) ในฐานะตัวแทนที่ไม่เปิดเผย องค์กร (หรือผู้ให้บริการ) สามารถเก็บรวบรวมและคิดภาษีที่ต้องชำระจากผู้ใช้ปลายทาง สถานะนี้เกี่ยวข้องกับวัตถุประสงค์ด้านภาษีเท่านั้น สถานะทางกฎหมายของนักพัฒนาแอปในซัพพลายเชนจะไม่ได้รับผลกระทบ
รูปแบบภาษีที่ไม่เปิดเผย	โมเดลภาษีที่ผู้ให้บริการ API หักภาษีที่เรียกเก็บจากผู้ใช้ปลายทางและจ่ายให้กับหน่วยงานด้านภาษีในท้องถิ่น
เวอร์ชัน	เวอร์ชันของอินเทอร์เฟซ API ที่นักพัฒนาแอปเห็น ตัวอย่างเช่น pivotaltracker.com/services/v3 หรือ api.enterprise.apigee.com/v1 (คำนี้จะแตกต่างจาก "การแก้ไข" ซึ่งเป็นแพ็กเกจการกำหนดค่าและนโยบายที่มีหมายเลขควบคุมเวอร์ชันต่างๆ ที่รวมอยู่ในพร็อกซี API สรุปคืออินเทอร์เฟซ API จะมีเวอร์ชัน ส่วนพร็อกซี API จะมีเวอร์ชันแก้ไข