API প্রোডাক্ট বান্ডেল ম্যানেজ করা

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশন দেখুন। তথ্য

নিচের বিভাগে বর্ণিত API প্রোডাক্ট বান্ডেল নামে পরিচিত একটি মনিটাইজ করা কন্টেনারে এক বা একাধিক API প্রোডাক্ট বান্ডেল করুন।

API প্রোডাক্ট বান্ডেল কী?

API প্রোডাক্ট বান্ডেল হল API প্রোডাক্টের একটি সংগ্রহ যা ডেভেলপারদের কাছে একটি গ্রুপ হিসেবে উপস্থাপন করা হয় এবং সাধারণত মনিটাইজেশনের জন্য এক বা একাধিক রেট প্ল্যানের সাথে যুক্ত থাকে। আপনি একাধিক API প্রোডাক্ট বান্ডেল তৈরি করতে এবং প্রতিটিতে এক বা একাধিক API প্রোডাক্ট অন্তর্ভুক্ত করতে পারবেন। আপনি একই API প্রোডাক্ট বা প্রোডাক্টগুলি আলাদা আলাদা বান্ডেলে রাখতে এবং সেগুলিকে আলাদা আলাদা (বা একই) রেট প্ল্যানের সাথে যুক্ত করতে পারবেন।

API প্রোডাক্ট বান্ডেল ব্যবহার করার জন্য ডেভেলপাররা বর্তমানে চালু থাকা কোনও রেট প্ল্যান কিনেই শুধু তাদের অ্যাপ রেজিস্টার করতে পারবেন। আপনি প্রোডাক্ট বান্ডেলের জন্য রেট প্ল্যান যোগ করে প্রকাশ (সর্বজনীন হিসেবে) না করা পর্যন্ত API প্রোডাক্ট বান্ডেল ডেভেলপারদের কাছে দৃশ্যমান হয় না (বর্তমান তারিখ বা ভবিষ্যতের তারিখের শুরুর তারিখ সহ), যা রেট প্ল্যান ম্যানেজ করা নিবন্ধে বর্ণনা করা হয়েছে। আপনি রেট প্ল্যান যোগ করে প্রকাশ করার পরে, আপনার ডেভেলপার পোর্টাল লগ-ইন করা ডেভেলপাররা API প্রোডাক্ট বান্ডেল বেছে নিতে পারবেন এবং রেট প্ল্যান বেছে নিতে পারবেন। বিকল্প হিসেবে, ম্যানেজমেন্ট API ব্যবহার করে আপনি কোনও ডেভেলপারের জন্য রেট প্ল্যান গ্রহণ করতে পারেন। আরও তথ্যের জন্য, API ব্যবহার করে প্রকাশিত রেট প্ল্যান কেনা দেখুন।

API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট যোগ করার পরে, আপনাকে হয়ত API প্রোডাক্টের জন্য প্রাইস পয়েন্ট সেট-আপ করতে হবে। নিম্নলিখিত সবগুলি সত্যি হলে তবেই আপনাকে এটি করতে হবে:

• আপনি API প্রোডাক্টের জন্য উপার্জন শেয়ার করার রেট প্ল্যান সেট-আপ করেছেন।
• API প্রোডাক্টে রিসোর্স ব্যবহারের জন্য ডেভেলপাররা থার্ড-পার্টিকে চার্জ করে।
• ডেভেলপাররা যে পরিমাণ চার্জ করতে পারেন তার উপর ন্যূনতম বা সর্বাধিক বিধিনিষেধ রয়েছে এবং আপনি বিধিনিষেধ সম্পর্কে ডেভেলপারদের জানাতে চান।

API প্রোডাক্ট বান্ডেলের বিবরণে ন্যূনতম ও সর্বাধিক দাম দেখানো হয়।

প্রোডাক্ট বান্ডেল পৃষ্ঠা এক্সপ্লোর করা

নিচে বর্ণনা করা পদ্ধতি অনুযায়ী প্রোডাক্ট বান্ডেল পৃষ্ঠা অ্যাক্সেস করুন।

প্রোডাক্ট বান্ডেল যোগ করা

API প্রোডাক্ট বান্ডেল যোগ করতে:

