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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

מבוא

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

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

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

הדף 'זיכויים'

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

הנפקת זיכוי

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

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

4. לוחצים על Save Credit.

הנפקת זיכויים באמצעות ה-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:

פרמטרים של שאילתות ל-Credits 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:

שם	תיאור	ברירת מחדל	חובה?
billingMonth	חודש החיוב שבו חל הזיכוי, למשל APRIL.	לא רלוונטי	לא
billingYear	שנת החיוב שבה חל הקרדיט, למשל 2018.	לא רלוונטי	לא
currencyId	המטבע המשמש לזיכוי. המטבע מוגדר לתוכנית התמחור בחבילת מוצרי ה-API שהמפתח רכש, ואי אפשר לשנות אותו.	לא רלוונטי	כן
developerId	שם המפתח או החברה שעליהם חל הזיכוי.	לא רלוונטי	כן
productId	מוצר API שעליו חל הזיכוי. אם לא מציינים מזהה מוצר, הזיכוי יחול על כל מוצרי ה-API בחבילת המוצרים של ה-API.	לא רלוונטי	לא
transactionAmount	סכום הזיכוי (במטבע שצוין). מציינים ערך חיובי או שלילי. הערך לא יכול להיות אפס.	לא רלוונטי	כן
transactionNote	הערה שמתארת את הסיבה לזיכוי.	לא רלוונטי	כן