क्रेडिट जारी करने वाले ऐप्लिकेशन

आपको Apigee Edge का दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं. जानकारी

परिचय

मॉनेटाइज़ेशन की सुविधा से, डेवलपर क्रेडिट जारी किया जा सकता है.

प्रीपेड डेवलपर के लिए, क्रेडिट का मतलब है कि उसके खाते में मौजूद क्रेडिट का इस्तेमाल कम हो गया है. इससे डेवलपर के प्रीपेड बैलेंस में आने वाले समय में बढ़ोतरी या कमी होती है. डेबिट कार्ड की तरह ही, डेवलपर के प्रीपेड बैलेंस से पैसे तब निकाले जाते हैं, जब डेवलपर कोई एपीआई प्रॉडक्ट बंडल खरीदता है. डेवलपर को खरीदारी के लिए, अपने खाते में ज़रूरी बैलेंस बनाए रखना होगा. प्रीपेड खाते में बाकी बैलेंस का हिसाब कैसे लगाया जाता है?

पोस्टपेड डेवलपर के लिए, क्रेडिट इनवॉइस में एक अलग लाइन के तौर पर दिखता है. इससे इनवॉइस में लगने वाला शुल्क कम हो जाता है.

क्रेडिट पेज को एक्सप्लोर करना

नीचे दिए गए तरीके से, क्रेडिट पेज को ऐक्सेस करें और उसके बारे में जानें.

क्रेडिट जारी करना

1. क्रेडिट पेज को ऐक्सेस करें.
2. + क्रेडिट पर क्लिक करें.
3. निम्नलिखित जानकारी दर्ज करें:

   फ़ील्ड	ब्यौरा
   बिलिंग का महीना	बिलिंग का वह महीना जिसमें क्रेडिट लागू होता है. सूची से कोई महीना चुनें.
   डेवलपर	डेवलपर या कंपनी का नाम जिस पर क्रेडिट लागू होता है. टेक्स्ट बॉक्स में नाम डालें. टाइप करते समय, डेवलपर/कंपनियों की एक सूची ड्रॉप-डाउन में दिखती है. इसमें वे डेवलपर/कंपनियां शामिल होती हैं जिनके नाम में वह स्ट्रिंग मौजूद होती है. ड्रॉप-डाउन सूची में, डेवलपर या कंपनी के नाम पर क्लिक करें. ध्यान दें: किसी डेवलपर या कंपनी को चुनने के बाद, बाकी फ़ील्ड दिखते हैं. अगर आपने ऐसी कंपनी या डेवलपर को चुना है जिसने दर वाला प्लान स्वीकार नहीं किया है, तो आपको क्रेडिट जारी करने का विकल्प नहीं मिलेगा.
   प्रॉडक्ट बंडल	एपीआई प्रॉडक्ट बंडल जिस पर क्रेडिट लागू होता है. उपलब्ध एपीआई प्रॉडक्ट बंडलों की सूची में से कोई एक चुनें.
   प्रॉडक्ट	चुने गए एपीआई प्रॉडक्ट बंडल में मौजूद वह एपीआई प्रॉडक्ट जिस पर क्रेडिट लागू होता है. सूची से सभी प्रॉडक्ट या कोई एक एपीआई प्रॉडक्ट चुनें.
   मुद्रा	क्रेडिट के लिए इस्तेमाल की गई मुद्रा. मुद्रा को एपीआई प्रॉडक्ट बंडल में मौजूद रेट प्लान के लिए कॉन्फ़िगर किया जाता है. इसे डेवलपर ने खरीदा है और इसे बदला नहीं जा सकता. अगर किसी रेट प्लान में एक से ज़्यादा मुद्राएं तय की गई हैं, तो आपके पास उनमें से कोई एक मुद्रा चुनने का विकल्प होता है.
   रकम	क्रेडिट की रकम (तय की गई मुद्रा में). कोई पॉज़िटिव या नेगेटिव वैल्यू डालें. वैल्यू शून्य नहीं हो सकती.
   नोट	क्रेडिट देने की वजह बताने के लिए, ज़रूरी नहीं कि नोट जोड़ा जाए.

4. क्रेडिट सेव करें पर क्लिक करें.

एपीआई का इस्तेमाल करके क्रेडिट जारी करना

एपीआई का इस्तेमाल करके, किसी डेवलपर को एपीआई प्रॉडक्ट बंडल के लिए क्रेडिट दें. इसके अलावा, एपीआई प्रॉडक्ट बंडल में किसी खास एपीआई प्रॉडक्ट के इस्तेमाल के लिए भी क्रेडिट दिया जा सकता है.

