จัดการสกุลเงินที่รองรับ

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X.
ข้อมูล

บทนำ

ทีมกำหนดค่า Apigee Edge เป็นส่วนหนึ่งของการตั้งค่าการสร้างรายได้เริ่มต้น กำหนดค่าสกุลเงินและสกุลเงินเริ่มต้นที่องค์กรรองรับ

คุณสามารถดูสกุลเงินที่องค์กรของคุณรองรับ เพิ่มสกุลเงินที่รองรับ หรือ ลบสกุลเงินที่รองรับ (หากนักพัฒนาซอฟต์แวร์ไม่ได้ใช้สกุลเงินหรือแพ็กเกจราคา)

การจัดการสกุลเงินที่รองรับโดยใช้ UI

จัดการสกุลเงินที่รองรับและตั้งค่าสกุลเงินเริ่มต้นในส่วนภาษีและสกุลเงิน ของหน้าโปรไฟล์องค์กร ดูการจัดการ โปรไฟล์องค์กรโดยใช้ UI เพื่อดูรายละเอียด

การจัดการสกุลเงินที่รองรับโดยใช้ API

จัดการสกุลเงินที่รองรับโดยใช้ API ตามที่อธิบายไว้ในส่วนต่อไปนี้

การดูสกุลเงินที่รองรับโดยใช้ API

ดูแต่ละสกุลเงินที่องค์กรของคุณรองรับหรือทุกสกุลเงิน ที่องค์กรของคุณรองรับ

หากต้องการดูแต่ละสกุลเงินที่องค์กรรองรับ ให้ส่งคำขอ GET เพื่อ /mint/organizations/{org_name}/supported-currencies/{supportedCurrencyId} โดยที่ {supportedCurrency_id} คือการระบุสกุลเงินที่รองรับ ดูแล้ว เช่น

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

หากต้องการดูสกุลเงินทั้งหมดที่องค์กรรองรับ ให้ส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/supported-currencies เช่น

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

ตัวอย่างคําตอบมีดังนี้

{
"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
}

การตั้งค่าสกุลเงินเริ่มต้นโดยใช้ API

กำหนดสกุลเงินเริ่มต้นสำหรับองค์กรโดยตั้งค่า currency เป็นสกุลเงินที่รองรับ ISO 4217 เมื่อคุณแก้ไขโปรไฟล์องค์กร ตามที่อธิบายไว้ในการจัดการองค์กร โดยใช้ API

การแก้ไขสกุลเงินที่รองรับโดยใช้ API

แก้ไขสกุลเงินที่รองรับโดยการส่งคำขอ PUT ไปยัง /mint/organizations/{org_name}/{supportedCurrencyId} โดยที่ {supportedCurrency_id} คือการระบุสกุลเงินที่รองรับ อัปเดตแล้ว คุณต้องระบุพร็อพเพอร์ตี้ที่อัปเดตในเนื้อหาคำขอ และรหัสสกุลเงินที่รองรับ ตัวอย่างเช่น การเรียก API ต่อไปนี้ แก้ไขคำอธิบายและชื่อที่แสดงสำหรับสกุลเงินที่สนับสนุน (พร็อพเพอร์ตี้ที่อัปเดต ได้แก่ ที่ไฮไลต์ในตัวอย่าง)

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

การลบสกุลเงินที่รองรับโดยใช้ API

ลบสกุลเงินที่รองรับโดยการส่งคำขอ DELETE ไปยัง /mint/organizations/{org_name}/supported-currencies/{currency_id} โดยที่ {currency_id} คือหมายเลขระบุสกุลเงินที่รองรับที่จะลบ สำหรับ ตัวอย่าง:

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

พร็อพเพอร์ตี้การกำหนดค่าสกุลเงินของ API

ตารางต่อไปนี้สรุปพร็อพเพอร์ตี้การกําหนดค่าที่ตั้งค่าได้โดยใช้ API

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
creditLimit

พร็อพเพอร์ตี้นี้มีไว้สำหรับนักพัฒนาซอฟต์แวร์แบบชำระเงินภายหลังเท่านั้น วงเงินเครดิตสำหรับ สกุลเงินที่รองรับ

ไม่มี ไม่ได้
คำอธิบาย

คำอธิบายสกุลเงินที่รองรับ

ไม่มี ใช่
displayName

ชื่อที่จะแสดงสำหรับสกุลเงินที่รองรับ

ไม่มี ใช่
minimumTopupAmount

พร็อพเพอร์ตี้นี้มีไว้สำหรับนักพัฒนาแอปที่ชำระเงินล่วงหน้าเท่านั้น จำนวนเงินขั้นต่ำที่นักพัฒนาแอปสามารถเพิ่มลงในยอดคงเหลือในบัญชีชำระล่วงหน้าในสกุลเงินที่ระบุ

ไม่มี ไม่ได้
ชื่อ

รหัส ISO 4217 สำหรับฟังก์ชัน เช่น USD สำหรับดอลลาร์สหรัฐ

ไม่มี ใช่
องค์กร

องค์กรสำหรับสกุลเงินที่รองรับ

ไม่มี ใช่
สถานะ

สถานะของสกุลเงินที่รองรับ ค่าที่ถูกต้องประกอบด้วย

  • ใช้งานอยู่: สกุลเงินที่รองรับพร้อมใช้งานแล้ว
  • ไม่ได้ใช้งาน: สกุลเงินที่รองรับไม่พร้อมใช้งาน
ไม่มี ใช่
virtualCurrency

ระบุว่าสกุลเงินที่รองรับเป็นสกุลเงินเสมือนหรือไม่ ค่าที่ถูกต้องประกอบด้วย

  • true: สกุลเงินที่รองรับเป็นสกุลเงินเสมือน
  • เท็จ: สกุลเงินที่รองรับไม่ใช่สกุลเงินเสมือน
ไม่มี ใช่