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 cho phé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 tỷ lệ chia sẻ doanh thu hoặc phí cho một tháng thanh toán nhất định do có sự chênh lệch trong hồ sơ của bạn.
Khám phá trang Điều chỉnh thông tin thanh toán
Truy cập vào trang Điều chỉnh phí thanh toán, như 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 hoá đơn trong thanh điều hướng bên trái.
Trang Điều chỉnh thanh toán sẽ xuất hiện.

Như được làm nổi bật trong hình, trang Điều chỉnh thanh toán cho phép bạn:
- Xem danh sách hiện tại về các khoản điều chỉnh phí
- Thêm mức điều chỉnh thanh toán
- Chỉnh sửa điều chỉnh thanh toán
- Tìm trong danh sách các khoản điều chỉnh thanh toán
Classic Edge (Private Cloud)
Cách truy cập vào trang Điều chỉnh phí bằng giao diện người dùng Edge 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 > Đ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 hiện tại về các khoản điều chỉnh phí
- 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 trong danh sách các khoản điều chỉnh thanh toán
Thêm mức điều chỉnh thanh toán
Cách thêm khoản điều chỉnh thanh toán:
- Truy cập vào trang Điều chỉnh thông tin thanh toán.
- Nhấp vào + Điều chỉnh.
- Nhập thông tin dưới đây:
Trường Nội dung mô tả Tên Tên mô tả sẽ xuất hiện trên chứng từ thanh toán.
Tỷ lệ đ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. Tỷ lệ phần trăm dương sẽ điều chỉnh tăng tỷ lệ chia sẻ doanh thu hoặc phí trong giao dịch theo tỷ lệ phần trăm đó. Mức điều chỉnh âm sẽ điều chỉnh giảm tỷ lệ chia sẻ doanh thu hoặc phí trong giao dịch theo tỷ lệ phần trăm đó. Nhập số thập phân dương hoặc âm (có tối đa 2 chữ số thập phân).
Tháng thanh toán Tháng thanh toán cho khoản đ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 khoản đ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
- Phí (giao dịch theo mô hình tính phí)
- Mua hàng (giao dịch theo mô hình chia sẻ doanh thu)
- Hoàn tiền (giao dịch theo 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 mức điều chỉnh duy nhất cho nhiều sản phẩm API. Nếu bạn cần áp dụng mức điều chỉnh cho nhiều sản phẩm API, hãy tạo mức điều chỉnh cho từng sản phẩm. Chọn một sản phẩm API trong 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 mức điều chỉnh cho tất 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ể trong trình đơn thả xuống.
- Nhấp vào Tạo mức điều chỉnh.
Chỉnh sửa mức điều chỉnh thanh toán
Cách chỉnh sửa mức điều chỉnh thanh toán:
- Truy cập vào trang Điều chỉnh thông tin thanh toán.
- Di chuyển con trỏ lên khoản điều chỉnh thanh toán mà bạn muốn chỉnh sửa rồi nhấp vào biểu tượng
trong trình đơn hành động. - Cập nhật khoản điều chỉnh thanh toán, nếu cần.
- Nhấp vào Cập nhật giá trị điều chỉnh.
Điều chỉnh phí bằng API
Các phần sau đây mô tả cách điều chỉnh hoá đơn bằng API.
Thực hiện điều chỉnh thanh toán bằng API
Bạn có thể điều chỉnh thông tin thanh toán bằng cách gửi yêu cầu POST đến /organizations/{org_name}/billing-adjustments. Khi đưa ra yêu cầu, bạn chỉ định trong phần nội dung yêu cầu:
- Tên của khoản điều chỉnh thanh toán.
- Tỷ lệ điều chỉnh, tức là giá trị phần trăm dương hoặc âm tương ứng làm tăng hoặc giảm hoá đơn.
- Tháng lập hoá đơn.
- Năm lập hoá đơn.
- Tổ chức được áp dụng khoản đ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 khoản điều chỉnh (chẳng hạn như giao dịch mua hàng).
- 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 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.
Hãy xem Chế độ cài đặt cấu hình điều chỉnh thanh toán để biết danh sách đầy đủ các 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 thanh toán.
Nếu bạn không chỉ định một thuộc tính không bắt buộc, thì khoản điều chỉnh chứng từ thanh toán sẽ bao gồm tất cả cho thuộc tính đó. Ví dụ: nếu bạn không chỉ định loại giao dịch, thì khoản điều chỉnh thanh toán sẽ áp dụng cho tất cả các loại giao dịch.
Ví dụ sau đây điều chỉnh thanh toán cho tháng có hệ thống thanh toán mở là tháng 6 năm 2013. Mức điều chỉnh này giảm 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 cụ thể không được chỉ định, nên mức điều chỉnh sẽ được áp dụng cho tất cả nhà phát triển (những 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
Phản hồi sẽ có dạng như sau (chỉ một phần của phản hồ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 các khoản điều chỉnh thanh toán bằng API
Bạn có thể xem một khoản điều chỉnh thanh toán cụ thể hoặc tất cả các khoản điều chỉnh thanh toán cho một tổ chức.
Để xem một khoản điều chỉnh thanh toán cụ thể, hãy gửi một yêu cầu GET đến /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, trong đó {billing_adjustment_id} là thông tin nhận dạng của khoản điều chỉnh thanh toán cụ thể (mã nhận dạng được trả về trong phản hồi khi bạn tạo khoản đ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ả khoản điều chỉnh hoá đơn của một tổ chức, hãy gửi yêu cầu GET đến /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
Phản hồi sẽ có dạng như sau (chỉ một phần của phản hồ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 khoản điều chỉnh thanh toán bằng API
Bạn có thể cập nhật một khoản điều chỉnh thanh toán bằng cách gửi yêu cầu PUT đến /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, trong đó {billing_adjustment_id} là thông tin nhận dạng của khoản điều chỉnh thanh toán cụ thể.
Khi thực hiện việc cập nhật, bạn cần chỉ định các thuộc tính đã cập nhật và thông tin nhận dạng của khoản điều chỉnh thanh toán cần cập nhật trong nội dung yêu cầu. Bạn cũng cần chỉ định các thuộc tính bắt buộc cho khoản điều chỉnh thanh toán, tức là các thuộc tính cho tên, tỷ lệ phần trăm điều chỉnh, tháng lập hoá đơn, năm lập hoá đơn và tổ chức.
Ví dụ: lệnh gọi API sau đây sẽ cập nhật hệ số và tên phần trăm điều chỉnh (các thuộc tính được cập nhật sẽ đượ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
Xoá mức điều chỉnh thanh toán bằng API
Bạn có thể xoá một khoản điều chỉnh thanh toán bằng cách gửi yêu cầu XOÁ đến /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, trong đó {billing_adjustment_id} là thông tin nhận dạng của khoản điều chỉnh thanh toán cần 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
Bạn có thể sử dụng các lựa chọn cấu hình sau đây cho khoản điều chỉnh thanh toán:
| Tên | Mô tả | Mặc định | Bắt buộc? |
|---|---|---|---|
name |
Tên mô tả của khoản đ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 tỷ lệ phần trăm bằng số dương hoặc số âm. Tỷ lệ phần trăm dương sẽ điều chỉnh tăng tỷ lệ chia sẻ doanh thu hoặc phí trong giao dịch theo tỷ lệ phần trăm đó. Tỷ lệ phần trăm âm sẽ điều chỉnh giảm tỷ lệ chia sẻ doanh thu hoặc phí trong giao dịch theo tỷ lệ phần trăm đó. Giá trị có thể nằm trong khoảng từ -100 đến 999,9999. |
Không áp dụng | Có |
billingMonth |
Tháng thanh toán cho khoản điều chỉnh thanh toán, được chỉ định dưới dạng số nguyên. Ví dụ: 11 cho tháng 12. |
Không áp dụng | Có |
billingYear |
Năm lập hoá đơn cho khoản điều chỉnh thanh toán, được chỉ định bằng định dạng sau: YYYY. Ví dụ: 2017. |
Không áp dụng | Có |
organization |
Tổ chức mà khoản điều chỉnh thanh toán áp dụng. |
Không áp dụng | Có |
isPublished |
Một cờ chỉ định xem có nên xuất bản mức điều chỉnh hay không. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
transactionType |
Loại giao dịch mà khoản điều chỉnh thanh toán áp dụng. Loại này có thể là một trong những loại sau:
|
Không áp dụng | Không |
developerBillingType |
Loại hoá đơn nhà phát triển mà khoản điều chỉnh thanh toán áp dụng. Giá trị có thể là một trong những giá trị sau:
|
Không áp dụng | Không |
product |
Sản phẩm API mà khoản điều chỉnh thanh toán áp dụng. Nếu bạn không chỉ định thuộc tính này, khoản điều chỉnh thanh toán sẽ áp dụng cho tất cả sản phẩm API. |
Không áp dụng | Không |
monetizationPackage |
Gói API mà mức điều chỉnh thanh toán áp dụng. Nếu bạn không chỉ định thuộc tính này, khoản điều chỉnh 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 mà khoản điều chỉnh thanh toán áp dụng. Nếu bạn không chỉ định thuộc tính này, thì khoản điều chỉnh thanh toán sẽ áp dụng cho tất 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 cho phép bạn linh hoạt cấp tín dụng cho nhà phát triển. Bạn có thể cần phải làm việc 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 tiền một phần hoặc hoàn tiền toàn bộ cho việc sử dụng trong một khoảng thời gian. Tìm hiểu cách phát hành tín dụng trong phần Phát hành tín dụng.