ביצוע התאמות חיוב

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

מבוא

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

עיון בדף 'התאמות החיוב'

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

הוספה של התאמת חיוב

כדי להוסיף התאמת חיוב:

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

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

4. לוחצים על יצירת התאמה.

עריכה של התאמת חיוב

כדי לערוך התאמת חיוב:

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

ביצוע התאמות חיוב באמצעות ממשק ה-API

בקטעים הבאים מוסבר איך לבצע התאמות חיוב באמצעות ה-API.

ביצוע התאמת חיוב באמצעות ה-API

ניתן לשנות את פרטי החיוב על ידי שליחת בקשת POST אל /organizations/{org_name}/billing-adjustments. כשתשלחו את הבקשה, עליכם לציין גוף הבקשה:

• השם של התאמת החיוב.
• אחוז התאמה, כלומר ערך אחוז חיובי או שלילי מגדיל או מקטין את החיוב, בהתאמה.
• חודש החיוב.
• שנת החיוב.
• הארגון שעליו חלה התאמת החיוב.

אפשר גם לציין מאפיינים אחרים, כמו:

• סוג העסקה שעליה רוצים להחיל את ההתאמה (למשל רכישה העסקה).
• המפתח שעליו רוצים להחיל את ההתאמה.
• אם רוצים להחיל את ההתאמה על מפתחים שמשלמים מראש, על מפתחים שמשלמים לאחר השימוש (postpay), או ובשניהם.
• חבילת ה-API שעליה רוצים להחיל את ההתאמה.
• מוצר ה-API שעליו רוצים להחיל את ההתאמה.

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

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

בדוגמה הבאה מתבצעת התאמת חיוב לחודש הפתוח, יוני 2013. ההתאמה מפחיתה פקטור של 3% וחלה על עסקאות רכישה, של מוצרי תשלום, ומפתחים של תשלום לאחר השימוש (postpay). כי המאפיינים של זיהוי חבילת המפתח או חבילת ה-API לא צוינו, ההתאמה תחול על כל המפתחים ( הם מפתחים שמשלמים לאחר השימוש (postpay)), ומוצר התשלום בכל חבילות ה-API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

התשובה אמורה להיראות בערך כך (מוצג רק חלק מהתשובה):

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

הצגה של התאמות חיוב באמצעות ה-API

אפשר לראות התאמת חיוב ספציפית או את כל התאמות החיוב לפי ארגון. כדי להציג התאמת חיוב ספציפית, יש לשלוח בקשת GET אל /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, כאשר {billing_adjustment_id} הוא הזיהוי של התאמת החיוב הספציפית (המזהה מוחזר בתשובה כשיוצרים את התאמת החיוב). לדוגמה:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

כדי לצפות בכל התאמות החיוב בארגון, יש לשלוח בקשת GET אל /organizations/{org_name}/billing-adjustments לדוגמה:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

התשובה אמורה להיראות בערך כך (מוצג רק חלק מהתשובה):

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

עדכון של התאמת חיוב באמצעות ה-API

ניתן לעדכן התאמת חיוב על ידי שליחת בקשת PUT /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, כאשר {billing_adjustment_id} הוא הזיהוי של התאמת החיוב הספציפית. בזמן ביצוע העדכון, עליכם לציין בגוף הבקשה את המאפיינים המעודכנים ואת זיהוי התאמת החיוב שצריך לעדכן. צריך גם לציין את מאפיינים של התאמת החיוב. כלומר, מאפיינים של השם, אחוז ההתאמה, חודש החיוב, שנת החיוב והארגון.

לדוגמה, בקריאה הבאה ל-API מתעדכנים השם ואחוז ההתאמה (החלק המאפיינים המעודכנים מודגשים בדוגמה):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

מחיקה של התאמת חיוב באמצעות ה-API

ניתן למחוק התאמת חיוב על ידי שליחת בקשת DELETE אל /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, כאשר {billing_adjustment_id} הוא המזהה של התאמת החיוב שתיקבע נמחק. לדוגמה:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

הגדרות אישיות של התאמת חיוב ב-API

אפשרויות ההגדרה הבאות זמינות להתאמות חיוב:

השלבים הבאים

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