Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến
Tài liệu về Apigee X. thông tin
Giới thiệu
Tính năng kiếm tiền giúp bạn linh hoạt phát hành tín dụng 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 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 về sau. Tương tự như khi dùng thẻ ghi nợ, tiền sẽ được rút từ số dư trả trước của nhà phát triển khi nhà phát triển mua gói sản phẩm API. Nhà phát triển phải duy trì mức cân bằng hợp lý cho mua hàng. Hãy xem 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 Tín dụng
Truy cập và khám phá trang Tín dụng như được mô tả dưới đây.
Edge
Cách truy cập vào trang Tín dụ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 > Khoản tín dụng trong thanh điều hướng bên trái.
Trang Tín dụng sẽ được hiển thị.
Như được đánh dấu trong hình, 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 tên người nhận, số tiền tín dụng, ngày và giờ tín dụng có hiệu lực, Gói sản phẩm API và sản phẩm API được áp dụng khoản tín dụng này cũng như mọi ghi chú được thêm vào
- Phát hành tín dụng
- Tìm kiếm danh sách các khoản tín dụng
Classic Edge (Đám mây riêng tư)
Cách truy cập vào trang Ghi nhận quyền tác giả bằng giao diện người dùng Classic Edge:
- Đă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 tên người nhận, số tiền tín dụng, ngày và giờ tín dụng có hiệu lực, Gói sản phẩm API và sản phẩm API được áp dụng khoản tín dụng này cũng như mọi ghi chú được thêm vào
- Phát hành tín dụng
- Tìm kiếm danh sách các khoản tín dụng
Cấp tín dụng
- Truy cập vào trang Tín dụng.
- Nhấp vào + Ghi có.
- Nhập thông tin dưới đây:
Trường Mô tả Tháng thanh toán Tháng thanh toán có áp dụng khoản tín 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 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 chứa chuỗi sẽ hiển thị trong 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ẽ hiển thị. Nếu chọn một công ty hoặc nhà phát triển chưa chấp nhận gói giá thì bạn không thể phát hành tín dụng.
Gói sản phẩm Gói sản phẩm API mà khoản tín dụng được áp dụng. Chọn trong danh sách các gói sản phẩm API hiện có.
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 thiết lập 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 được. Nếu có nhiều đơn vị tiền tệ được xác định trong một gói giá, thì bạn có thể chọn một trong các đơn vị tiền tệ.
Số tiền Số tiền trong khoản tín dụng (bằng đơn vị tiền tệ được chỉ định). Chỉ định một giá trị dương hoặc âm. Giá trị không được bằng 0.
Lưu ý Ghi chú không bắt buộc để mô tả lý do ghi có.
- Nhấp vào Lưu tín dụng.
Cấp tín dụng bằng API
Sử dụng API, 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 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 tín dụng bằng API, hãy phát hành yêu cầu POST để
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions
,
trong đó {package_id}
và {rate-plan_id}
xác định
thông tin xác định gói sản phẩm API và gói giá áp dụng khoản tín dụng tương ứng.
Khi gửi yêu cầu, bạn cần chỉ định làm tham số truy vấn:
- Mã nhà phát triển (địa chỉ email) được áp dụng khoản tín dụng.
- Số tiền trong khoản tín dụng.
- Đơn vị tiền tệ dùng cho khoản tín dụng.
- Lưu ý mô tả lý do cho khoản tín dụng.
Nếu muốn, bạn có thể chỉ định các tham số truy vấn bổ sung sau:
- Tháng thanh toán mà khoản tín dụng được áp dụng. Giá trị này mặc định là giá trị hiện tại 1 tháng.
- Năm thanh toán mà khoản tín dụng được áp 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 được áp dụng. Nếu bạn không chỉ định sản phẩm API thì khoản tín dụng này áp dụng cho tất cả cá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 một khoản tín dụng trị giá 100 USD 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
payment
gói sản phẩm API và gói giá payment_standard_plan
:
Hãy xem bài viết Tham số truy vấn cho API tín dụng để 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 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
Phần sau đây cung cấp một ví dụ về câu trả lời này được trích dẫn:
{ "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 cùng với API tín dụng:
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
billingMonth |
Tháng thanh toán áp dụng khoản tín dụng, chẳng hạn như APRIL. |
Không áp dụng | Không |
billingYear |
Năm thanh toán áp dụng khoản tín dụng, chẳng hạn như năm 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 thiết lập 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 được. |
Không áp dụng | Có |
developerId |
Tên nhà phát triển hoặc 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 được áp dụng. Nếu bạn không chỉ định ID sản phẩm, khoản tín dụng sẽ được áp dụng cho tất cả cá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 trong khoản tín dụng (bằng đơn vị tiền tệ được chỉ định). Chỉ định một giá trị dương hoặc âm. Giá trị không được bằng 0. |
Không áp dụng | Có |
transactionNote |
Lưu ý phần mô tả lý do cho khoản tín dụng. |
Không áp dụng | Có |