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

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

מבוא

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

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

אצל מפתח בתשלום לאחר השימוש (postpay), הקרדיט מופיע כך: בשורה נפרדת בחשבונית, כך שיפחיתו את החיוב בחשבונית.

התנסות בדף 'קרדיטים'

נכנסים לדף 'זיכויים' ומעיינים בו, כפי שמתואר בהמשך.

הנפקת זיכוי

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.

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

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

$ 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"
}

פרמטרים של שאילתות ל-Credits API

הפרמטרים הבאים של השאילתות זמינים לשימוש ב-Credit API: