Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Giới thiệu
Tính năng kiếm tiền giúp bạn linh hoạt trong việc cấp tín dụng cho nhà phát triển.
Đối với nhà phát triển trả trước, khoản tín dụng sẽ xuất hiện dưới dạng mức giảm trong mức sử dụng – điều này sẽ làm tăng hoặc giảm số dư trả trước của nhà phát triển trong tương lai. Tương tự như việc sử dụng thẻ ghi nợ, tiền sẽ được rút khỏi số dư trả trước của nhà phát triển khi nhà phát triển mua một gói sản phẩm API. Nhà phát triển phải duy trì số dư đủ dùng cho các giao dịch mua. Xem phần Làm cách nào để tính số dư tài khoản trả trước còn lại?
Đối với nhà phát triển trả sau, khoản tín dụng sẽ xuất hiện dưới dạng một dòng riêng trong hoá đơn, giúp giảm khoản phí trong hoá đơn.
Khám phá trang Credits
Truy cập và khám phá trang Thông tin ghi nhận theo mô tả dưới đây.
Edge
Cách truy cập vào trang Thông tin ghi công bằng giao diện người dùng Edge:
- Đăng nhập vào apigee.com/edge.
- Chọn Xuất bản > Kiếm tiền > Thông tin ghi công trong thanh điều hướng bên trái.
Trang Thông tin ghi công sẽ xuất hiện.

