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

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

परिचय

कमाई करने की सुविधा से, आपको डेवलपर क्रेडिट जारी करने की सुविधा मिलती है.

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

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

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

क्रेडिट पेज को यहां बताए गए तरीके से ऐक्सेस और एक्सप्लोर करें.

Edge

Edge के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, क्रेडिट पेज को ऐक्सेस करने के लिए:

  1. apigee.com/edge में साइन इन करें.
  2. बाईं ओर मौजूद नेविगेशन बार में, पब्लिश करें > कमाई करना > क्रेडिट चुनें.

क्रेडिट पेज दिखेगा.

इस इमेज में हाइलाइट किए गए क्रेडिट पेज पर, ये काम किए जा सकते हैं:

  • सभी क्रेडिट की खास जानकारी देखें. इसमें, क्रेडिट पाने वाले का नाम, क्रेडिट की रकम, क्रेडिट लागू होने की तारीख और समय, API प्रॉडक्ट बंडल और API के वे प्रॉडक्ट जिन पर क्रेडिट लागू होता है, और जोड़े गए नोट शामिल हैं
  • क्रेडिट जारी करना
  • क्रेडिट की सूची खोजना

क्लासिक Edge (निजी क्लाउड)

क्लासिक एज यूआई का इस्तेमाल करके, क्रेडिट वाले पेज को ऐक्सेस करने के लिए:

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नेम है.
  2. सबसे ऊपर मौजूद नेविगेशन बार में, कमाई करना > कमाई करने से जुड़ी रिपोर्ट चुनें.

क्रेडिट पेज पर ये काम किए जा सकते हैं:

  • सभी क्रेडिट की खास जानकारी देखें. इसमें, क्रेडिट पाने वाले का नाम, क्रेडिट की रकम, क्रेडिट लागू होने की तारीख और समय, API प्रॉडक्ट बंडल और API के वे प्रॉडक्ट जिन पर क्रेडिट लागू होता है, और जोड़े गए नोट शामिल हैं
  • क्रेडिट जारी करना
  • क्रेडिट की सूची खोजना

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

  1. क्रेडिट पेज को ऐक्सेस करें.
  2. + क्रेडिट पर क्लिक करें.
  3. निम्नलिखित जानकारी दर्ज करें:
    फ़ील्ड ब्यौरा
    बिलिंग का महीना

    वह बिलिंग महीना जिसमें क्रेडिट लागू होता है. सूची में से कोई महीना चुनें.

    डेवलपर

    उस डेवलपर या कंपनी का नाम जिसे क्रेडिट मिलना है. टेक्स्ट बॉक्स में वह नाम डालें. टाइप करते समय, ड्रॉप-डाउन में उन डेवलपर/कंपनियों की सूची दिखती है जिनके नाम में स्ट्रिंग शामिल है. ड्रॉप-डाउन सूची में, डेवलपर या कंपनी के नाम पर क्लिक करें.

    ध्यान दें: डेवलपर या कंपनी चुनने के बाद, बाकी फ़ील्ड दिखते हैं. अगर ऐसी कंपनी या डेवलपर को चुना जाता है जिसने रेट प्लान स्वीकार नहीं किया है, तो क्रेडिट जारी नहीं किया जा सकता.

    प्रॉडक्ट बंडल

    वह एपीआई प्रॉडक्ट बंडल जिस पर क्रेडिट लागू होता है. उपलब्ध एपीआई प्रॉडक्ट बंडल की सूची में से कोई एक चुनें.

    प्रॉडक्ट

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

    मुद्रा

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

    रकम

    क्रेडिट की रकम (तय की गई मुद्रा में). कोई पॉज़िटिव या नेगेटिव वैल्यू डालें. वैल्यू शून्य नहीं हो सकती.

    ध्यान दें

    क्रेडिट की वजह बताने के लिए नोट, ज़रूरी नहीं है.

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

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

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

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

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

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

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

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

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

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

$ 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"
}

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

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

नाम ब्यौरा डिफ़ॉल्ट ज़रूरी है?
billingMonth

वह बिलिंग महीना जिसके लिए क्रेडिट लागू होता है, जैसे कि APRIL.

लागू नहीं नहीं
billingYear

वह बिलिंग साल जिसके लिए क्रेडिट लागू होता है, जैसे कि 2018.

लागू नहीं नहीं
currencyId

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

लागू नहीं हां
developerId

उस डेवलपर या कंपनी का नाम जिसे क्रेडिट मिलना है.

लागू नहीं हां
productId

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

लागू नहीं नहीं
transactionAmount

क्रेडिट की रकम (बताई गई मुद्रा में). कोई पॉज़िटिव या नेगेटिव वैल्यू डालें. वैल्यू शून्य नहीं हो सकती.

लागू नहीं हां
transactionNote

क्रेडिट की वजह बताने वाला नोट.

लागू नहीं हां