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 điều chỉnh thông tin thanh toán. Ví dụ: bạn có thể cần để tăng hoặc giảm chia sẻ doanh thu hoặc phí cho một tháng thanh toán cụ thể do trong hồ sơ của mình.
Khám phá trang Điều chỉnh thanh toán
Truy cập vào trang Điều chỉnh thanh toán, như được mô tả bên dưới.
Edge
Cách truy cập vào trang Điều chỉnh thanh toán 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 > Điều chỉnh thanh toán trong thanh điều hướng bên trái.
Trang Điều chỉnh thanh toán sẽ được hiển thị.
Như được đánh dấu trong hình, trang Điều chỉnh thanh toán cho phép bạn:
- Xem danh sách điều chỉnh thanh toán hiện tại
- Thêm mức điều chỉnh thanh toán
- Chỉnh sửa mức điều chỉnh thanh toán
- Tìm kiếm danh sách điều chỉnh thanh toán
Classic Edge (Đám mây riêng tư)
Cách truy cập vào trang Điều chỉnh thanh toán 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 > Điều chỉnh trong thanh điều hướng trên cùng.
Trang Điều chỉnh thanh toán cho phép bạn:
- Xem danh sách điều chỉnh thanh toán hiện tại
- Thêm điều chỉnh thanh toán
- Chỉnh sửa điều chỉnh thanh toán
- Tìm kiếm danh sách điều chỉnh thanh toán
Thêm điều chỉnh thanh toán
Cách thêm mức điều chỉnh thanh toán:
- Truy cập trang Điều chỉnh thanh toán.
- Nhấp vào + Điều chỉnh.
- Nhập thông tin dưới đây:
Trường Mô tả Tên Tên mô tả sẽ xuất hiện trên chứng từ thanh toán.
% điều chỉnh Số tiền điều chỉnh, dưới dạng tỷ lệ phần trăm dương hoặc âm. A tích cực sẽ điều chỉnh tỷ lệ chia sẻ doanh thu hoặc phí trong giao dịch bằng cách phần trăm. Điều chỉnh âm sẽ điều chỉnh giảm chia sẻ doanh thu hoặc phí trong theo tỷ lệ phần trăm đó. Nhập số thập phân dương hoặc âm (có giá trị lên đến 2 chữ số thập phân).
Tháng thanh toán Tháng thanh toán cho việc điều chỉnh. Chọn một tháng trong danh sách thả xuống.
Loại giao dịch Loại giao dịch mà bạn muốn áp dụng mức điều chỉnh. Chọn một giá trị trong trình đơn thả xuống:
- Tất cả các phiên Giao dịch
- Tính phí (các giao dịch theo mô hình tính phí)
- Mua (các giao dịch theo mô hình chia sẻ doanh thu)
- Tiền hoàn lại (các giao dịch sử dụng mô hình chia sẻ doanh thu)
Sản phẩm Sản phẩm API mà bạn muốn áp dụng mức điều chỉnh. Bạn không thể áp dụng một điều chỉnh cho nhiều sản phẩm API. Nếu bạn cần áp dụng điều chỉnh cho nhiều sản phẩm API, hãy tạo nội dung điều chỉnh cho từng sản phẩm. Chọn một sản phẩm API từ trình đơn thả xuống.
Nhà phát triển Nhà phát triển mà bạn muốn áp dụng mức điều chỉnh. Bạn có thể áp dụng điều chỉnh cho tất cả các nhà phát triển (theo mặc định) hoặc cho một nhà phát triển cụ thể. Chọn "Tất cả Nhà phát triển" hoặc một nhà phát triển cụ thể từ trình đơn thả xuống.
- Nhấp vào Tạo mức điều chỉnh.
Chỉnh sửa điều chỉnh thanh toán
Để chỉnh sửa điều chỉnh thanh toán:
- Truy cập trang Điều chỉnh thanh toán.
- Di chuyển con trỏ lên mức điều chỉnh thanh toán mà bạn muốn chỉnh sửa rồi nhấp vào trong trình đơn hành động.
- Cập nhật điều chỉnh thanh toán, nếu bắt buộc.
- Nhấp vào Cập nhật điều chỉnh.
Điều chỉnh thanh toán bằng API
Các phần sau đây mô tả cách điều chỉnh việc thanh toán bằng API.
Điều chỉnh việc thanh toán bằng API
Bạn có thể điều chỉnh chi tiết thanh toán bằng cách gửi yêu cầu POST cho /organizations/{org_name}/billing-adjustments. Khi đưa ra yêu cầu, bạn chỉ định trong nội dung yêu cầu:
- Tên của mức điều chỉnh thanh toán.
- Tỷ lệ phần trăm điều chỉnh, tức là giá trị phần trăm dương hoặc âm sẽ tăng hoặc giảm hoá đơn tương ứng.
- Tháng thanh toán.
- Năm thanh toán.
- Tổ chức áp dụng mức điều chỉnh thanh toán.
Bạn cũng có thể chỉ định các thuộc tính khác, chẳng hạn như:
- Loại giao dịch mà bạn muốn áp dụng mức điều chỉnh (chẳng hạn như một giao dịch mua giao dịch).
- Nhà phát triển mà bạn muốn áp dụng mức điều chỉnh.
- Bạn muốn áp dụng mức điều chỉnh này cho nhà phát triển trả trước, nhà phát triển trả sau hay cả hai.
- Gói API mà bạn muốn áp dụng mức điều chỉnh.
- Sản phẩm API mà bạn muốn áp dụng mức điều chỉnh.
Xem Cài đặt cấu hình điều chỉnh thanh toán để biết danh sách đầy đủ thuộc tính điều chỉnh thanh toán mà bạn có thể chỉ định trong yêu cầu điều chỉnh.
Nếu bạn không chỉ định một thuộc tính không bắt buộc, thì nội dung điều chỉnh trên chứng từ thanh toán sẽ là toàn bộ cho cơ sở lưu trú đó. Ví dụ: nếu không có loại giao dịch nào được chỉ định, việc thanh toán mức điều chỉnh sẽ áp dụng cho tất cả các loại giao dịch.
Ví dụ sau đây thực hiện điều chỉnh thanh toán cho tháng thanh toán chưa thanh toán, tháng 6 năm 2013. Chiến lược phát hành đĩa đơn điều chỉnh sẽ giảm xuống hệ số 3% và được áp dụng cho các giao dịch mua, sản phẩm thanh toán và nhà phát triển trả sau. Vì các thuộc tính để xác định một nhà phát triển hoặc gói API chưa được chỉ định, thì nội dung điều chỉnh sẽ được áp dụng cho tất cả các nhà phát triển ( là nhà phát triển trả sau) và sản phẩm thanh toán trong tất cả các gói API.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "Purchase Adjustment Negative3", "adjustmentPercentageFactor": -3, "billingMonth": 6, "billingYear": 2017, "isPublished": false, "transactionType": "PURCHASE", "developerBillingType": "POSTPAID", "organization": { "id": "{org_name}" }, "product": { "id": "payment" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ -u email:password
Câu trả lời sẽ có dạng như sau (chỉ một phần của câu trả lời được hiển thị):
{ "adjustmentPercentageFactor" : -3, "billingMonth" : 6, "billingYear" : 2017, "developerBillingType" : "POSTPAID", "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c", "isPublished" : false, "name" : "Purchase Adjustment Negative3", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" }, "transactionType" : "PURCHASE" }
Xem điều chỉnh thanh toán bằng API
Bạn có thể xem một mức điều chỉnh thanh toán cụ thể hoặc tất cả các mức điều chỉnh thanh toán của một tổ chức.
Để xem điều chỉnh thanh toán cụ thể, hãy gửi yêu cầu GET tới
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, trong đó
{billing_adjustment_id}
là cách xác định khoản điều chỉnh thanh toán cụ thể
(mã nhận dạng được trả về trong nội dung phản hồi khi bạn tạo mức điều chỉnh thanh toán). Ví dụ:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Để xem tất cả các điều chỉnh thanh toán cho một tổ chức, hãy gửi yêu cầu GET tới
/organizations/{org_name}/billing-adjustments
. Ví dụ:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ -u email:password
Câu trả lời sẽ có dạng như sau (chỉ một phần của câu trả lời được hiển thị):
{ "billingAdjustment" : [ { "adjustmentPercentageFactor" : -3, "billingMonth" : 6, "billingYear" : 2017, "developerBillingType" : "POSTPAID", "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c", "isPublished" : false, "name" : "Purchase Adjustment Negative3", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Payment", "displayName" : "Payment", "id" : "payment", "name" : "payment", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" }, "transactionType" : "PURCHASE" }, { "adjustmentPercentageFactor" : 5.0000, "billingMonth" : 5, "billingYear" : 2017, "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2", "isPublished" : false, "monetizationPackage" : { "description" : "Communications", "displayName" : "Communications", "id" : "communications", "name" : "Communications", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Messaging", "displayName" : "Messaging", "id" : "messaging", "name" : "messaging", "organization" : { ... }, "status" : "CREATED" }, { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } ], "status" : "CREATED" }, "name" : "Test Package Adjustment", "organization" : { ... }, "product" : { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... }, "status" : "CREATED", "transactionSuccessCriteria" : "Status=='200 OK'" } } ], "totalRecords" : 2 }
Cập nhật điều chỉnh thanh toán bằng API
Bạn có thể cập nhật điều chỉnh thanh toán bằng cách gửi yêu cầu PUT cho
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, trong đó
{billing_adjustment_id}
là cách xác định khoản điều chỉnh thanh toán cụ thể.
Khi cập nhật, bạn cần chỉ định trong nội dung yêu cầu các thuộc tính được cập nhật và
nhận dạng điều chỉnh thanh toán cần cập nhật. Bạn cũng cần chỉ định
thuộc tính cho điều chỉnh thanh toán, tức là thuộc tính theo tên, tỷ lệ điều chỉnh,
tháng thanh toán, năm thanh toán và tổ chức.
Ví dụ: lệnh gọi API sau đây cập nhật tên và hệ số tỷ lệ phần trăm điều chỉnh (giá trị các thuộc tính đã cập nhật được làm nổi bật trong ví dụ):
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ", "adjustmentPercentageFactor": -5, "name" : "Purchase Adjustment Negative5", "billingMonth": 6, "billingYear": 2017, "isPublished": false, "transactionType": "PURCHASE", "developerBillingType": "POSTPAID", "organization": { "id": "{org_name}" }, "product": { "id": "payment" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Xóa điều chỉnh thanh toán bằng cách sử dụng API
Bạn có thể xóa điều chỉnh thanh toán bằng cách gửi yêu cầu DELETE cho
/organizations/{org_name}/billing-adjustments/{billing_adjustment_id}
, trong đó
{billing_adjustment_id}
là mã nhận dạng điều chỉnh thanh toán sẽ
đã bị xoá. Ví dụ:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \ -u email:password
Chế độ cài đặt cấu hình điều chỉnh thanh toán cho API
Các lựa chọn cấu hình sau đây có sẵn cho việc điều chỉnh thanh toán:
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
name |
Tên mô tả cho điều chỉnh thanh toán. |
Không áp dụng | Có |
adjustmentPercentageFactor |
Số tiền điều chỉnh, dưới dạng phần trăm số dương hoặc âm. A tích cực sẽ điều chỉnh chia sẻ doanh thu hoặc phí trong giao dịch theo tỷ lệ phần trăm đó. Đáp tỷ lệ phần trăm âm sẽ điều chỉnh giảm chia sẻ doanh thu hoặc phí trong giao dịch bằng cách phần trăm. Giá trị có thể dao động từ -100 đến 999,9999. |
Không áp dụng | Có |
billingMonth |
Tháng thanh toán cho điều chỉnh thanh toán, được chỉ định dưới dạng số nguyên. Ví dụ: 11 trong tháng 12. |
Không áp dụng | Có |
billingYear |
Năm thanh toán cho điều chỉnh thanh toán, được chỉ định theo định dạng sau: YYYY. Ví dụ: năm 2017. |
Không áp dụng | Có |
organization |
Tổ chức áp dụng mức điều chỉnh thanh toán. |
Không áp dụng | Có |
isPublished |
Cờ chỉ định liệu điều chỉnh có được xuất bản hay không trong số sau:
|
Không áp dụng | Không |
transactionType |
Loại giao dịch có áp dụng mức điều chỉnh về việc thanh toán. Loại có thể là một trong số sau:
|
Không áp dụng | Không |
developerBillingType |
Loại hình thanh toán dành cho nhà phát triển có áp dụng mức điều chỉnh về việc thanh toán. Giá trị có thể là một trong các lệnh sau:
|
Không áp dụng | Không |
product |
Sản phẩm API được áp dụng điều chỉnh thanh toán. Nếu bạn không chỉ định tài sản này, thì mức điều chỉnh về việc thanh toán sẽ áp dụng cho tất cả các sản phẩm API. |
Không áp dụng | Không |
monetizationPackage |
Gói API áp dụng mức điều chỉnh thanh toán. Nếu bạn không chỉ định thuộc tính này, thì mức điều chỉnh về việc thanh toán sẽ áp dụng cho tất cả các gói API. |
Không áp dụng | Không |
developer |
Nhà phát triển được áp dụng mức điều chỉnh thanh toán. Nếu bạn không chỉ định thông tin này tài sản, thì điều chỉnh thanh toán áp dụng cho tất cả các nhà phát triển. |
Không áp dụng | Không |
Các bước tiếp theo
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. Có thể bạn cần phải điều này nếu nhà phát triển không hài lòng với một dịch vụ và yêu cầu hoàn lại một phần hoặc toàn bộ tiền cho việc sử dụng trong một khoảng thời gian. Tìm hiểu cách cấp tín dụng trong phần Cấp tín dụng.