एपीआई का इस्तेमाल करके क्रेडिट जारी करने के लिए, /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{rate-plan_id}/real-currency-credit-transactions पर POST अनुरोध जारी करें. यहां {package_id} और {rate-plan_id}, एपीआई प्रॉडक्ट बंडल और उस रेट प्लान की पहचान करते हैं जिस पर क्रेडिट लागू होता है.

अनुरोध करते समय, आपको क्वेरी पैरामीटर के तौर पर यह जानकारी देनी होगी:

• डेवलपर आईडी (ईमेल पता), जिस पर क्रेडिट लागू होता है.
• क्रेडिट की रकम.
• क्रेडिट के लिए इस्तेमाल की गई मुद्रा.
• क्रेडिट की वजह बताने वाला नोट.

वैकल्पिक तौर पर, क्वेरी वाले ये अतिरिक्त पैरामीटर तय किए जा सकते हैं:

• बिलिंग का वह महीना जिस पर क्रेडिट लागू होता है. डिफ़ॉल्ट रूप से, इस वैल्यू को मौजूदा महीने के तौर पर सेट किया जाता है.
• बिलिंग का वह साल जिस पर क्रेडिट लागू होता है. डिफ़ॉल्ट रूप से, इस वैल्यू में मौजूदा साल की जानकारी होती है.
• एपीआई प्रॉडक्ट जिस पर क्रेडिट लागू होता है. अगर आपने एपीआई प्रॉडक्ट आईडी नहीं दिया है, तो क्रेडिट, एपीआई प्रॉडक्ट बंडल में मौजूद सभी एपीआई प्रॉडक्ट पर लागू होगा.

उदाहरण के लिए, यहां दिए गए अनुरोध में, अप्रैल 2018 के बिलिंग महीने के लिए, dev1@myorg.com के तौर पर पहचाने गए डेवलपर को 100 डॉलर का क्रेडिट दिया गया है. यह क्रेडिट, payment एपीआई प्रॉडक्ट बंडल और payment_standard_plan रेट प्लान पर लागू होता है:

क्रेडिट के अनुरोध में इस्तेमाल किए जा सकने वाले क्वेरी पैरामीटर की पूरी सूची देखने के लिए, Credits API के लिए क्वेरी पैरामीटर लेख पढ़ें.

$ curl -H "Content-Type:application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/payment/rate-plans/payment_standard_plan/real-currency-credit-transactions?currencyId=usd&developerId=dev1@myorg.com&transactionAmount=100&transactionNote=Credit+for+failed+transactions&billingMonth=APRIL&billingYear=2013" \
-u email:password

यहां जवाब के एक अंश का उदाहरण दिया गया है:

{
  "currency" : "USD",
  "developer" : {
    "address" : [ {
      "address1" : "Dev One Address",
     ...
    } ],
    "approxTaxRate" : 0.0000,
    "billingType" : "PREPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev1@myorg.com",
    "hasSelfBilling" : false,
    "id" : "K4jW2QLjZ1h8GFA8",
    "legalName" : "DEV ONE",
    "name" : "Dev One",
    "organization" : {
     ...
    },
    "registrationId" : "TestRegId",
    "status" : "ACTIVE",
    "type" : "TRUSTED"
  },
  "endTime" : "2013-09-04 15:54:36",
  "environment" : "PROD",
  "euroExchangeRate" : 0.8107,
  "gbpExchangeRate" : 0.6860,
  "id" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "isVirtualCurrency" : false,
  "notes" : "Credit for failed transactions",
  "pkgId" : "myorg@@@payment",
  "pkgRatePlanProductName" : "Payment",
  "providerTxId" : "904c3f73-ab8d-4e5d-a48c-225fd49a3bde",
  "rate" : 100,
  "ratePlan" : {
    ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Standard Plan",
    "displayName" : "Standard Plan",
    …
    "monetizationPackage" : {
      "description" : "Payment",
      ...
        } ],
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Payment",
        "displayName" : "Payment",
        "id" : "payment",
        "name" : "payment",
        "organization" : {
          ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Standard Plan",
    "organization" : {
     ...
    },
    ...
      },
      ...
      },
      ...
  },
  "revenueShareAmount" : 0,
  "startTime" : "2013-09-04 15:54:36",
  "status" : "SUCCESS",
  "taxModel" : "UNDISCLOSED",
  "txProviderStatus" : "SUCCESS",
  "type" : "CREDIT",
  "usdExchangeRate" : 1.0675,
  "utcEndTime" : "2013-09-04 15:54:36",
  "utcStartTime" : "2013-09-04 15:54:36"
}

क्रेडिट एपीआई के लिए क्वेरी पैरामीटर

क्रेडिट एपीआई के साथ इस्तेमाल करने के लिए, ये क्वेरी पैरामीटर उपलब्ध हैं: