กำหนดค่าแพ็กเกจราคาด้วยแอตทริบิวต์ที่กำหนดเอง

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X info

บทนำ

ในบางกรณี คุณอาจต้องการให้ตัวนับธุรกรรมอิงตามตัวแปรหรือค่าที่กำหนดเอง เช่น คุณอาจต้องการดำเนินการต่อไปนี้

• เรียกเก็บเงินจากนักพัฒนาแอปเป็นจำนวนเงินที่เปลี่ยนแปลงได้โดยอิงตามค่าที่ระบุไว้ในข้อความของการเรียก API เช่น คุณอาจต้องการเรียกเก็บเงินจากนักพัฒนาแอปตามจำนวนไบต์ ที่ส่งในคำขอ API
• รวมการเรียก API หลายรายการไว้ในธุรกรรมเดียว

การใช้แพ็กเกจราคาที่มีแอตทริบิวต์ที่กำหนดเองช่วยให้คุณระบุค่าในข้อความของการเรียก API ที่ทำหน้าที่เป็นตัวนับ และใช้ในการคำนวณจำนวนธุรกรรมและการเรียกเก็บเงินได้

ระบบรองรับแพ็กเกจราคาต่อไปนี้ที่มีแอตทริบิวต์ที่กำหนดเอง

• บัตรราคาที่มีแอตทริบิวต์ที่กำหนดเอง
• การแจ้งเตือนแบบปรับได้ที่มีแอตทริบิวต์ที่กำหนดเอง

คุณตั้งค่าแอตทริบิวต์ที่กำหนดเองได้สูงสุด 10 รายการต่อแพ็กเกจราคา

ทำความเข้าใจการคำนวณแอตทริบิวต์ที่กำหนดเอง

วิธีที่ค่าแอตทริบิวต์ที่กำหนดเองนำมาพิจารณาในการคำนวณจำนวนธุรกรรมและการเรียกเก็บเงินของแพ็กเกจราคา จะขึ้นอยู่กับรูปแบบการเรียกเก็บเงิน ดังที่สรุปไว้ในตารางต่อไปนี้

ตำแหน่งที่แพ็กเกจราคาดึงค่าแอตทริบิวต์ที่กำหนดเอง

นโยบายการบันทึกธุรกรรม (ในแพ็กเกจผลิตภัณฑ์ API) จะบอกระบบการสร้างรายได้ว่าจะดูค่าแอตทริบิวต์ที่กำหนดเองใน ข้อความได้ที่ใด คุณกำหนดแอตทริบิวต์ที่กำหนดเองในส่วนแอตทริบิวต์ที่กำหนดเอง ของนโยบายการบันทึกธุรกรรมสำหรับแพ็กเกจผลิตภัณฑ์ API

จากนั้นคุณสามารถเลือกแอตทริบิวต์ที่กำหนดเองนั้นในแพ็กเกจราคาได้หลังจากสร้างแพ็กเกจผลิตภัณฑ์ API ที่มีนโยบายการบันทึกธุรกรรมพร้อมแอตทริบิวต์ที่กำหนดเอง

ขั้นตอนระดับสูงมีดังนี้

1. กำหนดแอตทริบิวต์ที่กำหนดเองเมื่อ เพิ่มผลิตภัณฑ์ API
2. สร้างแพ็กเกจผลิตภัณฑ์ API ที่มีผลิตภัณฑ์
   ในนโยบายการบันทึกธุรกรรมสำหรับแพ็กเกจผลิตภัณฑ์ API ให้เพิ่มแอตทริบิวต์ที่กำหนดเองที่จะใช้ กำหนดแพ็กเกจราคา
3. สร้างแพ็กเกจราคาประเภทบัตรราคาหรือการแจ้งเตือนแบบปรับได้ สำหรับแพ็กเกจผลิตภัณฑ์ API และระบุพารามิเตอร์การให้คะแนนที่กำหนดเอง

รูปภาพต่อไปนี้แสดงความสัมพันธ์ระหว่างแอตทริบิวต์ที่กำหนดเองที่กำหนดไว้ใน นโยบายการบันทึกธุรกรรมกับการกำหนดค่าแพ็กเกจบัตรราคา ความสัมพันธ์ของแพ็กเกจราคาการแจ้งเตือนแบบปรับได้ที่มีแอตทริบิวต์ที่กำหนดเองจะคล้ายกัน แม้ว่าจะใช้ค่าแบบเป็นช่วงตามปริมาณไม่ได้ก็ตาม

วิธีสร้างค่าแอตทริบิวต์ที่กำหนดเอง ในข้อความ

นโยบายการบันทึกธุรกรรมสามารถค้นหาค่าแอตทริบิวต์ที่กำหนดเองได้ในหลายที่ เช่น ส่วนหัวการตอบกลับ เนื้อหาของการตอบกลับ หรือตัวแปรโฟลว์ที่กำหนดไว้ล่วงหน้าในการตอบกลับ (คำขอไม่พร้อมใช้งานเนื่องจากธุรกรรมจะยังไม่เป็นทางการจนกว่าคุณจะได้รับการตอบกลับที่สำเร็จ ) ตัวอย่างต่อไปนี้แสดงวิธีเพิ่มส่วนหัวการตอบกลับ พร้อมค่าตัวเลขลงในข้อความ ในทั้ง 2 กรณี เราจะใช้นโยบายการกำหนดข้อความร่วมกับตัวแปร

