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

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

บทนำ

ทีมกำหนดค่า 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