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

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

शुरुआती जानकारी

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

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

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

क्रेडिट पेज के बारे में ज़्यादा जानना

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

Edge

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

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

क्रेडिट पेज दिखाया जाता है.

जैसा कि ऊपर दिखाए गए डायग्राम में बताया गया है, क्रेडिट पेज की मदद से ये काम किए जा सकते हैं:

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

क्लासिक एज (प्राइवेट क्लाउड)

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

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

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

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

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

  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 के बिलिंग महीने के लिए 100 डॉलर का क्रेडिट जारी किया जाता है. यह क्रेडिट dev1@myorg.com के तौर पर बताए गए डेवलपर को दिया जाता है. यह क्रेडिट, 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

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

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

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

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

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

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

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

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

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

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

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

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

ध्यान दें, जिसमें बताया गया हो कि आपको क्यों क्रेडिट दिया गया है.

लागू नहीं हां