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

אתם צופים במסמכי התיעוד של 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.