คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เกริ่นนำ
การสร้างรายได้มอบความยืดหยุ่นให้คุณในการออกเครดิตนักพัฒนาแอป
สำหรับนักพัฒนาแอปแบบชำระเงินล่วงหน้า เครดิตจะปรากฏเป็นการลดการใช้งาน ซึ่งจะเพิ่มหรือลดยอดคงเหลือที่ชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์ได้ในอนาคต เงินจะถอนออกจากยอดคงเหลือที่ชำระล่วงหน้าของนักพัฒนาซอฟต์แวร์เมื่อซื้อแพ็กเกจผลิตภัณฑ์ API เช่นเดียวกับการใช้บัตรเดบิต นักพัฒนาแอปต้องรักษายอดเงินคงเหลือให้เพียงพอสำหรับการซื้อ โปรดดูฉันจะคำนวณยอดเงินคงเหลือของบัญชีชำระล่วงหน้าได้อย่างไร
สำหรับนักพัฒนาแอปแบบชำระเงินภายหลัง เครดิตจะปรากฏเป็นบรรทัดแยกต่างหากในใบแจ้งหนี้ ซึ่งเป็นการลดการเรียกเก็บเงินในใบแจ้งหนี้
การสำรวจหน้าเครดิต
เข้าถึงและสำรวจหน้าเครดิต ตามที่อธิบายไว้ด้านล่าง
Edge
วิธีเข้าถึงหน้าเครดิตโดยใช้ Edge UI
- ลงชื่อเข้าใช้ apigee.com/edge
- เลือกเผยแพร่ > การสร้างรายได้ > เครดิตในแถบนำทางด้านซ้าย
หน้าเครดิตจะปรากฏขึ้น
ตามที่ไฮไลต์ในรูป หน้าเครดิตจะช่วยให้คุณสามารถทำสิ่งต่อไปนี้
- ดูข้อมูลสรุปสำหรับเครดิตทั้งหมด ได้แก่ ชื่อผู้รับ จำนวนเครดิต วันที่และเวลาที่เครดิตมีผล แพ็กเกจผลิตภัณฑ์ API และผลิตภัณฑ์ API ที่ใช้เครดิต รวมถึงหมายเหตุที่เพิ่ม
- ออกเครดิต
- ค้นหารายการเครดิต
Classic Edge (Private Cloud)
วิธีเข้าถึงหน้าเครดิตโดยใช้ 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
:
ดูพารามิเตอร์การค้นหาสำหรับ 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 |
โปรดทราบว่าอธิบายเหตุผลของการได้เครดิต |
ไม่มีข้อมูล | มี |