वेबहुक का इस्तेमाल करके सूचनाएं पाने की सुविधा सेट अप करें

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

वेबहुक क्या है?

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

वेबहुक का इस्तेमाल करके सूचनाएं सेट अप करने के लिए, Edge मैनेजमेंट यूज़र इंटरफ़ेस (यूआई) या Management and Monetization API का इस्तेमाल करके, इन चरणों को पूरा करें:

  1. ऐसे वेबहुक जोड़ें जो यूज़र इंटरफ़ेस या API का इस्तेमाल करके, सूचना इवेंट के लिए कॉलबैक हैंडलर तय करते हैं.
  2. कॉलबैक हैंडलर सेट अप करें.
  3. यूज़र इंटरफ़ेस या API का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान के लिए सूचना सेट अप करें.

वेबहुक मैनेज करना

ऐसे वेबहुक जोड़ें और मैनेज करें जो यूज़र इंटरफ़ेस या API का इस्तेमाल करके, सूचना इवेंट के लिए कॉलबैक हैंडलर तय करते हैं.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक मैनेज करना

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

वेबहुक पेज को एक्सप्लोर करना

नीचे बताए गए तरीके के मुताबिक, वेबहुक पेज को ऐक्सेस करें.

Edge

EDGE यूआई का इस्तेमाल करके वेबहुक पेज ऐक्सेस करने के लिए:

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

वेबहुक पेज दिखता है.

जैसा कि इमेज में हाइलाइट किया गया है, वेबहुक पेज आपको ये काम करने की सुविधा देता है:

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

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

  1. http://ms-ip:9000 में साइन इन करें. यहां ms-ip, मैनेजमेंट सर्वर नोड का आईपी पता या डीएनएस नाम है.

  2. एडमिन > वेबहुक चुनें.

वेबहुक पेज दिखता है.

वेबहुक पेज से ये काम किए जा सकते हैं:

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक जोड़ना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक जोड़ने के लिए:

  1. वेबहुक पेज ऐक्सेस करें.
  2. + वेबहुक पर क्लिक करें.
  3. नीचे दी गई जानकारी डालें (सभी फ़ील्ड में जानकारी डालना ज़रूरी है).
    फ़ील्ड ब्यौरा
    नाम वेबहुक का नाम.
    यूआरएल कॉलबैक हैंडलर का यूआरएल, जिसे इवेंट की सूचना ट्रिगर होने पर कॉल किया जाएगा. कॉलबैक हैंडलर सेट अप करना देखें.
  4. सेव करें पर क्लिक करें.

वेबहुक को सूची में जोड़ा जाता है और वह डिफ़ॉल्ट रूप से चालू रहता है.

यूज़र इंटरफ़ेस (यूआई) में वेबहुक में बदलाव करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक में बदलाव करने के लिए:

  1. वेबहुक पेज ऐक्सेस करें.
  2. जिस वेबहुक में बदलाव करना है उस पर अपना कर्सर रखें और ऐक्शन मेन्यू में पर क्लिक करें.
  3. ज़रूरत के हिसाब से वेबहुक फ़ील्ड में बदलाव करें.
  4. वेबहुक अपडेट करें पर क्लिक करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक को चालू या बंद करना

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक को चालू या बंद करने के लिए:

  1. वेबहुक पेज ऐक्सेस करें.
  2. वेबहुक पर अपने कर्सर को रखें और स्टेटस स्विच को चालू या बंद करने के लिए टॉगल करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक मिटाया जा रहा है

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके वेबहुक मिटाने के लिए:

  1. वेबहुक पेज ऐक्सेस करें.
  2. कर्सर को उस वेबहुक पर रखें जिसे आपको मिटाना है और पर क्लिक करें.

वेबहुक को सूची से मिटा दिया गया है.

एपीआई का इस्तेमाल करके वेबहुक मैनेज करना

नीचे दिए गए सेक्शन में बताए गए तरीके से एपीआई का इस्तेमाल करके वेबहुक जोड़ें और मैनेज करें.