Như minh hoạ trong hình, trang Ghi công cho phép bạn:
- Xem thông tin tóm tắt về tất cả các khoản tín dụng, bao gồm cả tên người nhận, số tiền tín dụng, ngày và giờ có hiệu lực của khoản tín dụng, gói sản phẩm API và các sản phẩm API mà khoản tín dụng áp dụng, cũng như mọi ghi chú đã thêm
- Phát hành khoản tín dụng
- Tìm trong danh sách thông tin ghi công
Classic Edge (Private Cloud)
Cách truy cập vào trang Thông tin ghi nhận bản quyền bằng giao diện người dùng Edge phiên bản cũ:
- Đăng nhập vào
http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý. - Chọn Kiếm tiền > Báo cáo kiếm tiền trong thanh điều hướng trên cùng.
Trang tín dụng cho phép bạn:
- Xem thông tin tóm tắt về tất cả các khoản tín dụng, bao gồm cả tên người nhận, số tiền tín dụng, ngày và giờ có hiệu lực của khoản tín dụng, gói sản phẩm API và các sản phẩm API mà khoản tín dụng áp dụng, cũng như mọi ghi chú đã thêm
- Phát hành khoản tín dụng
- Tìm trong danh sách thông tin ghi công
Phát hành khoản tín dụng
- Truy cập vào trang Nội dung ghi nhận quyền tác giả.
- Nhấp vào + Credit (Nguồn tín dụng).
- Nhập thông tin dưới đây:
Trường Mô tả Tháng thanh toán Tháng lập hoá đơn mà khoản tín dụng được áp dụng. Chọn một tháng trong danh sách.
Nhà phát triển Tên nhà phát triển hoặc tên công ty được áp dụng khoản tín dụng. Nhập tên vào hộp văn bản. Khi bạn nhập, danh sách các nhà phát triển/công ty có chứa chuỗi đó sẽ xuất hiện trong một trình đơn thả xuống. Nhấp vào tên của nhà phát triển hoặc công ty trong danh sách thả xuống.
Lưu ý: Sau khi bạn chọn một nhà phát triển hoặc công ty, các trường còn lại sẽ xuất hiện. Nếu chọn một công ty hoặc nhà phát triển chưa chấp nhận kế hoạch giá, bạn sẽ không thể phát hành khoản tín dụng.
Gói sản phẩm Gói sản phẩm API mà khoản tín dụng áp dụng. Chọn trong danh sách các gói sản phẩm API có sẵn.
Sản phẩm Sản phẩm API trong gói sản phẩm API đã chọn mà khoản tín dụng được áp dụng. Chọn Tất cả sản phẩm hoặc một sản phẩm API duy nhất trong danh sách.
Đơn vị tiền tệ Đơn vị tiền tệ dùng cho khoản tín dụng. Đơn vị tiền tệ được định cấu hình cho gói giá trong gói sản phẩm API mà nhà phát triển đã mua và không thể thay đổi. Nếu có nhiều đơn vị tiền tệ được xác định trong một kế hoạch giá, bạn có thể chọn một trong các đơn vị tiền tệ đó.
Số tiền Số tiền tín dụng (bằng đơn vị tiền tệ đã chỉ định). Chỉ định một giá trị dương hoặc âm. Giá trị này không được bằng 0.
Lưu ý Ghi chú không bắt buộc để mô tả lý do cấp tín dụng.
- Nhấp vào Lưu tín dụng.
Phát hành tín dụng bằng API
Khi sử dụng API này, bạn có thể cấp tín dụng cho nhà phát triển đối với toàn bộ gói sản phẩm API hoặc đối với việc sử dụng một sản phẩm API cụ thể trong gói sản phẩm API.
Để phát hành khoản tín dụng bằng API, hãy gửi yêu cầu POST đến /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, trong đó {package_id} và {rate-plan_id} lần lượt xác định thông tin nhận dạng của gói sản phẩm API và gói giá mà khoản tín dụng áp dụng.
Khi đưa ra yêu cầu, bạn cần chỉ định dưới dạng tham số truy vấn:
- Mã nhận dạng nhà phát triển (địa chỉ email) được áp dụng khoản tín dụng.
- Số tiền tín dụng.
- Đơn vị tiền tệ dùng cho khoản tín dụng.
- Ghi chú mô tả lý do cấp tín dụng.
Nếu muốn, bạn có thể chỉ định các tham số truy vấn bổ sung sau đây:
- Tháng thanh toán mà khoản tín dụng áp dụng. Giá trị này mặc định là tháng hiện tại.
- Năm thanh toán áp dụng khoản tín dụng. Giá trị này mặc định là năm hiện tại.
- Sản phẩm API mà khoản tín dụng áp dụng. Nếu bạn không chỉ định mã sản phẩm API, thì khoản tín dụng sẽ áp dụng cho tất cả sản phẩm API trong gói sản phẩm API.
Ví dụ: yêu cầu sau đây phát hành khoản tín dụng trị giá 1.000.000 VND cho tháng thanh toán là tháng 4 năm 2018 cho một nhà phát triển được xác định là dev1@myorg.com. Khoản tín dụng này áp dụng cho gói sản phẩm payment API và gói giá payment_standard_plan:
Hãy xem Tham số truy vấn cho Credits API để biết danh sách đầy đủ các tham số truy vấn mà bạn có thể chỉ định trong yêu cầu cấp tín dụng.
$ 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
Sau đây là một ví dụ về đoạn trích trong phản hồi:
{ "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" }
Tham số truy vấn cho API tín dụng
Bạn có thể sử dụng các tham số truy vấn sau đây với Credits API:
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
billingMonth |
Tháng thanh toán mà khoản tín dụng áp dụng, chẳng hạn như THÁNG TƯ. |
Không áp dụng | Không |
billingYear |
Năm thanh toán mà khoản tín dụng được áp dụng, chẳng hạn như 2018. |
Không áp dụng | Không |
currencyId |
Đơn vị tiền tệ dùng cho khoản tín dụng. Đơn vị tiền tệ được định cấu hình cho gói giá trong gói sản phẩm API mà nhà phát triển đã mua và không thể thay đổi. |
Không áp dụng | Có |
developerId |
Tên nhà phát triển hoặc tên công ty được áp dụng khoản tín dụng. |
Không áp dụng | Có |
productId |
Sản phẩm API mà khoản tín dụng áp dụng. Nếu bạn không chỉ định mã sản phẩm, thì khoản tín dụng sẽ áp dụng cho tất cả sản phẩm API trong gói sản phẩm API. |
Không áp dụng | Không |
transactionAmount |
Số tiền tín dụng (bằng đơn vị tiền tệ đã chỉ định). Chỉ định một giá trị dương hoặc âm. Giá trị này không được bằng 0. |
Không áp dụng | Có |
transactionNote |
Ghi chú mô tả lý do cấp tín dụng. |
Không áp dụng | Có |