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

כרגע מוצג התיעוד של 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

הוספת מטבעות נתמכים על ידי שליחת בקשת 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	הנכס הזה רלוונטי רק למפתחים שמשלמים לאחר השימוש (postpay). מסגרת האשראי של המטבע הנתמך.	לא רלוונטי	לא
תיאור	תיאור של המטבע הנתמך.	לא רלוונטי	כן
displayName	השם שיוצג עבור המטבע הנתמך.	לא רלוונטי	כן
minimumTopupAmount	הנכס הזה רלוונטי רק למפתחים ששולמו מראש. הסכום המינימלי שמפתחים יכולים להוסיף ליתרת החשבון בתשלום מראש במטבע שצוין.	לא רלוונטי	לא
name	קוד ISO 4217 של המטבע, למשל USD לדולר ארה"ב.	לא רלוונטי	כן
ארגון	הארגון של המטבע הנתמך.	לא רלוונטי	כן
status	הסטטוס של המטבע הנתמך. הערכים החוקיים כוללים: פעיל: המטבע הנתמך זמין לשימוש. לא פעיל: המטבע הנתמך לא זמין לשימוש.	לא רלוונטי	כן
virtualCurrency	מציין אם המטבע הנתמך הוא מטבע וירטואלי. הערכים החוקיים כוללים: True: המטבע הנתמך הוא מטבע וירטואלי. false: המטבע הנתמך הוא לא מטבע וירטואלי.	לא רלוונטי	כן