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 tính năng kiếm tiền ban đầu, nhóm cấu hình Apigee Edge sẽ định cấu hình các đơ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 bạn hỗ trợ, thêm đơ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 các đơ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 mục Thuế và đơn vị tiền tệ trên trang Hồ sơ tổ chức. Hãy 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 như mô tả trong các phần sau.

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

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

Để xem một đơn vị tiền tệ riêng lẻ mà tổ chức của bạn hỗ trợ, hãy đưa ra yêu cầu GET đến /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId}, trong đó {supportedCurrency_id} là mã nhận dạng của đơn vị tiền tệ được hỗ trợ mà bạn muốn 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
}

Thêm đơn vị tiền tệ được hỗ trợ bằng API

Thêm các đơn vị tiền tệ được hỗ trợ bằng cách gửi yêu cầu POST cho /mint//organizations/{org_name}/supported-currencies. Đối với mỗi đơn vị tiền tệ được hỗ trợ mà bạn thêm, bạn cần chỉ định những thông tin sau trong phần nội dung yêu cầu:

  • Tên đơn vị tiền tệ được hỗ trợ. Tên này là mã ISO 4217 của đơn vị tiền tệ, chẳng hạn như USD cho đô la Mỹ.
  • Tên hiển thị.
  • Nội dung mô tả.
  • Đơn vị tiền tệ có phải là tiền ảo hay không.
  • Trạng thái của đơn vị tiền tệ, tức là đơn vị tiền tệ đó có sử dụng được hay không.
  • Tổ chức mà bạn sẽ thêm đơn vị tiền tệ được hỗ trợ.

Bạn có thể đặt các giá trị sau (không bắt buộc):

  • Hạn mức tín dụng cho một đơn vị tiền tệ được hỗ trợ (chỉ dành cho nhà phát triển sử dụng phương thức trả sau).
  • Khoản nạp tiền tối thiểu cho một đơn vị tiền tệ được hỗ trợ (chỉ dành cho nhà phát triển sử dụng thẻ trả trước).

Xem Các thuộc tính cấu hình đơn vị tiền tệ được hỗ trợ để biết thêm thông tin.

Ví dụ: đoạn mã sau đây sẽ thêm một đơn vị tiền tệ được hỗ trợ cho một tổ chức:

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

Đặ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 mã đơn vị tiền tệ ISO 4217 được hỗ trợ khi bạn chỉnh sửa hồ sơ tổ chức, như mô tả trong phần Quản lý hồ sơ 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 một đơn vị tiền tệ được hỗ trợ bằng cách đưa ra yêu cầu PUT đến /mint/organizations/{org_name}/{supportedCurrencyId}, trong đó {supportedCurrency_id} là mã nhận dạng của đơn vị tiền tệ được hỗ trợ cần cập nhật. Bạn cần chỉ định trong phần nội dung yêu cầu các thuộc tính đã 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ợ (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 \
  '{
     "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á một đơn vị tiền tệ được hỗ trợ bằng cách đưa ra yêu cầu XOÁ đến /mint/organizations/{org_name}/supported-currencies/{currency_id}, trong đó {currency_id} là mã nhận dạng của đơn vị tiền tệ được hỗ trợ cần 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ể được đặt 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 sẽ hiển thị cho đơn vị tiền tệ được hỗ trợ.

Không áp dụng
minimumTopupAmount

Thuộc tính này chỉ áp dụng cho 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 phát hành đơ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 ACTIVE: Bạn không thể sử dụng đơn vị tiền tệ được hỗ trợ.
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à tiền ảo.
Không áp dụng