Zendesk
מחבר Zendesk מאפשר לכם לבצע פעולות של הוספה, מחיקה, עדכון וקריאה במסד הנתונים של Zendesk.
גרסאות נתמכות
המחבר הזה תומך בממשקי API מגרסה 2 של Zendesk.
לפני שמתחילים
לפני שמשתמשים במחבר Zendesk, צריך לבצע את המשימות הבאות:
- בפרויקט שלכם ב-Google Cloud:
- מוודאים שהגדרתם חיבור לרשת. מידע על תבניות רשת זמין במאמר קישוריות לרשת.
- נותנים למשתמש שמגדיר את המחבר את תפקיד ה-IAM roles/connectors.admin.
- מקצים לחשבון השירות שרוצים להשתמש בו עבור המחבר את תפקידי ה-IAM הבאים:
roles/secretmanager.viewerroles/secretmanager.secretAccessor
חשבון שירות הוא סוג מיוחד של חשבון Google שמייצג משתמש לא אנושי, שצריך לאמת ולאשר כדי לתת לו גישה לנתונים ב-Google APIs. אם אין לכם חשבון שירות, אתם צריכים ליצור חשבון שירות. המחבר וחשבון השירות צריכים להיות שייכים לאותו פרויקט. מידע נוסף זמין במאמר בנושא יצירת חשבון שירות.
- מפעילים את השירותים הבאים:
-
secretmanager.googleapis.com(Secret Manager API) -
connectors.googleapis.com(Connectors API)
במאמר הפעלת שירותים מוסבר איך להפעיל שירותים.
-
אם השירותים או ההרשאות האלה לא הופעלו בפרויקט שלכם בעבר, תתבקשו להפעיל אותם כשאתם מגדירים את המחבר.
- אם אתם משתמשים בטוקן API כשיטת האימות שלכם כדי לגשת ל-Zendesk API, אתם צריכים לקבל טוקן API ממרכז האדמינים של Zendesk. אחרי שיוצרים את אסימון ה-API, שומרים אותו בצורה מאובטחת בניהול המפתחות של Google Cloud. מידע נוסף זמין במאמר בנושא ניהול גישה לטוקן API ל-Zendesk API.
- מידע על יצירת חשבון Zendesk זמין במאמר יצירת חשבון Zendesk.
- כדי ליצור מינוי לאירועים ב-Zendesk, צריך להיות לכם תפקיד אדמין בחשבון Zendesk. צריך שיהיה לכם מינוי לתוכנית
Suite growth and aboveאוSupport professional and aboveב-Zendesk, כי התכונה הזו לא זמינה לחשבונות ניסיון.
הגדרת המחבר
החיבור ספציפי למקור נתונים. אם יש לכם הרבה מקורות נתונים, תצטרכו ליצור חיבור נפרד לכל אחד מהם. כדי ליצור קישור:
- במסוף Cloud, עוברים לדף Integration Connectors > Connections ובוחרים או יוצרים פרויקט בענן.
- לוחצים על + יצירת חיבור חדש כדי לפתוח את הדף יצירת חיבור.
- בקטע מיקום, בוחרים את המיקום של החיבור.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
רשימה של כל האזורים הנתמכים מופיעה במאמר מיקומים.
- לוחצים על הבא.
- אזור: בוחרים מיקום מהרשימה הנפתחת.
- בקטע פרטי החיבור, ממלאים את הפרטים הבאים:
- מחבר: בוחרים באפשרות Zendesk מהרשימה הנפתחת של המחברים הזמינים.
- גרסת כלי החיבור: בוחרים את גרסת כלי החיבור מהרשימה הנפתחת של הגרסאות הזמינות.
- בשדה Connection Name (שם החיבור), מזינים שם למופע החיבור.
השמות של החיבורים צריכים לעמוד בקריטריונים הבאים:
- שמות החיבורים יכולים לכלול אותיות, מספרים או מקפים.
- האותיות צריכות להיות קטנות.
- שמות החיבורים צריכים להתחיל באות ולהסתיים באות או במספר.
- שמות החיבורים לא יכולים לכלול יותר מ-49 תווים.
- במחברים שתומכים במינוי לאירועים, שמות החיבורים לא יכולים להתחיל בקידומת goog.
- אפשר גם להזין תיאור למופע החיבור.
- אופציונלי: מפעילים את Cloud Logging ואז בוחרים רמת יומן. כברירת מחדל, רמת היומן מוגדרת כ-
Error. - חשבון שירות: בוחרים חשבון שירות שיש לו את התפקידים הנדרשים.
- כדי להשתמש בחיבור למינויים לאירועים, בוחרים באפשרות הפעלת מינוי לאירועים. אם בוחרים באפשרות הזו, מוצגות האפשרויות הבאות:
- הפעלת הרשמה לאירועים עם ישות ופעולות: בוחרים באפשרות הזו כדי להשתמש בחיבור גם להרשמה לאירועים וגם לפעולות של מחבר (יחידות ופעולות).
- הפעלה של מינוי לאירועים בלבד: בוחרים באפשרות הזו כדי להשתמש בחיבור רק למינוי לאירועים. אם בוחרים באפשרות הזו, לוחצים על הבא ואז מגדירים מינוי לאירועים.
- אופציונלי: מגדירים את ההגדרות של צומת החיבור:
- מספר מינימלי של צמתים: מזינים את המספר המינימלי של צמתי חיבור.
- מספר הצמתים המקסימלי: מזינים את מספר צמתי החיבור המקסימלי.
צומת הוא יחידה (או עותק) של חיבור שמבצעת עיבוד של עסקאות. כדי לעבד יותר טרנזקציות לחיבור מסוים, צריך יותר צמתים, ולהפך – כדי לעבד פחות טרנזקציות, צריך פחות צמתים. כדי להבין איך הצמתים משפיעים על התמחור של המחבר, אפשר לעיין במאמר בנושא תמחור של צמתי חיבור. אם לא מזינים ערכים, כברירת מחדל, מספר הצמתים המינימלי מוגדר כ-2 (לזמינות טובה יותר) ומספר הצמתים המקסימלי מוגדר כ-50.
- (אופציונלי) בקטע הגדרות מתקדמות, מסמנים את התיבה שימוש ב-proxy כדי להגדיר שרת proxy לחיבור, ומגדירים את הערכים הבאים:
-
סכימת אימות של שרת proxy: בוחרים את סוג האימות לאימות מול שרת ה-proxy. יש תמיכה בסוגי האימות הבאים:
- בסיסי: אימות HTTP בסיסי.
- Digest: אימות HTTP מסוג Digest.
- משתמש proxy: שם משתמש שישמש לאימות בשרת ה-proxy.
- סיסמת ה-Proxy: הסוד במנהל הסודות של סיסמת המשתמש.
-
סוג ה-SSL של ה-Proxy: סוג ה-SSL שבו יש להשתמש כשמתחברים לשרת ה-Proxy. יש תמיכה בסוגי האימות הבאים:
- Auto (אוטומטי): הגדרת ברירת המחדל. אם כתובת ה-URL היא כתובת HTTPS, נעשה שימוש באפשרות Tunnel. אם כתובת ה-URL היא כתובת HTTP, נעשה שימוש באפשרות NEVER.
- תמיד: החיבור תמיד מופעל באמצעות SSL.
- לעולם לא: החיבור לא מופעל באמצעות SSL.
- מנהור: החיבור הוא דרך שרת proxy למנהור. שרת ה-proxy פותח חיבור למארח המרוחק, והתנועה זורמת הלוך ושוב דרך ה-proxy.
- בקטע שרת Proxy, מזינים את פרטי שרת ה-Proxy.
- לוחצים על + הוספת יעד.
- בוחרים סוג יעד.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
כדי ליצור חיבור פרטי למערכת העורפית, פועלים לפי השלבים הבאים:
- יוצרים קובץ מצורף לשירות PSC.
- יוצרים נקודת הקצה של הקישור ואז מזינים את הפרטים שלו בשדה Host address.
- כתובת המארח: מציינים את שם המארח או את כתובת ה-IP של היעד.
- אם רוצים, אפשר ללחוץ על + הוספת תווית כדי להוסיף תווית לקישור בצורה של צמד מפתח/ערך.
- לוחצים על הבא.
- בקטע יעדים, מזינים את הפרטים של המארח המרוחק (מערכת העורף) שאליו רוצים להתחבר.
- סוג היעד: בוחרים סוג יעד.
- כדי לציין את שם המארח או את כתובת ה-IP של היעד, בוחרים באפשרות כתובת המארח ומזינים את הכתובת בשדה מארח 1.
- כדי ליצור חיבור פרטי, בוחרים באפשרות Endpoint attachment (צירוף נקודת קצה). ברשימה Endpoint Attachment, בוחרים את נקודת הקצה של הקישור שנוצרה עבור מערכת ה-Backend.
אם רוצים ליצור חיבור ציבורי למערכות העורפיות עם אבטחה נוספת, אפשר להגדיר כתובות IP סטטיות יוצאות לחיבורים, ואז להגדיר את כללי חומת האש כך שרק כתובות ה-IP הסטטיות הספציפיות יופיעו ברשימת ההיתרים.
כדי להזין יעדים נוספים, לוחצים על +הוספת יעד.
- לוחצים על הבא.
- סוג היעד: בוחרים סוג יעד.
-
בקטע אימות, מזינים את פרטי האימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
החיבור ל-Zendesk תומך בסוגי האימות הבאים:
- שם משתמש וסיסמה (יצא משימוש)
- טוקן API
- OAuth 2.0 – קוד הרשאה
- לוחצים על הבא.
כדי להבין איך להגדיר את סוגי האימות האלה, אפשר לעיין במאמר בנושא הגדרת אימות.
- בוחרים סוג אימות ומזינים את הפרטים הרלוונטיים.
- אם הפעלתם את המינוי לאירועים, הקטע פרטי המינוי לאירועים יופיע בדף ליצירת החיבור. במאמר הגדרת מינוי לאירועים מוסבר איך מגדירים את פרטי המינוי לאירועים.
- בדיקה: בודקים את פרטי החיבור והאימות.
- לוחצים על יצירה.
הגדרת אימות
מזינים את הפרטים בהתאם לאימות שבו רוצים להשתמש.
-
שם משתמש וסיסמה (יצא משימוש)
- שם משתמש: שם המשתמש ב-Zendesk שבו רוצים להשתמש לחיבור.
- סיסמה: סוד ב-Secret Manager שמכיל את הסיסמה שמשויכת לשם המשתמש ב-Zendesk.
-
API token
- משתמש: חשבון המשתמש ב-Zendesk שמשמש לאימות.
- API token: טוקן ה-API של המשתמש המאומת.
- גרסת Secret: גרסת Secret של הסוד.
-
OAuth 2.0 – קוד הרשאה
- מזהה לקוח: מזהה הלקוח שסופק על ידי כלי החיבור לאפליקציה שיצרתם.
- Scopes: רשימה מופרדת בפסיקים של ההיקפים הרצויים.
- סוד הלקוח: סוד ב-Secret Manager שמכיל את סוד הלקוח של האפליקציה המקושרת שיצרתם.
- גרסת Secret: גרסת Secret של הסוד.
- כתובת URL לאישור: כתובת URL לאישור שנוצרת כשיוצרים לקוח במכונה של Zendesk.
הגדרת מינוי לאירועים
אם הפעלתם את המינוי לאירועים, מזינים את הערכים הבאים בקטע פרטי המינוי לאירועים:
- בוחרים סוג יעד.
- כתובת המארח: בשדה מארח, מזינים את כתובת ה-URL של הרישום למערכת העורפית.
- בוחרים באפשרות API Token (טוקן API) כסוג האימות. אל תבחרו באפשרות שם משתמש וסיסמה.
- מזינים את פרטי האימות.
- משתמש: חשבון המשתמש ב-Zendesk שמשמש לאימות.
- API token: טוקן ה-API של המשתמש המאומת.
- גרסת Secret: גרסת Secret של הסוד.
- אופציונלי: בוחרים באפשרות הפעלת העשרה של נתונים אם רוצים שמידע נוסף יצורף לתגובה של מערכת ה-Backend.
המידע הנוסף ספציפי לישות שעבורה הגדרתם את האירוע. מידע נוסף זמין במאמר בנושא העשרת נתונים בהתראות על אירועים.
- בוחרים באפשרות הפעלת קישוריות פרטית כדי ליצור קישוריות מאובטחת בין אפליקציית הקצה העורפי לבין החיבור. אם בוחרים באפשרות הזו, צריך לבצע שלבי הגדרה נוספים אחרי יצירת הקישור. מידע נוסף זמין במאמר בנושא קישוריות פרטית למינוי לאירועים.
- מזינים את ההגדרה של תור ההודעות המתות. אם מגדירים תיבת דואר להודעות שלא נמסרו, החיבור כותב את האירועים שלא עברו עיבוד אל נושא Pub/Sub שצוין. ממלאים את הפרטים הבאים:
- מזהה פרויקט של הודעות שלא ניתן למסור: מזהה הפרויקט ב-Google Cloud שבו הגדרתם את נושא ה-Pub/Sub של הודעות שלא ניתן למסור.
- נושא להודעות ללא מוצא: נושא Pub/Sub שבו רוצים לכתוב את הפרטים של האירוע שלא עבר עיבוד.
- אם רוצים להשתמש בשרת proxy כדי להתחבר לחלק האחורי של האתר (למינוי לאירועים), מזינים את הפרטים הבאים:
- סוג ה-SSL של ה-Proxy: סוג ה-SSL שבו יש להשתמש כשמתחברים לשרת ה-Proxy. בוחרים באחד מסוגי האימות הבאים:
- תמיד: החיבור תמיד מופעל באמצעות SSL להרשמה לאירועים.
- לעולם לא: החיבור לא מופעל באמצעות SSL למינוי לאירועים.
- סכימת אימות של שרת proxy: בוחרים את סוג האימות לאימות מול שרת ה-proxy.
יש תמיכה בסוגי האימות הבאים:
- בסיסי: אימות HTTP בסיסי.
- משתמש proxy: מזינים את שם המשתמש שישמש לאימות בשרת ה-proxy.
- סיסמת ה-Proxy: בוחרים את הסוד של סיסמת המשתמש ב-Secret Manager.
- Secret version (גרסת ה-Secret): בוחרים את גרסת ה-Secret.
- בקטע שרת Proxy, מזינים את פרטי שרת ה-Proxy.
- לוחצים על + הוספת יעד ואז בוחרים באפשרות כתובת המארח בתור סוג היעד.
- מזינים את שם המארח או את כתובת ה-IP של שרת ה-proxy, ואת מספר היציאה של שרת ה-proxy.
דוגמאות להגדרת חיבור
סוג החיבור לאימות בסיסי (הוצא משימוש)
| שם השדה | פרטים |
|---|---|
| מיקום | us-east4 |
| מחבר | Zendesk |
| גרסת המחבר | 1 |
| שם החיבור | CONNECTION_NAME |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| מארח | HOST_ADDRESS |
| UserPassword | כן |
| שם משתמש | שם משתמש |
| סיסמה | PASSWORD |
| גרסה של סוד | 1 |
סוג החיבור API Token
| שם השדה | פרטים |
|---|---|
| מיקום | europe-west1 |
| מחבר | Zendesk |
| גרסת המחבר | 1 |
| שם החיבור | zendesk-apitoken |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| סוג היעד | כתובת המארח |
| Host1 | https://yoursubdomain.zendesk.com |
| אימות | טוקן API |
| משתמש | שם משתמש |
| טוקן API | אסימון API שסופק על ידי האפליקציה |
| גרסה של סוד | 1 |
OAuth 2.0 – סוג החיבור 'קוד הרשאה'
| שם השדה | פרטים |
|---|---|
| מיקום | europe-west1 |
| מחבר | Zendesk |
| גרסת המחבר | 1 |
| שם החיבור | zendesk-auth-code |
| הפעלת Cloud Logging | כן |
| חשבון השירות | SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com |
| מספר הצמתים המינימלי | 2 |
| מספר הצמתים המקסימלי | 50 |
| סוג היעד | כתובת המארח |
| Host1 | https://yoursubdomain.zendesk.com |
| אימות | OAuth 2.0 – קוד הרשאה |
| מספר לקוח | CLIENT_ID |
| היקפים | היקפי ההרשאות הנדרשים בהתאם לתרחיש לדוגמה |
| סוד לקוח | CLIENT_SECRET |
| גרסה של סוד | 1 |
| כתובת אתר להרשאה | https://d3v2one1625553311.zendesk.com/oauth/authorizations/new |
החיבור ל-Zendesk משתמש ב-SSL כברירת מחדל, ולא נדרשת הגדרה נוספת אם משתמשים בכתובת ה-URL הרגילה של Zendesk, כמו https://yoursubdomain.zendesk.com.
ישויות, פעולות ופעולות
כל Integration Connectors מספקים שכבת הפשטה לאובייקטים של האפליקציה המחוברת. אפשר לגשת לאובייקטים של אפליקציה רק דרך ההפשטה הזו. ההפשטה מוצגת לכם כישויות, פעולות ופעילויות.
- ישות: ישות היא אובייקט או אוסף של מאפיינים באפליקציה או בשירות המקושרים. ההגדרה של ישות משתנה ממחבר למחבר. לדוגמה, במחבר של מסד נתונים, הטבלאות הן הישויות. במחבר של שרת קבצים, התיקיות הן הישויות. במחבר של מערכת הודעות, התורים הם הישויות.
עם זאת, יכול להיות שמחבר לא תומך בישויות או שאין לו ישויות, ובמקרה כזה הרשימה
Entitiesתהיה ריקה. - פעולה: פעולה היא הפעילות שאפשר לבצע על ישות. אפשר לבצע כל אחת מהפעולות הבאות בישות:
בחירה של ישות מתוך הרשימה הזמינה יוצרת רשימה של פעולות שזמינות לישות. תיאור מפורט של הפעולות זמין במאמר פעולות על ישויות של משימת המחברים. עם זאת, אם מחבר לא תומך באף אחת מהפעולות על ישויות, הפעולות הלא נתמכות האלה לא יופיעו ברשימה
Operations. - פעולה: פעולה היא פונקציה מסוג first class שזמינה לשילוב דרך ממשק המחבר. פעולה מאפשרת לבצע שינויים בישות אחת או בכמה ישויות, והיא משתנה ממתחם למתחם. בדרך כלל, לפעולה יהיו כמה פרמטרים של קלט ופרמטר של פלט. עם זאת, יכול להיות שמחבר לא תומך באף פעולה, ובמקרה כזה הרשימה
Actionsתהיה ריקה.
מגבלות המערכת
מחבר Zendesk יכול לעבד 5 טרנזקציות בשנייה, לכל צומת, ומגביל טרנזקציות מעבר למגבלה הזו. כברירת מחדל, Integration Connectors מקצה 2 צמתים (לזמינות טובה יותר) לחיבור.
מידע על המגבלות שחלות על Integration Connectors זמין במאמר מגבלות.
פעולות
מחבר Zendesk מספק פעולות לניהול הכרטיסים על סמך ticket ID. כדי להבין איך להגדיר את הפעולות, אפשר לעיין בדוגמאות לפעולות.
דוגמאות לפעולות
בקטע הזה מוסבר איך לבצע חלק מהפעולות במחבר הזה.
דוגמה – מחיקת כרטיס
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
DeleteTicketsPermanentlyולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Id": "18" }
בדוגמה הזו הכרטיס נמחק באופן סופי. אם הפעולה מצליחה, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך דומה לזה:
[{ "Success": "true" }]
דוגמה – מיזוג כרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
MergeTicketsולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "Id": "25", "Id": "26" }
בדוגמה הזו, שני הכרטיסים מוזגו. אם הפעולה מצליחה, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך דומה לזה:
[{ "Success": null, "Message": null }]
דוגמה – שחזור כרטיס
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
RestoreTicketולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "id": "20" }
בדוגמה הזו מתבצעת שחזור של כרטיס. אם הפעולה מצליחה, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך דומה לזה:
[{ "Success": "true" }]
דוגמה – שחזור כרטיס מושעה
- בתיבת הדו-שיח
Configure connector task, לוחצים עלActions. - בוחרים את הפעולה
RecoverSuspendedTicketולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadומזינים ערך דומה לערך הבא בשדהDefault Value:{ "id": "18726501985809" }
בדוגמה הזו, כרטיס התמיכה מושעה. אם הפעולה מצליחה, לפרמטר התגובה connectorOutputPayload של משימת המחבר יהיה ערך דומה לזה:
[{ "Id": "60921" }]
דוגמאות לפעולות על ישויות
דוגמה – הצגת פעולות בכרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketsמהרשימהEntity. - בוחרים את הפעולה
Listולוחצים על סיום.
אפשר לבצע פעולת רשימה בישויות הבאות:
קבצים מצורפים, הערות בכרטיס, טפסים של כרטיסים, שדות של כרטיסים, בקשות, ביקורות של כרטיסים, מדדים של כרטיסים, כרטיסים מושהים, הסכמי שיתוף, משתמשים, זהויות משתמשים, מידע שקשור למשתמשים, שדות משתמשים, שדות ארגון וסטטוס משימות
דוגמה – קבלת פעולה בכרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketsמהרשימהEntity. - בוחרים את הפעולה
Getולוחצים על סיום. - במקרה הזה, entityId מוגדר כ-34.0. כדי להגדיר את entityId, בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים),
לוחצים על
entityIdומזינים 34.0 בשדהDefault Value.
אפשר לבצע פעולת Get על הישויות הבאות:
טפסים של כרטיסים, שדות של כרטיסים, בקשות, ביקורות של כרטיסים, כרטיסים בהמתנה, שדות משתמשים, זהויות משתמשים ומשתמשים
דוגמה – יצירת פעולה בכרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketsמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Subject": "Zendesk_Create_Ticket", "RawSubject": "Zendesk_Create", "Description": "this ticket is related to application integration Create operation", "Type": "incident", "Priority": "urgent", "Status": "open", "Recipient": null, "HasIncidents": false, "DueAt": null, "RequesterId": 3.84625885158E11, "SubmitterId": 3.84625883418E11, "AssigneeId": 3.84625883418E11, "OrganizationId": "16665992392721", "GroupId": 3.60008282358E11, "TicketFormId": 3.60001719218E11, "BrandId": 3.60003285058E11, "Tags": null, "ViaChannel": "web", "ViaSource": "{\r\n \"from\": null,\r\n \"to\": null,\r\n \"rel\": null\r\n}", "CustomFields": null, "SatisfactionRating": null, "SharingAgreementIds": null, "AllowChannelback": false, "IsPublic": true, "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json" }אם השילוב יצליח, בשדה
connectorOutputPayloadשל משימת המחבר יופיע ערך שדומה לערך הבא:{ "Id": 38.0 }
דוגמה – יצירת פעולה ב-TicketForms
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketFormsמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "Altostrat_Zendesk1", "RawName": "Altostrat_Zendesk1", "DisplayName": "Altostrat_Issues1", "RawDisplayName": "Altostrat_Issues1", "Position": 2.0, "Active": true, "EndUserVisible": true, "Default": false, "InAllBrands": true, "RestrictedBrandIds": null, "FallbackToDefault": null, "AssociatedToBrand": null }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהTicketFormsיהיה ערך שדומה לדוגמה הבאה:{ "Id":1.8104712053393E13 }
דוגמה – יצירת פעולה ב-TicketFields
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketFieldsמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Type": "text", "Title": "New field created", "RawTitle": null, "Description": "Please create the new field", "RawDescription": null, "Position": 2.0, "Active": true, "Required": false, "CollapsedForAgents": false, "RegexpForValidation": null, "VisibleInPortal": true, "EditableInPortal": true, "Tag": null, "CreatedAt": "2021-07-06 06:35:19.0", "UpdatedAt": "2021-07-06 06:35:19.0", "SystemFieldOptions": null, "CustomFieldOptions": null, "Removable": false }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהTicketFieldsיהיה ערך שדומה לדוגמה הבאה:{ "Id": 1.7139061374865E13 }
דוגמה – יצירת פעולה ב-SharingAgreements
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
SharingAgreementsמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "altostrat.zendesk.com", "RemoteSubdomain": "altostrat" }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהSharingAgreementsיהיה ערך שדומה לדוגמה הבאה:{ "Id": 1.7142672288273E13 }
דוגמה – פעולת יצירה של משתמשים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UsersמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Email": "cloudysanfrancisco@gmail.com", "Name": "Altostrat Team" }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהUsersיהיה ערך שדומה לדוגמה הבאה:{ "Id": 1.7156912480273E13 }
דוגמה – פעולת יצירה ב-UserIdentities
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UserIdentitiesמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "UserId": 3.84637722338E11, "Type": "email", "Value": "cloudysanfrancisco@gmail.com", "Verified": false, "Primary": true, "DeliverableState": "reserved_example", "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json" }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהUserIdentitiesיהיה ערך שדומה לדוגמה הבאה:{ "Id": 1.6961185982353E13 }
דוגמה – פעולת יצירה ב-UserFields
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UserFieldsמהרשימהEntity. - בוחרים את הפעולה
Createולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Title": "Support description", "Type": "text", "Key": "support_description" }אם השילוב יצליח, לפרמטר התגובה
connectorOutputPayloadשל המשימהUserFieldsיהיה ערך שדומה לדוגמה הבאה:{ "Id": 1.7157236761873E13 }
דוגמה – פעולת עדכון בכרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketsמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Subject": "Google_Altostrat_Zendesk Update", "RawSubject": "Google_Altostrat_Zendesk Update", "Description": "this ticket is related to googlecloud application integration update check", "RequesterId": 1.6854335860497E13 } - בדוגמה הזו, entityId מוגדר ל-35.0. כדי להגדיר את entityId, לוחצים על entityId ומזינים
35בשדה ערך ברירת מחדל.במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך
35.אם השילוב יצליח, בשדה
connectorOutputPayloadשל משימת המחבר יופיע ערך שדומה לערך הבא:{ Id": 35.0 }
דוגמה – פעולת עדכון ב-TicketForms
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketFormsמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "Ticketforms Updated", "DisplayName": "Altostrat_Issues1", "RawDisplayName": "Altostrat_Issues1" } - בדוגמה הזו, הערך של entityId הוא 1.7137314972689E13. כדי להגדיר את entityId, לוחצים על entityId ואז מזינים
1.7137314972689E13בשדה ערך ברירת מחדל.במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך
1.7137314972689E13.הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ Id": 1.7137314972689E13 }
דוגמה – פעולת עדכון ב-TicketFields
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketFieldsמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Description": "Updated description for testing" } - בדוגמה הזו, הערך של entityId הוא 3.60022990118E11. כדי להגדיר את entityId, לוחצים על entityId ואז מזינים
3.60022990118E11בשדה ערך ברירת מחדל.במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך
3.60022990118E11.הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ Id": 3.60022990118E11 }
דוגמה – פעולת עדכון של משתמשים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UsersמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Name": "The Customer update", "Last Name": "Alex", "First Name": "Charlie" } - במקרה הזה, entityId מוגדר כ-3.84625885158E11. כדי להגדיר את entityId, לוחצים על entityId ואז מזינים
3.84625885158E11בשדה ערך ברירת מחדל.במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך
3.84625885158E11.הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ Id": 3.84625885158E11 }
דוגמה – פעולת עדכון ב-UserFields
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UserFieldsמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Title": "Support description updated", "Type": "text", "Key": "support_description" } - במקרה הזה, entityId מוגדר כ-1.7157236761873E13. כדי להגדיר את entityId, לוחצים על entityId ואז מזינים
1.7157236761873E13בשדה ערך ברירת מחדל.במקום לציין את entityId, אפשר גם להגדיר את filterClause לערך
1.7157236761873E13.הרצת הדוגמה הזו מחזירה תגובה שדומה לתגובה הבאה במשתנה הפלט
connectorOutputPayloadשל משימת המחבר:{ Id": 1.7157236761873E13 }
דוגמה – פעולת עדכון ב-UserIdentities
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
UserIdentitiesמהרשימהEntity. - בוחרים את הפעולה
Updateולוחצים על סיום. - בקטע Task Input (קלט המשימה) של המשימה Connectors (מחברים), לוחצים על
connectorInputPayloadואז מזינים ערך דומה לערך הבא בשדהDefault Value:{ "Verified": true } - בישות הזו, אפשר לבצע את פעולת העדכון באמצעות פסוקית מסנן ומפתחות ראשיים מורכבים, ולכן לא נדרש entityId.
במקום לציין את entityId, אפשר גם להגדיר את filterClause כ- UserId='384625885158' and Id='368234205078'.
אם מריצים את הדוגמה הזו, מקבלים תגובה שדומה לזו שמופיעה במשתנה הפלט connectorOutputPayload של משימת המחבר:
{
"Id": 3.68234205078E11
}
דוגמה – פעולת מחיקה בכרטיסים
- בתיבת הדו-שיח
Configure connector task, לוחצים עלEntities. - בוחרים באפשרות
TicketsמהרשימהEntity. - בוחרים את הפעולה
Deleteולוחצים על סיום. - בדוגמה הזו, entityId מוגדר ל-35.0. כדי להגדיר את entityId, בקטע Task Input של המשימה Connectors, לוחצים על entityId ואז מזינים
35בשדה Default Value.
אפשר לבצע פעולת מחיקה על הישויות הבאות:
Ticket Fields, Suspended Tickets, UserIdentities, User Fields, and Users
יצירת חיבורים באמצעות Terraform
אפשר להשתמש במשאב של Terraform כדי ליצור חיבור חדש.
כדי ללמוד איך להחיל הגדרות ב-Terraform או להסיר אותן, ראו פקודות בסיסיות ב-Terraform.
כדי לראות תבנית לדוגמה של Terraform ליצירת חיבור, אפשר לעיין בתבנית לדוגמה.
כשיוצרים את החיבור הזה באמצעות Terraform, צריך להגדיר את המשתנים הבאים בקובץ ההגדרות של Terraform:
| שם הפרמטר | סוג נתונים | חובה | תיאור |
|---|---|---|---|
| proxy_enabled | בוליאני | לא נכון | מסמנים את תיבת הסימון הזו כדי להגדיר שרת Proxy לחיבור. |
| proxy_auth_scheme | ENUM | לא נכון | סוג האימות שמשמש לאימות לשרת ה-proxy ProxyServer. הערכים הנתמכים הם: BASIC, DIGEST, NONE |
| proxy_user | מחרוזת | לא נכון | שם משתמש שישמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_password | SECRET | לא נכון | סיסמה שתשמש לאימות בשרת ה-proxy ProxyServer. |
| proxy_ssltype | ENUM | לא נכון | סוג ה-SSL שבו צריך להשתמש כשמתחברים לשרת ה-proxy של ProxyServer. הערכים הנתמכים הם: AUTO, ALWAYS, NEVER, TUNNEL |
שימוש בחיבור Zendesk בשילוב
אחרי שיוצרים את החיבור, הוא זמין גם ב-Apigee Integration וגם ב-Application Integration. אפשר להשתמש בחיבור באינטגרציה באמצעות המשימה Connectors.
- כדי להבין איך ליצור ולהשתמש במשימה Connectors ב-Apigee Integration, אפשר לעיין במאמר משימת Connectors.
- מידע על יצירה ושימוש במשימת Connectors ב-Application Integration זמין במאמר משימת Connectors.