הנפקת הזיכויים

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

מבוא

המונטיזציה מאפשרת לכם להנפיק קרדיט למפתחים.

אצל מפתחים שמשלמים מראש, הזיכוי מופיע כהפחתה בשימוש – כך היתרה מההפקדה של המפתח גדלה או קטנה בהתאם. בדומה לשימוש בכרטיס חיוב מיידי, כספים נמשכים מהיתרה מההפקדה של המפתח כשהמפתח רוכש חבילת מוצרים של API. המפתח חייב לשמור על יתרה מספקת לרכישות. איך מחשבים את היתרה שנותרה בחשבון שמוגדר לתשלום מראש?

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

הדף 'קרדיטים'

ניגשים לדף 'קרדיטים' ומעיינים בו, כמו שמתואר בהמשך.

הנפקת זיכוי

1. כניסה לדף Credits.
2. לוחצים על + אשראי.
3. הזן את המידע הבא:

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

4. לוחצים על שמירת הקרדיט.

הנפקת זיכויים באמצעות ה-API

באמצעות ה-API, אפשר להעניק קרדיט למפתח על חבילת מוצרי API שלמה, או על השימוש במוצר API ספציפי בחבילת מוצרי API.

כדי להנפיק קרדיט באמצעות ה-API, שולחים בקשת POST אל /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions, כאשר {package_id} ו-{rate-plan_id} מגדירים את המזהה של חבילת מוצרי ה-API ותוכנית התמחור שאליהן הקרדיט מתייחס, בהתאמה.

כשמנפיקים את הבקשה, צריך לציין כפרמטרים של שאילתה:

• מזהה המפתח (כתובת אימייל) שאליו יחול הזיכוי.
• סכום הזיכוי.
• המטבע שבו ניתן הקרדיט.
• הערה שמתארת את הסיבה למתן הזיכוי.

אפשר גם לציין את הפרמטרים הנוספים הבאים של שאילתה:

• חודש החיוב שבו חל הזיכוי. ערך ברירת המחדל הוא החודש הנוכחי.
• שנת החיוב שבה הזיכוי רלוונטי. ערך ברירת המחדל הוא השנה הנוכחית.
• מוצר ה-API שאליו הזיכוי משויך. אם לא מציינים מזהה של מוצר API, הזיכוי חל על כל מוצרי ה-API בחבילת מוצרי ה-API.

לדוגמה, הבקשה הבאה מנפיקה זיכוי בסך 100 $לחודש החיוב אפריל 2018 למפתח שמזוהה בתור dev1@myorg.com. הקרדיט חל על חבילת מוצרי payment API ותוכנית התמחור payment_standard_plan:

כאן מפורטת רשימה מלאה של פרמטרים של שאילתות שאפשר לציין בבקשה לקבלת זיכוי.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

בהמשך מופיעה דוגמה לתגובה:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

פרמטרים של שאילתה ל-API של הקרדיטים

אפשר להשתמש בפרמטרים הבאים של שאילתות עם Credits API: