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