एपीआई का इस्तेमाल करके सभी वेबहुक देखना

/mint/organizations/{org_name}/webhooks पर GET अनुरोध भेजकर सभी वेबहुक देखें. उदाहरण के लिए:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks" \
  -H "Content-Type: application/json " \
  -u email:password

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

{
  "totalRecords": 2,
  "webhooks": [
    {
      "created": 1460162656342,
      "enabled": false,
      "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
      "name": "webhook1",
      "postUrl": "http://mycompany.com/callbackhandler1",
      "updated": 1460162656342,
      "updatedBy": "joe@example.com"
    },
        {
      "created": 1460138724352,
      "createdBy": "joe@example.com",
      "enabled": true,
      "id": "a39ca777-1861-49cf-a397-c9e92ab3c09f",
      "name": "webhook2",
      "postUrl": "http://mycompany.com/callbackhandler2",
      "updated": 1460138724352,
      "updatedBy": "joe@example.com"
    }

  ]
}

एपीआई का इस्तेमाल करके वेबहुक देखना

/mint/organizations/{org_name}/webhooks/{webhook_id} पर GET अनुरोध भेजकर कोई एक वेबहुक देखें.

उदाहरण के लिए:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

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

{
   "created": 1460162656342,
   "enabled": false,
   "id": "21844a37-d26d-476c-93ed-38f3a4b24691",
   "name": "webhook1",
   "postUrl": "http://mycompany.com/callbackhandler1",
   "updated": 1460162656342,
   "updatedBy": "joe@example.com"
 }

एपीआई का इस्तेमाल करके, वेबहुक जोड़ना

/mint/organizations/{org_name}/webhooks पर पोस्ट अनुरोध जारी करके, वेबहुक जोड़ें. आपको वेबहुक का नाम और कॉलबैक हैंडलर का यूआरएल पास करना होगा, जिसे इवेंट की सूचना ट्रिगर होने पर कॉल किया जाएगा.

उदाहरण के लिए, यह वेबहुक webhook3 नाम से बनाता है और वेबहुक को callbackhandler3 असाइन करता है:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks"
  -H "Content-Type: application/json "
  -d '{
    "name": "webhook3",
    "postURL": "http://mycompany.com/callbackhandler3"
    }' \
    -u email:password

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

{
  "created": 1460385534555,
  "createdBy": "joe@example.com",
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler3",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

एपीआई का इस्तेमाल करके, वेबहुक में बदलाव करना

/mint/organizations/{org_name}/webhooks/{webhook_id} पर पोस्ट अनुरोध भेजकर, वेबहुक में बदलाव करें. अनुरोध के मुख्य हिस्से में ये अपडेट भेजें.

उदाहरण के लिए, यह webhook1 से जुड़े कॉलबैक हैंडलर को अपडेट करता है:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "postURL": "http://mycompany.com/callbackhandler4"
  }' \
  -u email:password

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

{
  "created": 1460385534555,
  "enabled": false,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

एपीआई का इस्तेमाल करके वेबहुक को चालू या बंद करना

वेबहुक को अपडेट करने के लिए, /mint/organizations/{org_name}/webhooks/{webhook_id} पर POST अनुरोध जारी करके, वेबहुक को चालू या बंद करें. इसके बाद, अनुरोध के मुख्य हिस्से में, चालू किए गए एट्रिब्यूट को सही या गलत पर सेट करें. अगर वेबहुक को बंद किया जाता है, तो कोई इवेंट होने पर यह ट्रिगर नहीं होगा.

उदाहरण के लिए, यह सुविधा webhook3 को चालू करती है:

curl -X POST  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3" \
  -H "Content-Type: application/json " \
  -d '{
    "enabled": "true"
  }' \
  -u email:password

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

{
  "created": 1460385534555,
  "enabled": true,
  "id": "0a07eb1f-f485-4539-8beb-01be449699b3",
  "name": "webhook3",
  "orgId": "myorg",
  "postUrl": "http://mycompany.com/callbackhandler4",
  "updated": 1460385534555,
  "updatedBy": "joe@example.com"
}

