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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

מבוא

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

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

עבור מפתח שמשלמים לאחר השימוש (postpay), הזיכוי מופיע בשורה נפרדת בחשבונית ומפחית את החיוב בחשבונית.

סיור בדף 'זיכויים'

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

Edge

כדי לגשת לדף Credits באמצעות ממשק המשתמש של Edge:

  1. נכנסים לאתר apigee.com/edge.
  2. בסרגל הניווט הימני, בוחרים באפשרות פרסום > מונטיזציה > קרדיטים.

הדף 'זיכויים' מוצג.

כפי שמודגש באיור, הדף 'זיכויים' מאפשר לכם:

  • הצגת פרטי סיכום של כל הזיכויים, כולל שם מקבל התשלום, סכום הזיכוי, התאריך והשעה שבהם הזיכוי תקף, חבילת מוצרים של API ומוצרי API שעליהם חל הזיכוי וכל ההערות שנוספו
  • הנפקת זיכוי
  • חיפוש ברשימת הזיכויים

Classic Edge (ענן פרטי)

כדי לגשת לדף Credits באמצעות הממשק הקלאסי Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.
  2. בוחרים באפשרות מונטיזציה > דוחות מונטיזציה בסרגל הניווט העליון.

הדף 'זיכויים' מאפשר לכם:

  • הצגת פרטי סיכום של כל הזיכויים, כולל שם מקבל התשלום, סכום הזיכוי, התאריך והשעה שבהם הזיכוי תקף, חבילת מוצרים של API ומוצרי API שעליהם חל הזיכוי וכל ההערות שנוספו
  • הנפקת זיכוי
  • חיפוש ברשימת הזיכויים

הנפקת אשראי

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

    חודש החיוב שבו חל הזיכוי. בוחרים חודש מהרשימה.

    המפַתח

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

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

    חבילת מוצרים

    חבילת המוצרים של ה-API שעליה חל הזיכוי. יש לבחור מתוך הרשימה של חבילות המוצרים הזמינות של ממשק ה-API.

    מוצר

    מוצר ה-API בחבילת מוצרי ה-API שנבחרה שעליה חל הזיכוי. בוחרים מהרשימה את All Products (כל המוצרים) או מוצר API אחד (API).

    מטבע

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

    Amount

    סכום הזיכוי (במטבע שצוין). ציון ערך חיובי או שלילי. הערך לא יכול להיות אפס.

    הערה

    הערה אופציונלית לתיאור הסיבה לזיכוי.

  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.

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

במאמר פרמטרים של שאילתה לקרדיטים 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"
}

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

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

שם התיאור ברירת המחדל חובה?
billingMonth

חודש החיוב שעליו חל הזיכוי, למשל אפריל.

לא רלוונטי לא
billingYear

שנת החיוב שעליה חל הזיכוי, למשל 2018.

לא רלוונטי לא
currencyId

המטבע המשמש לזיכוי. המטבע מוגדר לתוכנית המחירים בחבילת המוצרים של ה-API שהמפתח רכש ולא ניתן לשנות אותו.

לא רלוונטי כן
developerId

שם המפתח או החברה שעליהם חל הזיכוי.

לא רלוונטי כן
productId

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

לא רלוונטי לא
transactionAmount

סכום הזיכוי (במטבע שצוין). ציון ערך חיובי או שלילי. הערך לא יכול להיות אפס.

לא רלוונטי כן
transactionNote

לתשומת ליבכם, תיאור של סיבת הזיכוי.

לא רלוונטי כן