Quản lý đơn vị tiền tệ được hỗ trợ

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

Trong quá trình thiết lập hoạt động kiếm tiền ban đầu, nhóm định cấu hình Apigee Edge định cấu hình đơn vị tiền tệ và đơn vị tiền tệ mặc định mà tổ chức của bạn hỗ trợ.

Bạn có thể xem các đơn vị tiền tệ mà tổ chức của mình hỗ trợ, thêm các đơn vị tiền tệ được hỗ trợ hoặc xoá đơn vị tiền tệ được hỗ trợ (nếu nhà phát triển hoặc gói giá không sử dụng đơn vị tiền tệ đó).

Quản lý các đơn vị tiền tệ được hỗ trợ bằng giao diện người dùng

Quản lý các đơn vị tiền tệ được hỗ trợ và đặt đơn vị tiền tệ mặc định trong phần Thuế và đơn vị tiền tệ của trang Hồ sơ tổ chức. Xem phần Quản lý hồ sơ tổ chức bằng giao diện người dùng để biết thông tin chi tiết.

Quản lý các đơn vị tiền tệ được hỗ trợ bằng API

Quản lý các đơn vị tiền tệ được hỗ trợ bằng API theo mô tả trong các phần sau.

Xem các đơn vị tiền tệ được hỗ trợ bằng API

Xem từng đơn vị tiền tệ mà tổ chức của bạn hoặc tất cả các đơn vị tiền tệ hỗ trợ được tổ chức của bạn hỗ trợ.

Để xem từng đơn vị tiền tệ mà tổ chức của bạn hỗ trợ, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, trong đó {supportedCurrency_id} là thông tin nhận dạng đơn vị tiền tệ được hỗ trợ đã xem. Ví dụ:

curl -X GET -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
-u email:password

Để xem tất cả các đơn vị tiền tệ mà tổ chức của bạn hỗ trợ, hãy gửi yêu cầu GET tới /mint/organizations/{org_name}/supported-currencies. Ví dụ:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies" \
  -H "Accept: application/json"  \
-u email:password

Sau đây là ví dụ về phản hồi:

{
"supportedCurrency" : [ {
    "description" : "US Dollar",
    "displayName" : "US Dollar",
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    "status" : "ACTIVE",
    "virtualCurrency" : false
  }, {
    "creditLimit" : 5000.0000,
    "description" : "Euro",
    "displayName" : "Euro",
    "id" : "eur",
    "name" : "EUR",
    "organization" : {
      ...
    },
    "status" : "INACTIVE",
    "virtualCurrency" : false  
  } ],
  "totalRecords" : 2
}

Đặt đơn vị tiền tệ mặc định bằng API

Đặt đơn vị tiền tệ mặc định cho tổ chức bằng cách đặt giá trị currency thành đơn vị tiền tệ được hỗ trợ theo tiêu chuẩn ISO 4217 khi bạn chỉnh sửa hồ sơ tổ chức, như mô tả trong phần Quản lý tổ chức bằng API.

Chỉnh sửa đơn vị tiền tệ được hỗ trợ bằng API

Chỉnh sửa đơn vị tiền tệ được hỗ trợ bằng cách gửi yêu cầu PUT cho /mint/organizations/{org_name}/{supportedCurrencyId}, trong đó {supportedCurrency_id} là thông tin nhận dạng đơn vị tiền tệ được hỗ trợ đã 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 cũng như mã đơn vị tiền tệ được hỗ trợ. Ví dụ: lệnh gọi API sau đây chỉnh sửa nội dung mô tả và tên hiển thị cho một đơn vị tiền tệ được hỗ trợ (thuộc tính được cập nhật là được làm nổi bật trong ví dụ):

curl -H "Content-Type: application/json" -X PUT -d \
  '{
     "description": "United States Dollar",
     "displayName": "United States Dollar",
     "id": "usd",
     "name": "USD",
     "organization": {
       "id": "{org_name}"
     },
     "status" : "ACTIVE",
     "virtualCurrency": "false"
  }' \
  "https://api.enterprise.apigee.com/v1/mint/organization/{org_name}/supported-currencies/usd" -d \
  -u email:password

Xoá đơn vị tiền tệ được hỗ trợ bằng API

Xoá đơn vị tiền tệ được hỗ trợ bằng cách gửi yêu cầu DELETE cho /mint/organizations/{org_name}/supported-currencies/{currency_id}, trong đó {currency_id} là thông tin nhận dạng đơn vị tiền tệ được hỗ trợ sẽ bị xoá. Ví dụ:

curl -X DELETE -H "Accept: application/json"  \
  "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/supported-currencies/usd" \
  -u email:password

Thuộc tính cấu hình đơn vị tiền tệ cho API

Bảng sau đây tóm tắt các thuộc tính cấu hình có thể thiết lập bằng API.

Tên Mô tả Mặc định Bắt buộc?
creditLimit

Thuộc tính này chỉ áp dụng cho nhà phát triển trả sau. Hạn mức tín dụng cho đơn vị tiền tệ được hỗ trợ.

Không áp dụng Không
description

Nội dung mô tả về đơn vị tiền tệ được hỗ trợ.

Không áp dụng
Tên hiển thị

Tên để hiển thị cho đơn vị tiền tệ được hỗ trợ.

Không áp dụng
minimumTopupAmount

Tài sản này chỉ áp dụng cho các nhà phát triển trả trước. Số tiền tối thiểu mà nhà phát triển có thể thêm vào số dư tài khoản trả trước bằng đơn vị tiền tệ được chỉ định.

Không áp dụng Không
tên

Mã ISO 4217 cho đơn vị tiền tệ, chẳng hạn như USD cho đô la Mỹ.

Không áp dụng
tổ chức

Tổ chức của đơn vị tiền tệ được hỗ trợ.

Không áp dụng
trạng thái

Trạng thái của đơn vị tiền tệ được hỗ trợ. Các giá trị hợp lệ bao gồm:

  • ĐANG HOẠT ĐỘNG: Hiện đã có đơn vị tiền tệ được hỗ trợ để sử dụng.
  • KHÔNG HOẠT ĐỘNG: Đơn vị tiền tệ được hỗ trợ không có sẵn để sử dụng.
Không áp dụng
virtualCurrency

Cho biết đơn vị tiền tệ được hỗ trợ có phải là tiền ảo hay không. Các giá trị hợp lệ bao gồm:

  • true: Đơn vị tiền tệ được hỗ trợ là đơn vị tiền tệ ảo.
  • false: Đơn vị tiền tệ được hỗ trợ không phải là đơn vị tiền tệ ảo.
Không áp dụng