คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
บทนำ
การสร้างรายได้ช่วยให้คุณมีความยืดหยุ่นในการออกเครดิตนักพัฒนาแอป
สําหรับนักพัฒนาแอปแบบชําระเงินล่วงหน้า เครดิตจะปรากฏเป็นการใช้งานที่ลดลง ซึ่งจะเพิ่มหรือลดยอดคงเหลือแบบชําระเงินล่วงหน้าของนักพัฒนาแอปนับจากนี้ไป เงินจะถอนออกจากยอดเติมเงินของนักพัฒนาซอฟต์แวร์เมื่อนักพัฒนาแอปซื้อแพ็กเกจผลิตภัณฑ์ API เช่นเดียวกับการใช้บัตรเดบิต นักพัฒนาแอปต้องรักษายอดคงเหลือที่เพียงพอสำหรับการซื้อ โปรดดูฉันจะคำนวณยอดคงเหลือในบัญชีแบบชำระเงินล่วงหน้าได้อย่างไร
สำหรับนักพัฒนาแอปแบบชําระเงินตามหลัง เครดิตจะปรากฏเป็นบรรทัดแยกต่างหากในใบแจ้งหนี้ ซึ่งจะลดการเรียกเก็บเงินในใบแจ้งหนี้
การสำรวจหน้าเครดิต
เข้าถึงและสำรวจหน้าเครดิตตามที่อธิบายไว้ด้านล่าง
Edge
วิธีเข้าถึงหน้าเครดิตโดยใช้ UI ของ Edge
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > เครดิตในแถบนําทางด้านซ้าย
หน้าเครดิตจะปรากฏขึ้น
ดังที่ไฮไลต์ไว้ในรูปภาพ หน้าเครดิตช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปสำหรับเครดิตทั้งหมด ซึ่งรวมถึงชื่อผู้รับ จํานวนเครดิต วันที่และเวลาที่เครดิตมีผล ชุดผลิตภัณฑ์ API และผลิตภัณฑ์ API ที่ใช้เครดิตได้ รวมถึงหมายเหตุที่เพิ่ม
- ออกเครดิต
- ค้นหารายการเครดิต
Edge แบบคลาสสิก (ระบบคลาวด์ส่วนตัว)
วิธีเข้าถึงหน้าเครดิตโดยใช้ UI ของ Edge แบบคลาสสิก
- ลงชื่อเข้าใช้
http://ms-ip:9000
โดยที่ ms-ip คือที่อยู่ IP หรือชื่อ DNS ของโหนดเซิร์ฟเวอร์การจัดการ - เลือกการสร้างรายได้ > รายงานการสร้างรายได้ในแถบนำทางด้านบน
หน้าเครดิตช่วยให้คุณทำสิ่งต่อไปนี้ได้
- ดูข้อมูลสรุปของเครดิตทั้งหมด ได้แก่ ชื่อผู้รับ จำนวนเครดิต วันที่และเวลาที่เครดิตมีผล แพ็กเกจผลิตภัณฑ์ 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
เครดิตจะใช้กับแพ็กเกจผลิตภัณฑ์ API payment
และแพ็กเกจราคา payment_standard_plan
ดูรายการพารามิเตอร์การค้นหาทั้งหมดที่ระบุได้ในคำขอเครดิตได้ที่พารามิเตอร์การค้นหาสำหรับ Credits 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" }
พารามิเตอร์การค้นหาสําหรับ Credits API
พารามิเตอร์การค้นหาต่อไปนี้ใช้ได้กับ API ของเครดิต
ชื่อ | คำอธิบาย | ค่าเริ่มต้น | จำเป็นหรือไม่ |
---|---|---|---|
billingMonth |
เดือนสำหรับการเรียกเก็บเงินที่มีการใช้เครดิต เช่น APRIL |
ไม่มี | ไม่ |
billingYear |
ปีการเรียกเก็บเงินที่ใช้เครดิต เช่น 2018 |
ไม่มี | ไม่ |
currencyId |
สกุลเงินที่ใช้สำหรับเครดิต ระบบจะกําหนดค่าสกุลเงินสําหรับแพ็กเกจราคาในแพ็กเกจผลิตภัณฑ์ API ที่นักพัฒนาแอปซื้อไว้และจะเปลี่ยนแปลงไม่ได้ |
ไม่มี | ใช่ |
developerId |
ชื่อนักพัฒนาแอปหรือบริษัทที่จะได้รับเครดิต |
ไม่มี | ใช่ |
productId |
ผลิตภัณฑ์ API ที่ใช้เครดิต หากคุณไม่ระบุรหัสผลิตภัณฑ์ ระบบจะใช้เครดิตกับผลิตภัณฑ์ API ทั้งหมดในแพ็กเกจผลิตภัณฑ์ API |
ไม่มี | ไม่ |
transactionAmount |
จำนวนเครดิต (ในสกุลเงินที่ระบุ) ระบุค่าบวกหรือลบ ค่าต้องไม่เป็น 0 |
ไม่มี | ใช่ |
transactionNote |
หมายเหตุที่อธิบายเหตุผลของการให้เครดิต |
ไม่มี | ใช่ |