การเพิ่มขนาดเพย์โหลดของคำขอลงในส่วนหัวของการตอบกลับ

ในคำขอแชทแต่ละรายการจะมีตัวแปร client.received.content.length ที่มีจำนวนไบต์ในเพย์โหลดของคำขอ การแนบนโยบายการกำหนดข้อความกับการตอบกลับของ พร็อกซีปลายทางช่วยให้เราสร้างส่วนหัวการตอบกลับที่ชื่อว่า messageSize ซึ่ง มีค่าความยาวได้

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

การเพิ่มค่าแอตทริบิวต์ที่กำหนดเองของแอปลงในส่วนหัว

ในลักษณะเดียวกัน เราสามารถสร้างส่วนหัวที่มีค่าแอตทริบิวต์ที่กำหนดเองในแอปได้ เช่น หากคุณใส่แอตทริบิวต์ที่กำหนดเองชื่อ apprating ในแอปของนักพัฒนาแอปแต่ละแอป ดังนี้

เมื่อใช้นโยบายการยืนยันคีย์ API (ซึ่งจำเป็นสำหรับการสร้างรายได้) ระบบจะจัดเก็บค่านี้ไว้ในตัวแปรชื่อ verifyapikey.{policy_name}.apprating การใช้นโยบายการกำหนดข้อความที่แนบกับการตอบกลับของพร็อกซีปลายทางจะช่วยให้คุณสร้างส่วนหัวชื่อ apprating ที่มีค่า apprating ของแอปได้

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

การตั้งค่าแพ็กเกจราคา

นอกจากการตั้งค่าแอตทริบิวต์ที่กำหนดเองตามที่อธิบายไว้ข้างต้นแล้ว คุณจะตั้งค่าแพ็กเกจราคาในลักษณะเดียวกับที่ทำตามปกติ (สำหรับแพ็กเกจราคาที่ไม่มีแอตทริบิวต์ที่กำหนดเอง) แต่ต้องเป็นไปตามข้อกำหนดต่อไปนี้

การกำหนดค่าแพ็กเกจบัตรราคาที่มีแอตทริบิวต์ที่กำหนดเองโดยใช้ UI

กำหนดค่าแพ็กเกจบัตรราคาที่มีแอตทริบิวต์ที่กำหนดเองโดยใช้ Edge UI หรือ Classic Edge UI ตามที่อธิบายไว้ในส่วนต่อไปนี้

การกำหนดค่าแพ็กเกจการแจ้งเตือนแบบปรับได้ที่มีแอตทริบิวต์ที่กำหนดเองโดยใช้ UI

การระบุรายละเอียดสำหรับแพ็กเกจราคาที่มีแอตทริบิวต์ที่กำหนดเองโดยใช้ API

ทำตามขั้นตอนเบื้องต้นต่อไปนี้

1. ในนโยบายการบันทึกธุรกรรมของผลิตภัณฑ์ API ให้เพิ่มแอตทริบิวต์ที่กำหนดเองที่จะใช้ กำหนดแพ็กเกจราคา ดูรายละเอียดได้ที่บทนำในหัวข้อนี้ รวมถึงหัวข้อสร้างนโยบายการบันทึกธุรกรรม ทำเช่นนี้กับผลิตภัณฑ์ API แต่ละรายการที่คุณต้องการรวมไว้ในแพ็กเกจ API
2. เมื่อกำหนดค่าผลิตภัณฑ์ API และนโยบายการบันทึกธุรกรรมตามที่คุณ ต้องการแล้ว ให้สร้างแพ็กเกจ API ที่มีผลิตภัณฑ์ ดูหัวข้อสร้างแพ็กเกจ API

จากนั้นใช้ API เพื่อสร้างแพ็กเกจราคา

คุณระบุรายละเอียดสำหรับแพ็กเกจราคาที่มีแอตทริบิวต์ที่กำหนดเองเมื่อสร้างแพ็กเกจราคา โดยระบุรายละเอียดในพร็อพเพอร์ตี้ ratePlanDetails ภายในเนื้อหาของคำขอในการเรียกไปยัง /organizations/{org_name}/monetization-packages/{package_id}/rate-plans ใน รายละเอียด ให้ระบุค่าพารามิเตอร์การให้คะแนนที่ระบุชื่อแอตทริบิวต์ที่กำหนดเอง นอกจากนี้ คุณยังระบุค่าพารามิเตอร์การให้คะแนนที่รวมแอตทริบิวต์ที่กำหนดเอง ในช่วงเวลาที่ระบุได้ด้วย

ดูรายการตัวเลือกรายละเอียดแพ็กเกจราคาทั้งหมดได้ที่หัวข้อการตั้งค่าการกำหนดค่ารายละเอียดแพ็กเกจราคา Rate plan details configuration settings

ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจบัตรราคาที่มีแอตทริบิวต์ที่กำหนดเองโดยอิงตามแอตทริบิวต์ที่กำหนดเองชื่อ messageSize (ดูรายการในตัวหนา)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

ตัวอย่างต่อไปนี้จะสร้างแพ็กเกจราคาการแจ้งเตือนแบบปรับได้ที่มีแอตทริบิวต์ที่กำหนดเองโดยอิงตามแอตทริบิวต์ที่กำหนดเองชื่อ messageSize (ดูรายการในตัวหนา)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "messageSize",
           "ratingParameterUnit": "MB",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password