คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่
เอกสารประกอบของ Apigee X info
บทนำ
การสร้างรายได้ช่วยให้คุณมีความยืดหยุ่นในการออกเครดิตให้นักพัฒนาแอป
สำหรับนักพัฒนาแอปแบบชำระเงินล่วงหน้า เครดิตจะปรากฏเป็นการลดการใช้งาน ซึ่งจะเพิ่มหรือลดยอดเติมเงินแบบชำระเงินล่วงหน้าของนักพัฒนาแอปในอนาคต ระบบจะหักเงินจากยอดเติมเงินของนักพัฒนาแอปเมื่อนักพัฒนาแอปซื้อแพ็กเกจผลิตภัณฑ์ API ซึ่งคล้ายกับการใช้บัตรเดบิต นักพัฒนาแอปต้องรักษายอดคงเหลือให้เพียงพอสำหรับการซื้อ ดูวิธีคำนวณยอดคงเหลือในบัญชีแบบชำระเงินล่วงหน้าที่เหลือ
สำหรับนักพัฒนาแอปแบบชำระเงินภายหลัง เครดิตจะปรากฏเป็น บรรทัดแยกต่างหากในใบแจ้งหนี้ ซึ่งจะลดการเรียกเก็บเงินในใบแจ้งหนี้
การสำรวจหน้าเครดิต
เข้าถึงและสำรวจหน้าเครดิตตามที่อธิบายไว้ด้านล่าง
Edge
วิธีเข้าถึงหน้าเครดิตโดยใช้ UI ของ Edge
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > เครดิต ในแถบนำทางด้านซ้าย
หน้าเครดิตจะปรากฏขึ้น