एपीआई का इस्तेमाल करके, वेबहुक को मिटाना

/mint/organizations/{org_name}/webhooks/{webhook_id} को DELETE अनुरोध भेजकर, वेबहुक को मिटाएं.

यह तय करने के लिए कि प्रोसेस जारी होने पर वेबहुक हटाना है या नहीं, forceDelete क्वेरी पैरामीटर को true या false पर सेट करें. forceDelete क्वेरी पैरामीटर, डिफ़ॉल्ट रूप से चालू होता है (true).

उदाहरण के लिए, यह फ़ील्ड webhook3 को मिटा देता है:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/21844a37-d26d-476c-93ed-38f3a4b24691" \
  -H "Content-Type: application/json " \
  -u email:password

कॉलबैक हैंडलर सेट अप करना

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

{
        "orgName": "{org_id}",
        "developerEmail": "{dev_email}",
        "developerFirstName": "{first_name}",
        "developerLastName": "{last_name}",
        "companyName": "{company_name}",
        "applicationName": "{app_name}",
        "packageName": "{api_package_name}",
        "packageId": "{api_package_id}",
        "ratePlanId": "{rateplan_id}",
        "ratePlanName": "{rateplan_name}",
        "ratePlanType": "{rateplan_type}",
        "developerRatePlanQuotaTarget": {quota_target},
        "quotaPercentUsed": {percentage_quota_used},
        "ratePlanStartDate": {rateplan_startdate}, 
        "ratePlanEndDate": {rateplan_enddate},
        "nextBillingCycleStartDate": {next_billing_cycle_startdate},
        "products": ["{api_product_name}","{api_product_name}"],
        "developerCustomAttributes": [],
        "triggerTime": {trigger_time},
        "triggerReason": "{trigger_reason}",
        "developerQuotaResetDate": "{devquota_resetdate}"
}

बदले जा सकने वाले रेट प्लान के लिए सूचनाएं सेट अप करना

रेट में बदलाव करने की योजना के लिए, वेबहुक का इस्तेमाल करके सूचनाएं सेट अप करें. इसके लिए, यूज़र इंटरफ़ेस या API का इस्तेमाल करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान के लिए सूचनाएं सेट अप करना

जैसा कि नीचे बताया गया है, यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान के लिए वेबहुक का इस्तेमाल करके सूचनाएं सेट अप करें.

बदले जा सकने वाले रेट प्लान के लिए, सूचना वाला डायलॉग बॉक्स ऐक्सेस करें

बदले जा सकने वाले रेट प्लान के बारे में सूचना देने वाला डायलॉग बॉक्स ऐक्सेस करें. इसके बारे में यहां बताया गया है.

Edge

EDGE यूआई का इस्तेमाल करके सूचना वाले डायलॉग बॉक्स को ऐक्सेस करने के लिए:

  1. जैसा कि में बताया गया है, बदलाव करने लायक सूचना दर प्लान बनाएं और पब्लिश करें.
  2. बाएं नेविगेशन बार में, पब्लिश करें > कमाई करना > रेट प्लान को चुनकर, किराये के प्लान वाले पेज को ऐक्सेस करें.
  3. कार्रवाइयां देखने के लिए, अपने कर्सर को अडजस्ट किए जा सकने वाले नोटिफ़िकेशन रेट प्लान पर रखें.
  4. +सूचनाएं भेजें पर क्लिक करें.

    इसके बाद, सूचना वाला डायलॉग बॉक्स दिखेगा.

    ध्यान दें: +सूचनाएं भेजने की कार्रवाई दिखाने के लिए, रेट प्लान को पब्लिश करना ज़रूरी है.

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

