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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

מבוא

כחלק מההגדרה הראשונית של המונטיזציה, צוות ההגדרה של 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

אפשר להוסיף מטבעות נתמכים על ידי שליחת בקשת 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 לדולר ארה"ב.	לא רלוונטי	כן
ארגון	הארגון שמוגדר בו המטבע הנתמך.	לא רלוונטי	כן
status	הסטטוס של המטבע הנתמך. הערכים החוקיים כוללים: פעיל: אפשר להשתמש במטבע הנתמך. לא פעיל: המטבע הנתמך לא זמין לשימוש.	לא רלוונטי	כן
virtualCurrency	מציין אם המטבע הנתמך הוא מטבע וירטואלי. הערכים החוקיים כוללים: true: המטבע הנתמך הוא מטבע וירטואלי. false: המטבע הנתמך הוא לא מטבע וירטואלי.	לא רלוונטי	כן