הגדרת התראות באמצעות webhook

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

מה זה webhook?

Webhook מגדיר מטפל בקריאה חוזרת של HTTP שמופעל על ידי אירוע. אפשר ליצור ווּבְּהוּקים ולהגדיר אותם לטיפול בהתראות על אירועים, כחלופה לשימוש בתבניות של התראות על מונטיזציה, כמו שמתואר במאמר הגדרת התראות באמצעות תבניות של התראות.

כדי להגדיר התראות באמצעות Webhooks, מבצעים את השלבים הבאים באמצעות ממשק המשתמש של Edge Management או Management and Monetization API:

1. מוסיפים ווּבהוקים שמגדירים את הפונקציות לטיפול בקריאות חוזרות לאירועי ההתראות באמצעות ממשק המשתמש או API.
2. הגדרת פונקציית ה-callback.
3. מגדירים את ההתראה על תוכנית עם שיעור משתנה באמצעות ממשק המשתמש או API.

ניהול webhooks

מוסיפים ומנהלים את ה-webhook שמגדיר את הפונקציות לטיפול בקריאות חוזרות לאירועי ההתראות באמצעות ממשק המשתמש או API.

ניהול webhook באמצעות ממשק המשתמש

מוסיפים ומנהלים את ה-webhook שמגדיר את הגורמים שמטפלים בקריאה חוזרת לאירועי ההתראות באמצעות ממשק המשתמש, כמו שמתואר בקטעים הבאים.

• הדף Webhooks
• הוספת webhook באמצעות ממשק המשתמש
• עריכת webhook באמצעות ממשק המשתמש
• מחיקת webhook באמצעות ממשק המשתמש

הכרת הדף Webhooks

ניגשים לדף Webhooks (ווּבְּהוּקים), כמו שמתואר בהמשך.

הוספת webhook באמצעות ממשק המשתמש

כדי להוסיף webhook באמצעות ממשק המשתמש:

1. נכנסים אל הדף Webhooks.
2. לוחצים על + Webhook.
3. מזינים את הפרטים הבאים (חובה למלא את כל השדות).
   

   שדה	תיאור
   שם	השם של ה-webhook.
   כתובת אתר	כתובת ה-URL של גורם הטיפול בקריאה החוזרת שיופעל כשתוצג התראה לגבי אירוע. מידע נוסף מופיע במאמר בנושא הגדרת גורם מטפל בקריאה חוזרת.

4. לוחצים על שמירה.

ה-webhook מתווסף לרשימה ומופעל כברירת מחדל.

עריכת webhook באמצעות ממשק המשתמש

כדי לערוך webhook באמצעות ממשק המשתמש:

1. נכנסים אל הדף Webhooks.
2. מציבים את הסמן מעל ה-webhook שרוצים לערוך ולוחצים על בתפריט הפעולות.
3. עורכים את השדות של ה-webhook לפי הצורך.
4. לוחצים על עדכון ה-Webhook.

הפעלה או השבתה של webhook באמצעות ממשק המשתמש

כדי להפעיל או להשבית webhook באמצעות ממשק המשתמש:

1. נכנסים אל הדף Webhooks.
2. מציבים את הסמן מעל ה-webhook ומעבירים את מתג הסטטוס כדי להפעיל או להשבית אותו.

מחיקת webhook באמצעות ממשק המשתמש

כדי למחוק webhook באמצעות ממשק המשתמש:

1. נכנסים אל הדף Webhooks.
2. מציבים את הסמן מעל ה-webhook שרוצים למחוק ולוחצים על .

ה-webhook יימחק ויוסר מהרשימה.

ניהול של ווּבְּהוּקים באמצעות ה-API

אפשר להוסיף ולנהל וווב-הוקים באמצעות ה-API, כמו שמתואר בקטעים הבאים.

• הצגת כל ה-webhook באמצעות ה-API
• צפייה ב-webhook באמצעות ה-API
• הוספת webhook באמצעות ה-API
• עריכת webhook באמצעות API
• מחיקת webhook באמצעות ה-API

הצגת כל ה-webhook באמצעות API

כדי לראות את כל התגובות לפעולה מאתר אחר (webhook), שולחים בקשת GET אל /mint/organizations/{org_name}/webhooks. לדוגמה:

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

  ]
}

הצגת webhook באמצעות API

כדי להציג webhook יחיד, שולחים בקשת GET אל /mint/organizations/{org_name}/webhooks/{webhook_id}.

לדוגמה:

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

הוספת webhook באמצעות API

כדי להוסיף webhook, שולחים בקשת POST אל /mint/organizations/{org_name}/webhooks. צריך להעביר את השם של ה-webhook ואת כתובת ה-URL של גורם מטפל בקריאה חוזרת שיופעל כשתוצג התראה לגבי אירוע.

לדוגמה, הפקודה הבאה יוצרת webhook בשם webhook3 ומקצה את callbackhandler3 ל-webhook:

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

עריכת webhook באמצעות ה-API

כדי לערוך webhook, שולחים בקשת PUT אל /mint/organizations/{org_name}/webhooks/{webhook_id}. מעבירים את העדכונים בגוף הבקשה.

לדוגמה, הפקודה הבאה מעדכנת את ה-callback handler שמשויך ל-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"
}

הפעלה או השבתה של webhook באמצעות ה-API