सूचनाएं पेज को ऐक्सेस करने के लिए:

  1. ज़रूरत के हिसाब से सूचनाएं पाने के प्लान की जानकारी दें में बताए गए तरीके से, सूचना की दर का ऐसा प्लान बनाएं जिसमें बदलाव किया जा सके.
  2. रेट प्लान देखने के लिए, पब्लिश करें > पैकेज चुनें.
  3. रेट प्लान के लिए, कार्रवाइयां कॉलम में +सूचनाएं भेजें पर क्लिक करें.

    इसके बाद, सूचना वाला डायलॉग बॉक्स दिखेगा.

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

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

  1. सूचनाओं का डायलॉग ऐक्सेस करें.
  2. आपको जिस समय सूचना को ट्रिगर करना है उस ट्रांज़ैक्शन की टारगेट संख्या का प्रतिशत तय करके, सूचना के इंटरवल में सूचना की शर्त सेट करें. खास तौर पर:
    • सटीक प्रतिशत सेट करने के लिए, At/From % फ़ील्ड में प्रतिशत डालें और % फ़ील्ड को खाली छोड़ दें.
    • प्रतिशत की सीमा सेट करने के लिए, At/From % और To % फ़ील्ड में शुरू और खत्म होने का प्रतिशत डालें. साथ ही, चरण % फ़ील्ड में बढ़ोतरी की वैल्यू डालें. डिफ़ॉल्ट रूप से, सूचनाएं तय की गई सीमा में 10% के हिसाब से भेजी जाती हैं.

    Notify At फ़ील्ड को अपडेट किया जाता है, ताकि किसी इवेंट को ट्रिगर करने वाले ट्रांज़ैक्शन की टारगेट संख्या का हर प्रतिशत दिखाया जा सके.

  3. सूचना की अन्य शर्तें सेट करने के लिए, +जोड़ें पर क्लिक करें और चौथे चरण को दोहराएं.
  4. सूचनाएं ट्रिगर होने पर कॉलबैक हैंडलिंग को मैनेज करने के लिए, एक या ज़्यादा वेबहुक चुनकर वेबहुक के तहत सूचना से जुड़ी कार्रवाई सेट करें.
  5. सूचनाएं बनाएं पर क्लिक करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान की सूचनाओं में बदलाव करना

अडजस्ट किए जा सकने वाले रेट प्लान की सूचनाओं में बदलाव करने के लिए, यूज़र इंटरफ़ेस (यूआई):

  1. सूचनाओं का डायलॉग ऐक्सेस करें.
  2. रेट प्लान के लिए, कार्रवाइयां कॉलम में +सूचनाएं भेजें पर क्लिक करें.
  3. बदलाव करें पर क्लिक करें.
  4. ज़रूरत के हिसाब से वैल्यू में बदलाव करें.
  5. सूचना सेव करें पर क्लिक करें.

यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान की सूचनाओं को मिटाया जा रहा है

सूचना की शर्त और कार्रवाई मिटाने के लिए:

  1. सूचनाओं का डायलॉग ऐक्सेस करें.
  2. रेट प्लान के लिए, कार्रवाइयां कॉलम में +सूचनाएं भेजें पर क्लिक करें.
  3. सूचना मिटाएं पर क्लिक करें.

एपीआई का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान के लिए सूचनाएं सेट अप करना

एपीआई का इस्तेमाल करके, अडजस्ट किए जा सकने वाले रेट प्लान के बारे में सूचना पाने की सुविधा सेट अप करने के लिए, एपीआई का इस्तेमाल करके सूचनाओं से जुड़ी शर्तें और कार्रवाइयां मैनेज करना में बताई गई प्रक्रिया का इस्तेमाल करें और इस सेक्शन में दिए गए एट्रिब्यूट इस्तेमाल करें.

सूचना की शर्त (notificationCondition) सेट अप करने के लिए, इन एट्रिब्यूट वैल्यू का इस्तेमाल करें. ज़्यादा जानकारी के लिए, सूचना की शर्तों के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

एट्रिब्यूट वैल्यू
RATEPLAN सूचना की दर के ऐसे प्लान का आईडी जिसमें बदलाव किया जा सकता है.
PUBLISHED TRUE में बताया गया हो कि अडजस्ट होने वाले नोटिफ़िकेशन रेट प्लान को पब्लिश किया जाना चाहिए.
UsageTarget लेन-देन की टारगेट की गई उस संख्या का प्रतिशत जिस समय आपको सूचना ट्रिगर करनी है.

