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

כרגע מוצג התיעוד של 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 ספציפית, ההתאמה תחול על כל המפתחים (שהם מפתחים בתשלום לאחר השימוש) ועל מוצר התשלום בכל חבילות ה-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

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

שם	התיאור	ברירת המחדל	חובה?
name	שם תיאורי להתאמת החיוב.	לא רלוונטי	כן
adjustmentPercentageFactor	סכום ההתאמה, כאחוז מספרי חיובי או שלילי. אחוז חיובי מתאים את חלוקת ההכנסות או העמלות בעסקה לפי האחוז הזה. אחוז שלילי מתאים את החלק בהכנסות או העמלות בעסקה לפי האחוז הזה. הערכים יכולים לנוע בין -100 ל-999.9999.	לא רלוונטי	כן
billingMonth	חודש החיוב עבור התאמת החיוב, המצוין כמספר שלם. לדוגמה, 11 בדצמבר.	לא רלוונטי	כן
billingYear	שנת החיוב עבור התאמת החיוב, המצוינת בפורמט הבא: YYYY. לדוגמה, 2017.	לא רלוונטי	כן
organization	הארגון שעליו חלה התאמת החיוב.	לא רלוונטי	כן
isPublished	סימון שמציין אם ההתאמה צריכה להתפרסם. הערך יכול להיות אחד מהערכים הבאים: true. צריך לפרסם את התאמת החיוב. false. אין לפרסם את התאמת החיוב.	לא רלוונטי	לא
transactionType	סוג העסקאות שעבורן חלה התאמת החיוב. הסוג יכול להיות אחת מהאפשרויות הבאות: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS. אלה טרנזקציות שמשמשות להתאמה מחדש של טרנזקציות לפי דירוג. הן מופעלות כשמתבצעים שינויים במיסים בחודש החיוב הקודם.	לא רלוונטי	לא
developerBillingType	סוג החיוב של המפתח שעליו חלה התאמת החיוב. הערך יכול להיות אחת מהאפשרויות הבאות: PREPAID.. מפתחים ששילמו מראש. POSTPAID. מפתחים שמשלמים לאחר השימוש (postpay). BOTH. מפתחים שמשלמים מראש ומשלמים לאחר השימוש (postpay).	לא רלוונטי	לא
product	מוצר ה-API שעבורו חלה התאמת החיוב. אם לא תציינו את המאפיין הזה, התאמת החיוב תחול על כל מוצרי ה-API.	לא רלוונטי	לא
monetizationPackage	חבילת ה-API שעליה חלה התאמת החיוב. אם לא תציינו את המאפיין הזה, התאמת החיוב תחול על כל חבילות ה-API.	לא רלוונטי	לא
developer	המפתח שעבורו חלה התאמת החיוב. אם לא תציינו את הנכס הזה, התאמת החיוב תחול על כל המפתחים.	לא רלוונטי	לא

השלבים הבאים

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