1. প্রোডাক্ট বান্ডেল পৃষ্ঠায় + API প্রোডাক্ট বান্ডেল বিকল্পে ক্লিক করুন।
2. API প্রোডাক্ট বান্ডেলের নাম লিখুন।

3. 'প্রোডাক্ট যোগ করুন' ফিল্ডে API প্রোডাক্টের নাম লিখুন।

   আপনি কোনও API প্রোডাক্টের নাম টাইপ করার সময়, ড্রপ-ডাউনে সেইসব API প্রোডাক্টের একটি তালিকা দেখানো হয় যেগুলিতে স্ট্রিং রয়েছে। বান্ডেলে যোগ করতে API প্রোডাক্টের নামে ক্লিক করুন। অতিরিক্ত API প্রোডাক্ট যোগ করতে এই ধাপগুলি আবার অনুসরণ করুন।

4. অতিরিক্ত API প্রোডাক্টের নাম যোগ করতে ৩ নম্বর ধাপটি আবার করুন।
5. আপনি যোগ করেন এমন প্রতিটি API প্রোডাক্টের জন্য, ট্রানজ্যাকশন রেকর্ডিং নীতি কনফিগার করুন।
6. প্রোডাক্ট বান্ডেল সেভ করুন বিকল্পে ক্লিক করুন।

প্রোডাক্ট বান্ডেল এডিট করা

প্রোডাক্ট বান্ডেল এডিট করতে:

1. প্রোডাক্ট বান্ডেল পৃষ্ঠায়, আপনি যে প্রোডাক্ট বান্ডেল এডিট করতে চান সেটির সারিতে ক্লিক করুন।

   প্রোডাক্ট বান্ডেল প্যানেল দেখানো হয়।

2. প্রয়োজন অনুযায়ী প্রোডাক্ট বান্ডেলের ফিল্ড এডিট করুন।

   আরও তথ্যের জন্য ট্রানজ্যাকশন রেকর্ডিং নীতি কনফিগার করুন দেখুন।

3. প্রোডাক্ট বান্ডেল আপডেট করুন বিকল্পে ক্লিক করুন।

API ব্যবহার করে API প্রোডাক্ট বান্ডেল ম্যানেজ করা

API ব্যবহার করে কীভাবে API প্রোডাক্ট বান্ডেল ম্যানেজ করতে হয় তা নিম্নলিখিত বিভাগে বর্ণনা করা হয়েছে।

API ব্যবহার করে API প্রোডাক্ট বান্ডেল তৈরি করা

API প্রোডাক্ট বান্ডেল তৈরি করতে, /organizations/{org_name}/monetization-packages-এ একটি POST অনুরোধ ইস্যু করুন। আপনি অনুরোধ করলে, আপনাকে অবশ্যই:

• API প্রোডাক্ট বান্ডেলে অন্তর্ভুক্ত করার জন্য API প্রোডাক্ট শনাক্ত করুন।
• API প্রোডাক্ট বান্ডেলের নাম ও বিবরণ উল্লেখ করুন।
• API প্রোডাক্ট বান্ডেলের জন্য স্ট্যাটাস ইন্ডিকেটর সেট করুন। স্ট্যাটাস ইন্ডিকেটরে নিম্নলিখিত মানগুলির মধ্যে একটি থাকতে পারে: CREATED, ACTIVE, INACTIVE. বর্তমানে, আপনার নির্দিষ্ট করা স্ট্যাটাস ইন্ডিকেটর ভ্যালু API প্রোডাক্ট বান্ডেলে বজায় রাখা হয়, কিন্তু এটি কোনও উদ্দেশ্যে ব্যবহার করা হয় না।

ঐচ্ছিকভাবে, আপনি সংস্থার নাম উল্লেখ করতে পারেন।

API-তে উপলভ্য বিকল্পের তালিকা পেতে API প্রোডাক্ট বান্ডেল কনফিগারেশন প্রপার্টি দেখুন।

যেমন:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "description": "payment messaging package",
     "displayName": "Payment Messaging Package",
     "name": "Payment Messaging Package",
     "organization": { "id": "{org_name}" },
     "product": [
       { "id": "messaging" },
       { "id": "payment" }
     ],
     "status": "CREATED"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages" \
-u email:password

