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

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

מבוא

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

הסבר על הדף 'התאמות בחיוב'

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

בדוגמה הבאה מבוצעת התאמת חיוב לחודש החיוב הפתוח, יוני 2013. ההתאמה מפחיתה את הסכום ב-3% ומוחלת על עסקאות רכישה, על מוצר התשלום ועל מפתחים שמשלמים בסוף החודש. מאחר שלא צוינו המאפיינים לזיהוי מפתח או חבילת API ספציפיים, ההתאמה תוחל על כל המפתחים (שהם מפתחים עם תשלום בסוף החודש) ועל מוצר התשלום בכל חבילות ה-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

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

השלבים הבאים

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