ตามที่ไฮไลต์ไว้ในรูปภาพ หน้าเครดิตช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของเครดิตทั้งหมด ซึ่งรวมถึงชื่อผู้รับ จำนวนเครดิต วันที่และเวลาที่เครดิตมีผล, แพ็กเกจผลิตภัณฑ์ API และผลิตภัณฑ์ API ที่ใช้เครดิตได้ รวมถึงหมายเหตุที่เพิ่ม
- ออกเครดิต
- ค้นหารายการเครดิต
Classic Edge (Private Cloud)
วิธีเข้าถึงหน้าเครดิตโดยใช้ UI ของ Classic Edge
- ลงชื่อเข้าใช้
http://ms-ip:9000โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนด Management Server - เลือกการสร้างรายได้ > รายงานการสร้างรายได้ ในแถบนำทางด้านบน
หน้าเครดิตช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของเครดิตทั้งหมด ซึ่งรวมถึงชื่อผู้รับ จำนวนเครดิต วันที่และเวลาที่เครดิตมีผล, แพ็กเกจผลิตภัณฑ์ API และผลิตภัณฑ์ API ที่ใช้เครดิตได้ รวมถึงหมายเหตุที่เพิ่ม
- ออกเครดิต
- ค้นหารายการเครดิต
การออกเครดิต
- เข้าถึงหน้าเครดิต
- คลิก + เครดิต
- ป้อนข้อมูลต่อไปนี้
ช่อง คำอธิบาย เดือนที่เรียกเก็บเงิน เดือนที่เรียกเก็บเงินซึ่งใช้เครดิตได้ เลือกเดือนจากรายการ
นักพัฒนาแอป ชื่อนักพัฒนาแอปหรือชื่อบริษัทที่ใช้เครดิตได้ ป้อนชื่อในกล่องข้อความ เมื่อคุณพิมพ์ รายการนักพัฒนาแอป/บริษัทที่มีสตริงจะแสดงในรายการแบบเลื่อนลง คลิกชื่อนักพัฒนาแอปหรือชื่อบริษัทจากรายการแบบเลื่อนลง
หมายเหตุ: หลังจากเลือกนักพัฒนาแอปหรือบริษัทแล้ว ระบบจะแสดงช่องที่เหลือ หากคุณเลือกบริษัทหรือนักพัฒนาแอปที่ยังไม่ยอมรับแพ็กเกจราคา คุณจะออกเครดิตไม่ได้
แพ็กเกจผลิตภัณฑ์ แพ็กเกจผลิตภัณฑ์ API ที่ใช้เครดิตได้ เลือกจากรายการแพ็กเกจผลิตภัณฑ์ API ที่มี
ผลิตภัณฑ์ ผลิตภัณฑ์ API ในแพ็กเกจผลิตภัณฑ์ API ที่เลือกซึ่งใช้เครดิตได้ เลือก ผลิตภัณฑ์ทั้งหมด หรือผลิตภัณฑ์ API รายการเดียวจากรายการ
สกุลเงิน สกุลเงินที่ใช้สำหรับเครดิต สกุลเงินจะได้รับการกำหนดค่าสำหรับแพ็กเกจราคาในแพ็กเกจผลิตภัณฑ์ API ที่ นักพัฒนาแอปซื้อ และจะเปลี่ยนแปลงไม่ได้ หากมีการกำหนดสกุลเงินหลายสกุลในแพ็กเกจราคา คุณสามารถเลือกสกุลเงินใดสกุลหนึ่งได้
จำนวนเงิน จำนวนเงินเครดิต (ในสกุลเงินที่ระบุ) ระบุค่าที่เป็นบวกหรือลบ ค่าต้องไม่เป็น 0
โน้ต หมายเหตุที่ไม่บังคับเพื่ออธิบายเหตุผลในการออกเครดิต
- คลิกบันทึกเครดิต
การออกเครดิตโดยใช้ API
การใช้ API จะออกเครดิตให้นักพัฒนาแอปเทียบกับแพ็กเกจผลิตภัณฑ์ API ทั้งหมด หรือ เทียบกับการใช้ผลิตภัณฑ์ API ที่เฉพาะเจาะจงในแพ็กเกจผลิตภัณฑ์ API
หากต้องการออกเครดิตโดยใช้ API ให้ส่งคำขอ POST ไปยัง
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions,
โดยที่ {package_id} และ {rate-plan_id} จะกำหนด
การระบุแพ็กเกจผลิตภัณฑ์ API และแพ็กเกจราคาที่ใช้เครดิตได้ตามลำดับ
เมื่อส่งคำขอ คุณต้องระบุพารามิเตอร์การค้นหาต่อไปนี้
- รหัสนักพัฒนาแอป (อีเมล) ที่ใช้เครดิตได้
- จำนวนเงินเครดิต
- สกุลเงินที่ใช้สำหรับเครดิต
- หมายเหตุที่อธิบายเหตุผลในการออกเครดิต
คุณระบุพารามิเตอร์การค้นหาเพิ่มเติมต่อไปนี้ได้ (ไม่บังคับ)
- เดือนที่เรียกเก็บเงินซึ่งใช้เครดิตได้ ค่านี้จะตั้งค่าเริ่มต้นเป็นเดือนปัจจุบัน
- ปีที่เรียกเก็บเงินซึ่งใช้เครดิตได้ ค่านี้จะตั้งค่าเริ่มต้นเป็นปีปัจจุบัน
- ผลิตภัณฑ์ API ที่ใช้เครดิตได้ หากคุณไม่ระบุรหัสผลิตภัณฑ์ API เครดิตจะใช้ได้กับผลิตภัณฑ์ API ทั้งหมดในแพ็กเกจผลิตภัณฑ์ API
ตัวอย่างเช่น คำขอต่อไปนี้จะออกเครดิต $100 สำหรับเดือนที่เรียกเก็บเงินในเดือนเมษายน 2018
ให้นักพัฒนาแอปที่ระบุเป็น dev1@myorg.com เครดิตจะใช้ได้กับ
payment แพ็กเกจผลิตภัณฑ์ API และ payment_standard_plan แพ็กเกจราคา:
ดูรายการพารามิเตอร์การค้นหาทั้งหมดที่คุณระบุในคำขอเครดิตได้ที่ พารามิเตอร์การค้นหาสำหรับ API เครดิต
$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password
ตัวอย่างต่อไปนี้แสดงตัวอย่างบางส่วนของคำตอบ
{ "currency" : "USD", "developer" : { "address" : [ { "address1" : "Dev One Address", ... } ], "approxTaxRate" : 0.0000, "billingType" : "PREPAID", "broker" : false, "developerRole" : [ ], "email" : "dev1@myorg.com", "hasSelfBilling" : false, "id" : "K4jW2QLjZ1h8GFA8", "legalName" : "DEV ONE", "name" : "Dev One", "organization" : { ... }, "registrationId" : "TestRegId", "status" : "ACTIVE", "type" : "TRUSTED" }, "endTime" : "2013-09-04 15:54:36", "environment" : "PROD", "euroExchangeRate" : 0.8107, "gbpExchangeRate" : 0.6860, "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "isVirtualCurrency" : false, "notes" : "Credit for failed transactions", "pkgId" : "myorg@@@payment", "pkgRatePlanProductName" : "Payment", "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde", "rate" : 100, "ratePlan" : { ... }, "status" : "ACTIVE", "virtualCurrency" : false }, "description" : "Standard Plan", "displayName" : "Standard Plan", … "monetizationPackage" : { "description" : "Payment", ... } ], ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Standard Plan", "organization" : { ... }, ... }, ... }, ... }, "revenueShareAmount" : 0, "startTime" : "2013-09-04 15:54:36", "status" : "SUCCESS", "taxModel" : "UNDISCLOSED", "txProviderStatus" : "SUCCESS", "type" : "CREDIT", "usdExchangeRate" : 1.0675, "utcEndTime" : "2013-09-04 15:54:36", "utcStartTime" : "2013-09-04 15:54:36" }
พารามิเตอร์การค้นหาสำหรับ API เครดิต
พารามิเตอร์การค้นหาต่อไปนี้พร้อมให้ใช้งานกับ API เครดิต
| ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
|---|---|---|---|
billingMonth |
เดือนที่เรียกเก็บเงินซึ่งใช้เครดิตได้ เช่น เมษายน |
ไม่มี | ไม่ |
billingYear |
ปีที่เรียกเก็บเงินซึ่งใช้เครดิตได้ เช่น 2018 |
ไม่มี | ไม่ |
currencyId |
สกุลเงินที่ใช้สำหรับเครดิต สกุลเงินจะได้รับการกำหนดค่าสำหรับแพ็กเกจราคาในแพ็กเกจผลิตภัณฑ์ API ที่ นักพัฒนาแอปซื้อ และจะเปลี่ยนแปลงไม่ได้ |
ไม่มี | ใช่ |
developerId |
ชื่อนักพัฒนาแอปหรือชื่อบริษัทที่ใช้เครดิตได้ |
ไม่มี | ใช่ |
productId |
ผลิตภัณฑ์ API ที่ใช้เครดิตได้ หากคุณไม่ระบุรหัสผลิตภัณฑ์ เครดิตจะใช้ได้กับผลิตภัณฑ์ API ทั้งหมดในแพ็กเกจผลิตภัณฑ์ API |
ไม่มี | ไม่ |
transactionAmount |
จำนวนเงินเครดิต (ในสกุลเงินที่ระบุ) ระบุค่าที่เป็นบวกหรือลบ ค่าต้องไม่เป็น 0 |
ไม่มี | ใช่ |
transactionNote |
หมายเหตุที่อธิบายเหตุผลในการออกเครดิต |
ไม่มี | ใช่ |