উত্তরের একটি উদাহরণ নিচে দেওয়া হল:

{
   "description" : "payment messaging package",
   "displayName" : "Payment Messaging Package",
   "id" : "payment_messaging_package",
   "name" : "Payment Messaging Package",
   "organization" : {
     "id" : "{org_name}",
     "separateInvoiceForFees" : false
   },
   "product" : [ {
     "customAtt1Name" : "user",
     "description" : "Messaging",
     "displayName" : "Messaging",
     "id" : "messaging",
     "name" : "messaging",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }, {
     "customAtt1Name" : "user",
     "description" : "Payment",
     "displayName" : "Payment",
     "id" : "payment",
     "name" : "payment",
     "organization" : {
       "id" : "{org_name}",
       "separateInvoiceForFees" : false
     },
     "status" : "CREATED"
   }],
   "status" : "CREATED"
 }

লক্ষ্য করুন, উত্তরে API প্রোডাক্ট এবং সেইসব API প্রোডাক্টের জন্য নির্দিষ্ট করা যেকোনও কাস্টম অ্যাট্রিবিউট সম্পর্কে অতিরিক্ত তথ্য অন্তর্ভুক্ত থাকে। (আপনি API প্রোডাক্ট তৈরি করার সময় কাস্টম অ্যাট্রিবিউট নির্দিষ্ট করেন।) API প্রোডাক্টের কাস্টম অ্যাট্রিবিউট বিভিন্ন রেট প্ল্যানে ফ্যাক্টর করা যেতে পারে। যেমন, আপনি যদি এমন একটি রেট কার্ড প্ল্যান সেট-আপ করেন যেখানে আপনি প্রতিটি ট্রানজ্যাকশনের জন্য ডেভেলপারকে চার্জ করেন, তাহলে আপনি কোনও ট্রানজ্যাকশনে ট্রান্সমিট করা বাইটের সংখ্যার মতো কাস্টম অ্যাট্রিবিউটের উপর ভিত্তি করে প্ল্যানের রেট সেট করতে পারেন।

API ব্যবহার করে API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট ম্যানেজ করা

আপনি API প্রোডাক্ট বান্ডেল থেকে API ব্যবহার করে কোনও API প্রোডাক্ট যোগ করতে বা মুছে দিতে পারবেন, যেমনটি নিম্নলিখিত বিভাগে বর্ণনা করা হয়েছে।

API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট যোগ করা

API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট যোগ করতে, organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}-এ POST অনুরোধ ইস্যু করুন, যেখানে {org_name} আপনার সংস্থার নাম, {package_id} API প্রোডাক্ট বান্ডেলের নাম এবং {product_id} API প্রোডাক্টের আইডি নির্দিষ্ট করে।

যেমন:

$ curl -H "Accept:application/json" -X POST -d \
'{}'\
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API প্রোডাক্ট-নির্দিষ্ট রেট প্ল্যান সহ API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট যোগ করা

এক বা একাধিক API প্রোডাক্ট-নির্দিষ্ট রেট প্ল্যান (রেট কার্ড বা রেভিনিউ শেয়ার) সংজ্ঞায়িত করা আছে এমন API প্রোডাক্ট বান্ডেলে API প্রোডাক্ট যোগ করতে, organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}-এ একটি POST অনুরোধ ইস্যু করুন, যেখানে {org_name} আপনার সংস্থার নাম, {package_id} API প্রোডাক্ট বান্ডেলের নাম এবং {product_id} API প্রোডাক্টের আইডি নির্দিষ্ট করে।

অনুরোধের বডিতে নতুন API প্রোডাক্টের জন্য রেট প্ল্যানের বিবরণ আপনাকে অবশ্যই পাস করতে হবে। ratePlanRates অ্যারে বাদ দিয়ে, রেট প্ল্যানের ভ্যালু অবশ্যই অন্যান্য সব API প্রোডাক্টের জন্য নির্দিষ্ট করা ভ্যালুর সাথে ম্যাচ করতে হবে। নির্ধারণ করা যায় এমন রেট প্ল্যান অ্যাট্রিবিউট সম্পর্কে আরও তথ্য পেতে, রেট প্ল্যানের জন্য কনফিগারেশন প্রপার্টিদেখুন।

