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