इस एट्रिब्यूट की मदद से, डेवलपर को तब सूचना दी जा सकती है, जब वे अपने खरीदे गए नोटिफ़िकेशन रेट कार्ड प्लान के लिए, लेन-देन की तय संख्या के करीब हों या उसके पास पहुंच गए हों. उदाहरण के लिए, अगर किसी डेवलपर ने ऐसा नोटिफ़िकेशन रेट प्लान खरीदा है जिसमें बदलाव किया जा सकता है और डेवलपर के लिए ट्रांज़ैक्शन की टारगेट संख्या 1,000 पर सेट की गई है, तो डेवलपर को इसकी सूचना तब दी जा सकती है, जब वह 800 ट्रांज़ैक्शन (लेन-देन की टारगेट संख्या का 80%), 1,000 ट्रांज़ैक्शन (100%) या 1,500 ट्रांज़ैक्शन (150%).

  • सटीक प्रतिशत सेट करने के लिए, %= n डालें. उदाहरण के लिए, जब ट्रांज़ैक्शन की टारगेट संख्या 80% हो जाएगी, तब %= 80 सूचनाएं भेजेगा.
  • प्रतिशत की सीमा सेट करने के लिए, शुरू और खत्म होने के प्रतिशत डालें और उनकी वैल्यू इस तरह डालें: %= start to end by n. उदाहरण के लिए, %= 80 to 100 by 10 की वैल्यू तब सूचनाएं भेजेगा, जब ट्रांज़ैक्शन की टारगेट संख्या का प्रतिशत 80%, 90%, और 100% हो जाएगा.

सूचना से जुड़ी कार्रवाई सेट अप करने के लिए, actions में ये वैल्यू सेट करें. ज़्यादा जानकारी के लिए, सूचना से जुड़ी कार्रवाइयों के लिए कॉन्फ़िगरेशन प्रॉपर्टी देखें.

एट्रिब्यूट वैल्यू
actionAttribute वेबहुक ट्रिगर करने के लिए WEBHOOK.
value पिछले सेक्शन में तय किए गए वेबहुक का आईडी, एपीआई का इस्तेमाल करके वेबहुक बनाना.

आगे दिए गए उदाहरण में, सूचना की शर्त को बनाने का तरीका बताया गया है. यह शर्त तब ट्रिगर होती है, जब ट्रांज़ैक्शन की टारगेट संख्या का प्रतिशत 80%, 90%, 100%, 110%, और 120% हो जाता है.

{
    "notificationCondition": [
      {
        "attribute": "RATEPLAN",
        "value": "123456"
      },
      {
        "attribute": "PUBLISHED",
        "value": "TRUE"
      },
      {
        "attribute": "UsageTarget",
        "value": "%= 80 to 120 by 10"
      }
    } 
    ],
   "actions": [{
          "actionAttribute": "WEBHOOK",
          "value": "b0d77596-142e-4606-ae2d-f55c3c6bfebe",
        }]
  }

सूचना की किसी शर्त और उससे जुड़ी कार्रवाई को देखने, अपडेट करने, और मिटाने के बारे में जानकारी के लिए, यह देखें:

वेबहुक रिस्पॉन्स कोड

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

उत्तर कोड ब्यौरा
2xx पुष्टि हो गई
5xx

अनुरोध नहीं किया जा सका. सिस्टम पांच-मिनट के अंतराल में ज़्यादा से ज़्यादा तीन बार अनुरोध करने की कोशिश करेगा.

ध्यान दें: वेबहुक अनुरोधों को पढ़ने और कनेक्शन के टाइम आउट में तीन सेकंड लगते हैं. इस वजह से, ऐसे अनुरोध पूरे नहीं हो सकते.
Other response अनुरोध नहीं किया जा सका. सिस्टम फिर से अनुरोध करने की कोशिश नहीं करेगा.