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
Tính năng kiếm tiền cung cấp một bộ API mà bạn có thể dùng để huỷ lệnh tạm ngưng đối với một nhà phát triển đã bị tạm ngưng trước đó, như mô tả trong các phần sau. Nhà phát triển có thể bị tạm ngưng nếu đạt đến một giới hạn đã định cấu hình. Ví dụ: số lượng giao dịch đã đạt đến giới hạn tối đa hoặc số dư tài khoản trả trước đã hết. Để xem danh sách đầy đủ các mã lý do, hãy xem bài viết Tóm tắt mã lý do đối với nhà phát triển bị tạm ngưng.
Xem tất cả nhà phát triển bị tạm ngưng bằng API
Xem tất cả nhà phát triển bị tạm ngưng của một tổ chức bằng cách gửi yêu cầu GET đến tài nguyên sau: /organizations/{org_name}/suspended-developers.
Trong trường hợp:
{org_name}chỉ định tên của tổ chức.
Ví dụ: lệnh gọi cURL sau đây liệt kê tất cả nhà phát triển bị tạm ngưng cho myorg:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Sau đây là một ví dụ về phản hồi:
[
{
"creationDate": 1464388723633,
"devId": "myorg@@@6Vro7VnjUhpGVn3p",
"id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
"message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
"orgId": "myorg",
"prodId": "myorg@@@myproduct",
"reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
},
{
"creationDate": 1464022846293,
"devId": "myorg@@@vXh7LXxtUy9COVdy",
"id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY",
"message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity",
"orgId": "myorg",
"prodId": "myorg@@@myproduct",
"reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY"
}
]
Xem nhà phát triển bị tạm ngưng bằng API
Xem nhà phát triển bị tạm ngưng của một tổ chức bằng cách gửi yêu cầu GET đến tài nguyên sau: /organizations/{org_name}/suspended-developers/{developer_email_or_id}.
Trong trường hợp:
{org_name}chỉ định tên của tổ chức.{developer_email_or_id}chỉ định mã nhận dạng của nhà phát triển. Để xem danh sách nhà phát triển, hãy xem phần Liệt kê nhà phát triển.
Ví dụ: lệnh gọi cURL sau đây liệt kê thông tin chi tiết về nhà phát triển bị tạm ngưng joe@example.com:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \ -u email:password
Sau đây là một ví dụ về phản hồi:
[
{
"creationDate": 1464388723633,
"devId": "myorg@@@6Vro7VnjUhpGVn3p",
"id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
"message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
"orgId": "myorg",
"prodId": "myorg@@@myproduct",
"reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
}
]
Huỷ tạm ngưng tất cả nhà phát triển cho một sản phẩm API bằng API
Huỷ tạm ngưng tất cả nhà phát triển đã bị tạm ngưng đối với một sản phẩm API bằng cách gửi yêu cầu POST đến tài nguyên sau: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}.
Trong trường hợp:
{org_name}chỉ định tên của tổ chức.{suspendedProduct_id}chỉ định mã nhận dạng của sản phẩm API, sử dụng một định dạng tương tự như sau:{org_id}@@@{product_id}. Giá trị này được trả về dưới dạngprodIdkhi bạn xem tất cả hoặc một số nhà phát triển bị tạm ngưng, như mô tả trong phần Xem tất cả nhà phát triển bị tạm ngưng bằng API và Xem một nhà phát triển bị tạm ngưng bằng API.
Ví dụ: lệnh gọi cURL sau đây sẽ huỷ tạm ngưng tất cả nhà phát triển cho sản phẩm API myorg@@@myproduct:
curl -H "Content-Type: application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \ -u email:password
Huỷ tạm ngưng nhà phát triển bằng API
Huỷ tạm ngưng một nhà phát triển cụ thể đã bị tạm ngưng bằng cách gửi yêu cầu XOÁ đến tài nguyên sau: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Trong trường hợp:
{org_name}chỉ định tên của tổ chức.{suspendedDev_id}chỉ định mã nhận dạng của nhà phát triển bị tạm ngưng, sử dụng định dạng tương tự như sau:{org_id}@@@{dev_id}. Giá trị này được trả về dưới dạngdevIdkhi bạn xem tất cả hoặc một số nhà phát triển bị tạm ngưng, như mô tả trong phần Xem tất cả nhà phát triển bị tạm ngưng bằng API và Xem một nhà phát triển bị tạm ngưng bằng API.
Bạn có thể truyền tham số truy vấn sau (không bắt buộc):
| Tham số truy vấn | Mô tả |
|---|---|
suspendedProduct_id |
Mã nhận dạng của sản phẩm API, sử dụng một định dạng tương tự như sau:
{org_id}@@@{product_id}. Giá trị này được trả về dưới dạng prodId khi bạn xem tất cả hoặc một số nhà phát triển bị tạm ngưng, như mô tả trong phần Xem tất cả nhà phát triển bị tạm ngưng bằng API và Xem một nhà phát triển bị tạm ngưng bằng API. |
Ví dụ: lệnh gọi cURL sau đây sẽ huỷ tạm ngưng nhà phát triển có mã nhận dạng myorg@@@6Vro7VnjUhpGVn3p cho sản phẩm API myorg@@@myproduct:
curl -H "Content-Type: application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \ -u email:password
Tóm tắt mã lý do đối với nhà phát triển bị tạm ngưng
Bảng sau đây tóm tắt các mã lý do cho biết lý do khiến nhà phát triển bị tạm ngưng.
| Mã lý do | Mô tả |
|---|---|
INSUFFICIENT_FUNDS |
Tài khoản nhà phát triển đã hết hạn mức. |
LIMIT_VIOLATED |
Đã đạt đến giới hạn được định cấu hình cho tài khoản nhà phát triển. |
NO_CURRENT_PUBLISHABLE_ENTITY |
Nhà phát triển chưa chấp nhận (đăng ký) một gói giá. |
RATE_PLAN_RATE_BAND_EXCEEDED |
Đã đạt đến giới hạn được định cấu hình của dải âm lượng cuối cùng. |