כדי להפעיל או להשבית webhook, שולחים בקשת POST אל /mint/organizations/{org_name}/webhooks/{webhook_id}, כמו שעשיתם כשעדכנתם webhook, ומגדירים את מאפיין ההפעלה בגוף הבקשה לערך true או false, בהתאמה. אם משביתים את ה-webhook, הוא לא יופעל כשמתרחש אירוע.

לדוגמה, הקוד הבא מפעיל את 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"
}

מחיקת webhook באמצעות ה-API

כדי למחוק webhook, שולחים בקשת DELETE אל /mint/organizations/{org_name}/webhooks/{webhook_id}.

כדי לציין אם לכפות את המחיקה של ה-webhook אם יש תהליכים בתהליך, מגדירים את פרמטר השאילתה 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 שנשלחת לגורם המטפל בקריאה חוזרת שהוגדר על ידי webhook כשמופעלת התראה לגבי אירוע. צריך לוודא שפונקציית ה-callback מטפלת בבקשה בצורה מתאימה.

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

הגדרת התראות על תוכנית מחירים משתנה

מגדירים התראות באמצעות ווּבהוקים (webhook) לתוכנית עם מחיר משתנה באמצעות ממשק המשתמש או API.

הגדרת התראות לתוכנית עם מחיר משתנה באמצעות ממשק המשתמש

כדי להגדיר התראות באמצעות Webhook לתוכנית עם מחיר משתנה דרך ממשק המשתמש, פועלים לפי השלבים הבאים.

גישה לתיבת הדו-שיח 'התראות' לגבי תוכנית עם תעריף משתנה

כדי לגשת לתיבת הדו-שיח 'התראות' בתוכנית עם תעריף משתנה, פועלים לפי ההוראות שבהמשך.

הוספת התראות לתוכנית עם מחיר משתנה באמצעות ממשק המשתמש

כדי להוסיף התראות לתוכנית עם מחיר משתנה בממשק המשתמש:

1. נכנסים לתיבת הדו-שיח של ההתראות.
2. מגדירים את תנאי ההתראה בקטע Notification Intervals. לשם כך, מציינים את אחוז היעד של מספר העסקאות שבו רוצים שההתראה תופעל. באופן ספציפי:
   • כדי להגדיר אחוז מדויק, מזינים את האחוז בשדה ב/מ- % ומשאירים את השדה עד % ריק.
   • כדי להגדיר טווח אחוזים, מזינים את אחוז ההתחלה ואחוז הסיום בשדות ב/מ-% ועד % בהתאמה, ומזינים ערך של עלייה בשדה %שלב. כברירת מחדל, ההתראות נשלחות בקפיצות של 10% בטווח שצוין.

   השדה Notify At מתעדכן כדי לשקף כל אחוז ממספר היעד של העסקאות שיפעילו אירוע.

3. כדי להגדיר עוד תנאים לתזכורת, לוחצים על +הוספה וחוזרים על שלב 4.
4. בקטע Webhooks, בוחרים פעולה להתראה. אפשר לבחור webhook אחד או יותר כדי לנהל את הטיפול בקריאה חוזרת כשמופעלות התראות.
5. לוחצים על יצירת התראה.

עריכת התראות לתוכנית עם מחיר משתנה באמצעות ממשק המשתמש

כדי לערוך התראות לגבי תוכנית עם שיעור משתנה בממשק המשתמש:

1. נכנסים לתיבת הדו-שיח של ההתראות.
2. לוחצים על +שליחת הודעה בעמודה 'פעולות' של תוכנית התמחור.
3. לוחצים על עריכה.
4. משנים את הערכים לפי הצורך.
5. לוחצים על שמירת ההתראה.

מחיקת התראות לגבי תוכנית עם שיעור משתנה באמצעות ממשק המשתמש

כדי למחוק תנאי ופעולה של התראה:

1. נכנסים לתיבת הדו-שיח של ההתראות.
2. לוחצים על +שליחת הודעה בעמודה 'פעולות' של תוכנית התמחור.
3. לוחצים על מחיקת התזכורת.

הגדרת התראות לתוכנית עם תעריף משתנה באמצעות ה-API

כדי להגדיר התראה על תוכנית עם תעריף משתנה באמצעות ה-API, צריך לפעול לפי ההליך שמתואר במאמר ניהול תנאים ופעולות של התראות באמצעות ה-API ולהשתמש במאפיינים שמתוארים בקטע הזה.

כדי להגדיר את תנאי ההתראה (notificationCondition), משתמשים בערכי המאפיינים הבאים. מידע נוסף מופיע במאמר מאפייני הגדרה של תנאים להצגת התראות.

כדי להגדיר את פעולת ההתראה, בקטע actions מגדירים את הערכים הבאים. מידע נוסף זמין במאמר מאפייני ההגדרה של פעולות בהתראות.

בדוגמה הבאה מוסבר איך ליצור תנאי להפעלת התראה שגורם להפעלת webhook כששיעור העסקאות מתוך מספר העסקאות היעד מגיע ל-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",
        }]
  }

מידע על צפייה בתנאי פעולה של התראה, עדכון ומחיקה שלו זמין במאמרים הבאים:

• צפייה בתנאי ובפעולה של התראה באמצעות ה-API
• עריכה של תנאי והפעולה של התראה באמצעות ה-API
• מחיקת תנאי ופעולה של התראה באמצעות ה-API

קודי תגובה של webhook

בטבלה הבאה מפורטים קודי התגובה של ה-webhook והאופן שבו המערכת מפרשת אותם.