যেমন:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "ratePlan": [ 
        {
            "id": "mypackage_rateplan1",
            "ratePlanDetails": [
                {
                    "currency": {
                        "id": "usd"
                    },
                    "duration": 1,
                    "durationType": "MONTH",
                    "meteringType": "UNIT",
                    "organization" : {
                        "id": "{org_name}",
                    "paymentDueDays": "30",
                    "ratePlanRates": [
                        {
                            "rate": "1.99",
                            "startUnit": "0",
                            "type": "RATECARD"
                        }
                    ],
                    "ratingParameter": "VOLUME",
                    "type": "RATECARD"
                }
            ]
        }
    ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API প্রোডাক্ট বান্ডেল থেকে API প্রোডাক্ট মুছে দেওয়া

API প্রোডাক্ট বান্ডেল থেকে API প্রোডাক্ট মুছে দিতে, organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}, -এ DELETE অনুরোধ ইস্যু করুন, যেখানে {org_name} আপনার সংস্থার নাম, {package_id} API প্রোডাক্ট বান্ডেলের নাম এবং {product_id} API প্রোডাক্টের আইডি নির্দিষ্ট করে।

যেমন:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}/products/{product_id}" \
-u email:password

API ব্যবহার করে API প্রোডাক্ট বান্ডেল দেখা

আপনি কোনও সংস্থার মধ্যে নির্দিষ্ট API প্রোডাক্ট বান্ডেল বা সব API প্রোডাক্ট বান্ডেল রিট্রিভ করতে পারবেন। এছাড়াও, আপনি নির্দিষ্ট তারিখের রেঞ্জে ট্রানজ্যাকশন হয়েছে এমন API প্রোডাক্ট বান্ডেল রিট্রিভ করতে পারবেন, অর্থাৎ, শুধুমাত্র সেইসব প্যাকেজ যেগুলির জন্য ব্যবহারকারীরা নির্দিষ্ট শুরুর ও শেষের তারিখের মধ্যে API অ্যাক্সেস করে এমন অ্যাপ ইনভোক করেন।

নির্দিষ্ট API প্রোডাক্ট বান্ডেল দেখা: নির্দিষ্ট API প্রোডাক্ট বান্ডেল পেতে, /organizations/{org_name}/monetization-packages/{package_id}-এ একটি GET অনুরোধ জানান, যেখানে {package_id} হল API প্রোডাক্ট বান্ডেলের শনাক্তকরণ (আপনি API প্রোডাক্ট বান্ডেল তৈরি করলে, উত্তরে ID ফেরত দেওয়া হয়)। যেমন:

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

সব API প্রোডাক্ট বান্ডেল দেখা: কোনও সংস্থার জন্য সব API প্রোডাক্ট বান্ডেল পেতে, /organizations/{org_name}/monetization-packages-এ একটি GET অনুরোধ করুন। যেমন:

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

ফলাফল ফিল্টার করতে আপনি নিম্নলিখিত কোয়েরি প্যারামিটার পাস করতে পারেন:

কোনও সংস্থার মধ্যে সমস্ত API প্রোডাক্ট বান্ডেল দেখার জন্য উত্তরটি এইরকম হওয়া উচিত (উত্তরের শুধুমাত্র অংশ দেখানো হয়েছে):

