Receive webhooks via Webhook Endpoint#

טכנולוגיית Webhook Endpoint מאפשרת לך לקבל webhooks נכנס ישירות לשרת שלך. המשמעות היא ששרת ה-API של Green יבצע קריאה לשיטה שפורסמה בצד השרת שלך. היתרון של טכנולוגיה זו הוא הקבלה המהירה ביותר האפשרית של webhooks נכנסות וקיבולת גבוהה, מוגבלת רק על ידי קצב העיבוד של webhooks בצד השרת שלך. החסרונות כוללים את מורכבות היישום.

שרת ה-API של Green עושה ניסיונות לספק webhooks במרווח של דקה אחת. לכן, הגדר את השרת שלך כך שהוא תמיד זמין לעיבוד webhooks נכנסים, או לשימוש Receive webhooks via HTTP API טֶכנוֹלוֹגִיָה. משלוח ה-webhooks הנכנס מובטח תוך 24 שעות.

הדרכה וידאו#

הגדרת שרת#

כדי לקבל webhooks נכנסים באמצעות טכנולוגיית Webhook Endpoint, תצטרך לבצע את השלבים הבאים:

לפרסם את כתובת ה-IP באינטרנט
ליישם את ההיגיון לעיבוד webhooks נכנס לכתובת ה-IP שצוינה
אם נדרש עבור השרת, הגדר את ה-Webhook URL Token

כתובת IP ציבורית#

כדי לקבל webhooks נכנסות, נדרשת כתובת IP ציבורית (נקודת קצה), שתהיה נגישה מהאינטרנט. לפיכך, שרת ה-API של Green יוכל לבצע קריאה לשרת שלך בכתובת שצוינה ולשדר חיבור אינטרנט נכנס.

כתובות ה-IP הציבוריות שלנו שמהן שלחנו webhooks#

אתה יכול לציין את כתובת ה-IP שלהלן שממנה מתקבלים webhooks מאיתנו, בהגדרות האבטחה של השרת שלך:

46.101.109.139
64.226.111.11
68.183.213.45
94.131.81.171
104.248.252.93
165.22.80.121
167.172.162.71
207.154.255.195
209.38.202.24

עיבוד webhooks נכנס#

לאחר קבלת שיחה נכנסת לכתובת ה-IP של השרת שלך, תצטרך לעבד את ה-webhook שהתקבל. אתה יכול לראות את הדוגמה של קוד עיבוד webhook נכנס NodeJS ב קוֹבֶץ

הגדרת מופע#

לפני קבלת webhooks נכנסות, עליך להגדיר את המופע שלך. ניתן לבצע הגדרות מופע בתוכנה באמצעות SetSettings שיטה, או online בממשק המסוף.

הגדרה לפי SetSettings שִׁיטָה#

כדי להגדיר קבלת webhooks נכנסות באמצעות טכנולוגיית Webhook Endpoint, עליך לציין את כתובת ה-IP שלך או שם הדומיין שלך כפרמטר webhookUrl, ובמידת הצורך webhookUrlToken כדי לגשת לשרת שלך. לְדוּגמָה:

https://84.211.100.201:3000/green-api/webhook/

כמו כן, נדרש לציין אילו סוגי webhooks אתה צריך לקבל. כדי לאפשר webhooks נכנסות לפי סוג, כמו גם לציין פרמטרים של webhookUrl וwebhookUrlToken, השתמש SetSettings שִׁיטָה.

דוגמה של SetSettings גוף בקשת השיטה#

{
    "webhookUrl": "https://84.211.100.201:3000/green-api/webhook/",
    "webhookUrlToken": "dscnsdiuafkascndjhsalbcvatsvcbasn23rfregvfdg54tds",
    "outgoingWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no"
}

הגדרה בקונסולה#

ניתן להגדיר את קבלת ההתראות הנכנסות (webhooks) גם דרך הקונסולה. לשם כך יש לעבור לקונסולה ולבחור את המופע הנדרש. אם המופע מורשה, יוצגו ההגדרות לקבלת התראות נכנסות (ראו איור). יש לציין את הפרמטר webhookUrl ולהפעיל את המתגים של סוגי ההתראות הנדרשים. אם השרת שלכם לקבלת התראות דורש הרשאה, יש לציין גם את Webhook URL Token. אם המופע אינו מורשה וההגדרות של ההתראות אינן מוצגות, עיינו בסעיף לפני תחילת העבודה.

הגדרה בקונסולה

הרשאה

אם הפרמטר WebhookURLToken אינו ריק, השרת שלנו ישלח בקשות לשרת שלכם עם כותרת ההרשאה Authorization.

אם נעשה שימוש בסוג ההרשאה Basic, הכותרת תכיל Basic <token>;
- בעת שימוש בהרשאת Basic, יש להעביר בשדה webhookUrlToken מחרוזת בפורמט הבא:
```
Basic AuthToken
```
אם נעשה שימוש בסוג ההרשאה Bearer, הכותרת תכיל Bearer <token>.
- בעת שימוש בהרשאת Bearer, יש להעביר בשדה webhookUrlToken מחרוזת בפורמט הבא:
```
Bearer AuthToken
```
אם סוג ההרשאה לא צוין, הכותרת תכיל כברירת מחדל Bearer <token>.
- אם סוג ההרשאה לא צוין, יש להעביר בשדה webhookUrlToken מחרוזת בפורמט הבא:
```
Bearer AuthToken
```

ניפוי באגים של webhooks נכנסים#

אתה יכול להשתמש בכל שירות חינמי באינטרנט כדי לנפות באגים ב-webhooks נכנסים, למשל, Webhook.Site שֵׁרוּת. השירות מנפיק כתובת ייחודית (URL), אשר נדרשת set בתור הפרמטר webhookUrl.

בתור הפרמטר webhookUrl. פורמט webhooks נכנס סָעִיף.

דוגמה לבקשת Http שנשלחת על ידי green-api:

curl --request POST 'your-webhook-url-address' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{"typeWebhook":"statusInstanceChanged","instanceData":{"idInstance":000001,"wid":"7123456789@c.us","typeInstance":"whatsapp"},"timestamp":1654553712,"statusInstance":"online"}'