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

คุณกำลังดูเอกสารประกอบของ 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

เพิ่มสกุลเงินที่รองรับโดยการออกคำขอ POST ไปยัง /mint//organizations/{org_name}/supported-currencies สำหรับสกุลเงินที่รองรับแต่ละสกุลเงินที่คุณเพิ่ม คุณต้องระบุข้อมูลต่อไปนี้ในเนื้อหาคำขอ

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

คุณสามารถตั้งค่าต่อไปนี้ได้

• วงเงินเครดิตสำหรับสกุลเงินที่รองรับ (นักพัฒนาแอปแบบชำระเงินภายหลังเท่านั้น)
• การเติมเงินขั้นต่ำสำหรับสกุลเงินที่รองรับ (นักพัฒนาแอปแบบชำระเงินล่วงหน้าเท่านั้น)

ดูข้อมูลเพิ่มเติมได้ที่พร็อพเพอร์ตี้การกำหนดค่าสกุลเงินที่รองรับ

ตัวอย่างต่อไปนี้เพิ่มสกุลเงินที่รองรับสำหรับองค์กร

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

การตั้งค่าสกุลเงินเริ่มต้นโดยใช้ 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	ระบุว่าสกุลเงินที่รองรับเป็นสกุลเงินเสมือนหรือไม่ ค่าที่ถูกต้องได้แก่ จริง: สกุลเงินที่รองรับเป็นสกุลเงินเสมือน เท็จ: สกุลเงินที่รองรับไม่ใช่สกุลเงินเสมือน	ไม่มีข้อมูล	ใช่