ניהול המטבעות הנתמכים

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

מבוא

כחלק מתהליך ההגדרה הראשוני של המונטיזציה, צוות התצורה של Apigee Edge מגדיר את המטבעות ואת מטבע ברירת המחדל שנתמכים על ידי הארגון.

כאן אפשר לראות באילו מטבעות הארגון תומך, להוסיף מטבעות נתמכים או למחוק מטבעות נתמכים (אם המפתחים או תוכנית התמחור והתשלומים לא משתמשים במטבעות האלה).

ניהול מטבעות נתמכים באמצעות ממשק המשתמש

ניהול המטבעות הנתמכים והגדרת מטבע ברירת המחדל בשדות 'מס' ו'מטבע' בקטע 'פרופיל הארגון'. ניהול את פרופיל הארגון באמצעות ממשק המשתמש.

ניהול מטבעות נתמכים באמצעות ה-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.