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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

מהי תגובה לפעולה מאתר אחר (webhook)?

תגובה לפעולה מאתר אחר (webhook) מגדירה handler של קריאה חוזרת (callback) ב-HTTP שמופעל על ידי אירוע. אפשר ליצור webhooks ולהגדיר אותם לטפל בהתראות על אירועים, במקום להשתמש בתבניות של התראות מונטיזציה, כפי שמתואר במאמר הגדרת התראות באמצעות תבניות של התראות.

כדי להגדיר התראות באמצעות webhooks, צריך לבצע את השלבים הבאים באמצעות ממשק המשתמש לניהול Edge או Management API:

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

ניהול של webhooks

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

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

אפשר להוסיף ולנהל webhooks שמגדירים את הגורמים המטפלים לקריאה חוזרת (callback) עבור אירועי ההתראות באמצעות ממשק המשתמש, כפי שמתואר בקטעים הבאים.

סיור בדף ה-webhooks

נכנסים לדף של ה-webhooks כפי שמתואר בהמשך.

Edge

כדי לגשת לדף Webhooks באמצעות ממשק המשתמש של Edge:

  1. נכנסים לאתר apigee.com/edge.
  2. בסרגל הניווט הימני בוחרים באפשרות פרסום > מונטיזציה > Webhooks.

יוצג הדף של ה-webhooks.

כפי שמודגש באיור, הדף Webhooks מאפשר לך:

Classic Edge (ענן פרטי)

כדי לגשת לדף ה-webhooks באמצעות ממשק המשתמש הקלאסי של Edge:

  1. נכנסים אל http://ms-ip:9000. ms-ip הוא כתובת ה-IP או שם ה-DNS של הצומת של שרת הניהול.

  2. בוחרים באפשרות Admin > Webhooks.

יוצג הדף של ה-webhooks.

הדף 'תגובה לפעולה מאתר אחר (webhook)' מאפשר לכם:

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

כדי להוסיף תגובה לפעולה מאתר אחר (webhook) באמצעות ממשק המשתמש:

  1. נכנסים לדף ה-webhooks.
  2. לוחצים על + Webhook.
  3. מזינים את המידע הבא (כל השדות נדרשים).
    שדה התיאור
    שם השם של ה-webhook.
    כתובת URL כתובת ה-URL של ה-handler של הקריאה החוזרת (callback) שיופעל כשהתראת האירוע תופעל. ראה הגדרת ה-handler של קריאה חוזרת.
  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 נמחק והוסר מהרשימה.

ניהול של תגובות לפעולה מאתר אחר (webhook) באמצעות ה-API

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

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

אפשר להציג את כל ה-webhooks על ידי שליחת בקשת 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 של ה-handler של הקריאה החוזרת (callback) שיופעל כשהתראת האירוע תופעל.

לדוגמה, ההגדרה הבאה יוצרת 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 צריך לשלוח בקשת POST אל /mint/organizations/{org_name}/webhooks/{webhook_id}. העברת העדכונים בגוף הבקשה.

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

הפעלה או השבתה של תגובה לפעולה מאתר אחר (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

הגדרת ה-handler של הקריאה החוזרת (callback)

למטה מוצג הפורמט של בקשת ה-JSON שנשלחת ל-handler של קריאה חוזרת (callback) שמוגדר על ידי תגובה לפעולה מאתר אחר (webhook) כשמופעלת התראה על אירוע. צריך לוודא שה-handler של הקריאה החוזרת (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}"
}

הגדרת התראות לגבי תוכנית תעריפים ניתנת להתאמה

אפשר להגדיר התראות באמצעות webhooks לתוכנית תעריפים ניתנת להתאמה באמצעות ממשק המשתמש או API.

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

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

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

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

Edge

כדי לגשת לתיבת הדו-שיח של ההתראות באמצעות ממשק המשתמש של Edge:

  1. יוצרים ומפרסמים תוכנית ניתנת להתאמה של קצב שליחת התראות, כפי שמתואר בקטע ציון פרטים של תוכנית ההתראות שניתנת להתאמה.
  2. כדי להיכנס לדף 'תוכניות תמחור', לוחצים על פרסום > מונטיזציה > תוכניות תמחור בסרגל הניווט הימני.
  3. כדי להציג פעולות, מציבים את הסמן מעל לתוכנית של קצב יצירת ההתראות הניתן להתאמה.
  4. לוחצים על +התראה.

    תוצג תיבת הדו-שיח 'התראות'.

    הערה: יש לפרסם את תוכנית התעריפים כדי שהפעולה '+התראה' תוצג.

Classic Edge (ענן פרטי)

כדי לגשת לדף 'התראות':

  1. יוצרים תוכנית ניתנת להתאמה של קצב ההתראות, כפי שמתואר בקטע ציון הפרטים של תוכנית ההתראות הניתנת להתאמה.
  2. בוחרים באפשרות פרסום > חבילות כדי להציג את תוכניות התעריפים.
  3. לוחצים על +התראה בעמודה 'פעולות' של תוכנית התמחור והתשלומים.

    תוצג תיבת הדו-שיח 'התראות'.

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

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

  1. נכנסים לתיבת הדו-שיח 'התראות'.
  2. בקטע מרווחי התראות מגדירים את תנאי ההתראה, על ידי ציון אחוז ממספר היעד של העסקאות שלגביו רוצים שתישלח התראה. באופן ספציפי:
    • כדי להגדיר אחוז מדויק, מזינים את האחוז בשדה %at/From ומשאירים את השדה To % ריק.
    • כדי להגדיר טווח אחוזים, מזינים את אחוז ההתחלה והסיום בשדות At/From % ו-To % בהתאמה, ואת ערך הצירוף בשדה Step %. כברירת מחדל, ההתראות נשלחות במרווחים של 10% בטווח שצוין.

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

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

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

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

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

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

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

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

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

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

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

מאפיין Value
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 צריך להגדיר את הערכים הבאים. אפשר לקרוא מידע נוסף במאמר מאפייני הגדרה לפעולות של התראות.

מאפיין Value
actionAttribute WEBHOOK כדי להפעיל webhook.
value המזהה של ה-webhook שהגדרתם בקטע הקודם, יצירת webhooks באמצעות ה-API.

בדוגמה הבאה מוצגת דוגמה ליצירת תנאי לשליחת התראות שמפעיל תגובה לפעולה מאתר אחר (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",
        }]
  }

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

קודי תגובה של תגובה לפעולה מאתר אחר (webhook)

בהמשך מופיע סיכום של קודי התגובה של תגובה לפעולה מאתר אחר (webhook) ומוסבר איך המערכת מפרשת אותם.

קוד תגובה התיאור
2xx הפעולה הצליחה
5xx

הבקשה נכשלה. המערכת תנסה לשלוח שוב את הבקשה עד שלוש פעמים במרווחי זמן של 5 דקות.

הערה: הזמן הקצוב לתפוגה של קריאה וחיבור עבור בקשות של תגובה לפעולה מאתר אחר (webhook) הוא 3 שניות, ולכן יכול להיות שיישלחו בקשות שנכשלו.
Other response הבקשה נכשלה. המערכת לא תנסה לשלוח שוב את הבקשה.