{
  "monetizationPackage" : [ {
    "description" : "payment messaging package",
    "displayName" : "Payment Messaging Package",
    "id" : "payment_messaging_package",
    "name" : "Payment Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Communications",
    "displayName" : "Communications",
    "id" : "communications",
    "name" : "Communications",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    }, {
      "customAtt1Name" : "user",
      "description" : "Messaging",
      "displayName" : "Messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "Payment",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  } ],
  "totalRecords" : 3
}

ট্রানজ্যাকশন সহ API প্রোডাক্ট বান্ডেল দেখা: নির্দিষ্ট তারিখের রেঞ্জে ট্রানজ্যাকশন সহ API প্রোডাক্ট বান্ডেল পেতে, /organizations/{org_name}/packages-with-transactions-এ GET অনুরোধ করুন। আপনি অনুরোধ করার সময়, তারিখের রেঞ্জের জন্য কোয়েরি প্যারামিটার হিসেবে শুরুর তারিখ ও শেষের তারিখ উল্লেখ করতে হবে। যেমন, নিচের অনুরোধটি API প্রোডাক্ট বান্ডেল থেকে আগস্ট, ২০১৩-এর ট্রানজ্যাকশন সংক্রান্ত তথ্য পায়।

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/packages-with-transactions?START_DATE=2013-08-01&END_DATE=2013-08-31" \
-u email:password

উত্তরটি এই ধরনের হওয়া উচিত (উত্তরের শুধুমাত্র একটি অংশ দেখানো হয়েছে):

{
  "monetizationPackage" : [ {
    "description" : "Payment Package",
    "displayName" : "Payment Package",
    "id" : "payment_package",
    "name" : "Payment Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "payment api product",
      "displayName" : "payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  }, {
    "description" : "messaging package",
    "displayName" : "Messaging Package",
    "id" : "messaging_package",
    "name" : "Messaging Package",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "customAtt2Name" : "response size",
      "customAtt3Name" : "content-length",
      "description" : "messaging api product",
      "displayName" : "messaging",
      "id" : "messaging",
      "name" : "messaging",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "status == 'SUCCESS'"
    } ],
    "status" : "CREATED"
  },
     ...
  } ]
}

API ব্যবহারকারী কোনও ডেভেলপার বা কোম্পানির সম্মতি জানানো API প্রোডাক্ট বান্ডেল দেখা

নিচের API-তে GET অনুরোধ পাঠিয়ে কোনও নির্দিষ্ট ডেভেলপার বা কোম্পানির গ্রহণ করা API প্রোডাক্ট বান্ডেল দেখুন:

• /organizations/{org_name}/developers/{developer_id}/monetization-packages, যেখানে {developer_id} হল ডেভেলপারের আইডি (ইমেল আইডি)।
• /organizations/{org_name}/companies/{company_id}/monetization-packages, যেখানে {company_id} হল কোম্পানির আইডি।

আপনি অনুরোধ করার সময়, নিম্নলিখিত কোয়েরি প্যারামিটারগুলি ঐচ্ছিকভাবে নির্দিষ্ট করতে পারেন:

যেমন, নিম্নলিখিত অনুরোধটি কোনও নির্দিষ্ট ডেভেলপারের দ্বারা গৃহীত সমস্ত API প্রোডাক্ট বান্ডেল পুনরুদ্ধার করে:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev1@myorg.com/monetization-packages" \
-u email:password

নিচে উল্লেখ করা অনুরোধটি শুধুমাত্র নির্দিষ্ট কোম্পানির গ্রহণ করা অ্যাক্টিভ API প্যাকেজগুলিই পুনরুদ্ধার করে:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/companies/myCompany/monetization-packages?current=true" \
-u email:password

API ব্যবহার করে API প্রোডাক্ট বান্ডেল মোছা

কোনও API প্রোডাক্ট বান্ডেলে কোনও রেট প্ল্যান নির্দিষ্ট করা না থাকলে তবেই আপনি সেটি মুছে দিতে পারবেন।

কোনও রেট প্ল্যান সংজ্ঞায়িত করা নেই এমন API প্রোডাক্ট বান্ডেল মুছে দিতে, organizations/{org_name}/monetization-packages/{package_id}-এ একটি DELETE অনুরোধ ইস্যু করুন, যেখানে {org_name} আপনার সংস্থার নাম নির্দিষ্ট করে এবং {package_id} API প্রোডাক্ট বান্ডেলের নাম নির্দিষ্ট করে।

যেমন:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/{package_id}" \
-u email:password

API-এর জন্য API প্রোডাক্ট বান্ডেল কনফিগারেশন প্রপার্টি

API-তে নিম্নলিখিত API প্রোডাক্ট বান্ডেল কনফিগারেশন বিকল্পগুলি দেখানো হয়: