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

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

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

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

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

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

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

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

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

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

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

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

यहां दिए गए तरीके से, Webhooks पेज को ऐक्सेस करें.

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

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

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 पर POST अनुरोध भेजकर, वेबहुक जोड़ें. आपको वेबुक का नाम और कॉलबैक हैंडलर का यूआरएल पास करना होगा. इवेंट की सूचना ट्रिगर होने पर, इस हैंडलर को कॉल किया जाएगा.

उदाहरण के लिए, यहां 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} पर PUT अनुरोध भेजकर, किसी वेबहुक में बदलाव करें. अपडेट को अनुरोध के मुख्य हिस्से में पास करें.

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

curl -X PUT "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}"
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

यहां सूचना पाने की शर्त बनाने का एक उदाहरण दिया गया है. इससे, लेन-देन की टारगेट संख्या का प्रतिशत 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",
        }]
  }

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

• एपीआई का इस्तेमाल करके, सूचना की शर्त और कार्रवाई देखना
• एपीआई का इस्तेमाल करके, सूचना पाने की शर्त और कार्रवाई में बदलाव करना
• एपीआई का इस्तेमाल करके, सूचना पाने की शर्त और कार्रवाई को मिटाना

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

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