תודה על המשוב.
משוב?אם יש לך מפתח בצוות שלך שיודע להשתמש בממשק API של GraphQL, ממשק ה- API של Webex Events יכול להיות השער שלך לאוטומציות חזקות של הגדרות וניהול אירועים ומוצרים, שילובי פלטפורמות של צד שלישי, לוחות מחוונים רבי עוצמה של נתונים מרובי אירועים ועוד.
מה ממשק ה- API של אירועי Webex יכול לעשות
במילים פשוטות, ממשק API הוא ממשק תכנות שמפתחים יכולים להשתמש בו כדי לקבל נתונים או להכניס נתונים לפלטפורמה מקוונת - במקרה זה, Webex Events.
ניתן לפשט את יכולות ה- API לארבעה מושגים בסיסיים:
-
צור משהו שלא היה קיים קודם לכן, כמו משתתף, מפגש או אירוע שלם.
-
עד כן כל מה שניתן להשתמש בממשק ה- API כדי ליצור, בתוספת עוד כמה דברים. לדוגמה, ניתן להשתמש בממשק ה- API ליצירת משתתף חדש ולאחר מכן לערוך את שם המשתתף, הדוא"ל, הסטטוס, הקבוצות, מספרי הטלפון והחשבונות החברתיים של המשתתף.
-
קרא מידע על כל מה שממשק ה- API יכול לשמש כדי ליצור או לערוך, בתוספת כמה דברים שהוא לא יכול.
-
מחק כל דבר שניתן להשתמש בממשק ה- API כדי ליצור, למעט כמה יוצאים מן הכלל.
זכור מושגים אלה בעת קריאת הקטע 'עבודה עם מפתחים' במאמר זה.
איך להתחיל
1. קבל גישה לממשק ה- API
אם אתה לקוח של הסכם Webex Suite ארגוני (Suite EA) שכבר הפעיל את Webex Events, אתה מקבל גישה אוטומטית לממשק ה- API של Webex Events! עבור כל הלקוחות האחרים, שוחח עם איש הקשר שלך ב- Webex Events או עם צוות התמיכה שלנו כדי ללמוד על גישה לממשק ה- API.
2. יצירת מפתח API
עכשיו אתה צריך ליצור מפתח API חדש לשימוש המפתחים שלך. כאשר יש לך גישה לממשק ה- API, כרטיסייה חדשה מתווספת לדף 'הגדרות ארגונ' בפלטפורמת Webex Events. כך תוכל לגשת לכרטיסייה החדשה וליצור את המפתח הראשון שלך:
זכור, רק מנהלי ארגונים יכולים לגשת לדף ה- API.
-
מכל מקום בפלטפורמת Webex Events, לחץ על תמונת הפרופיל שלך בפינה השמאלית העליונה של המסך ולאחר מכן בחר הגדרות ארגון מהת פריט הנפתח.
-
בדף הגדרות הארגון, לחץ על הכרטיסייה API בתפריט השמאלי. זה מעביר אותך ללוח המחוונים של API שבו תוכל לבדוק את השימוש ב- API, לייצא יומני שימוש, לנהל מפתחות ולגשת לתי עוד ה- API שלנו.
-
לחץ על צור מפתח.
-
במודאל 'צור מפתח חדש' הזן תווית למפתח ה- API שמסביר למה הוא ישמש.
-
הגרסה הנוכ חית של גרסת ה- API כבר תבחר את הגרסה הנוכחית, אז פשוט לחץ על שמור. זה חושף את מפתח ה- API.
-
לחץ על הלחצן הע תק שליד המפתח והדבק את המפתח במסמך מאובטח כדי להבטיח שהוא לעולם לא יאבד.
אזהרה! זו הפעם היחידה שניתן לגשת למפתח ה- API המלא. לאחר סגירת המודאל, לא ניתן לקרוא שוב את המקש המלא.
-
לאחר שהעתקת ושמרת את המפתח, לחץ על הלחצן ס גור.
ברוב המקרים, אתה צריך רק מפתח API אחד. עם זאת, במצבים שבהם אתה עובד עם צוותים מרובים, ייתכן שתרצה ליצור מפתח עבור כל צוות. שוחח עם המפתחים שלך על מקרי השימוש הספציפיים שלך כדי להבין את הפתרון הטוב ביותר.
3. הזמן מפתחים לגשת לממשק ה- API
בעת יצירת מפתח ה- API הראשון שלך, צוות API חדש נוצר באופן אוטומטי בפלטפורמת Webex Events. מתן גישה למפתחים שלך לנסות את ממשק ה- API של Webex Events הוא פשוט כמו להזמין אותם לצוות API זה. עקוב אחר ההוראות במאמר שלנו בנושא ניהול צוותים, חברים וזיכו יים כדי ללמוד כיצד.
זכור, ארגז החול של API הוא גרסה נפרדת של פלטפורמת Webex Events שנעשתה במיוחד לבדיקה. המשמעות היא שכל החברים החדשים בצוות ה- API Sandbox חייבים ליצור חשבון פלטפורמה חדש כדי להשתמש בארגז החול, גם אם כבר יש להם חשבון פלטפורמה או להיכנס באמצעות ה- SSO של הארגון שלהם.
לאנשים בצוות ה- API שלך אין גישה לשאר פלטפורמת Webex Events כפי שיש למארגנים. במקום זאת, לחברי צוות API יש גישה ל- API "ארגז חול" שבו הם יכולים לבדוק את מה שהם בונים מבלי להשפיע על נתונים בעולם האמיתי. אם אתה רוצה שלמפתחים תהיה גישה לחלק או לכל האירועים והאפליקציות האמיתיים שלך בפלטפורמת Webex Events, הזמינו אותם לצוותים רלוונטיים שאינם API.
4. היו נחמדים למפתחים שלכם
זה חיוני, אז עשינו את זה צעד שלם. 😉
"רומא לא נבנתה ביום אחד", וגם שילוב API טוב לא היה. היה חבר טוב למפתחים שלך ותן להם מספיק זמן להתעדכן בממשק ה- API של Webex Events לפני שתצפה שהם יספקו אינטגרציות. הם יהיו אסירי תודה שלא ילחצו עליהם.
לכל הפחות, אנו ממליצים להתחיל שיחות עם המפתחים שלך לא פחות משישה חודשים לפני שתצטרך שילובים עובדים. המשך לקרוא כדי ללמוד כיצד להתכונן ולקיים שיחות אלה.
עבודה עם מפתחים
לאחר שהזמנת מפתחים לצוות ארגז החול של Webex Events, אחת השאלות הראשונות שלך עשויה להיות, "כמה זמן ייקח לבנות אינטגרציות?" התשובה לשאלה זו תלויה בגורמים רבים, כולל כמה מפתחים אתה עובד איתם, כמה זמן יש להם לעבוד על אינטגרציות, כמה מורכבות האינטגרציות ועוד.
רק המפתחים שלך יכולים לומר לך כמה זמן ייקח להגדרה של אינטגר ציה, ורק לאחר כמה צעדים מכריעים:
-
ראשית, קרא את הסעיפים שלהלן כדי ללמוד מה ה- API יכול לעשות. זה יעזור לך להבין מה אפשרי, כך שתוכל לתקשר בבירור את הצרכים שלך עם המפתחים שלך.
-
פגוש את המפתחים שלך, שתף איתם את תיעוד ה- API שלנו ודון במה שאתה רוצה. הם יוכלו לתת משוב בסיסי על מה שהם יכולים ולא יכולים לעשות בשבילך. עם זאת, הם לא יוכלו לתת לך לוחות זמנים ספציפיים עד שהם יכירו את ממשק ה- API של Webex Events.
-
תן למפתחים שלך זמן להכיר את ה- API. הפוך את עצמך זמין לענות על שאלות קונספטואליות או מעשיות לגבי האירועים, הנתונים שלך, פלטפורמת Webex Events וכל דבר אחר.
מה ה- API יכול לעשות
לממשק ה- API שתי פונקציות בסיסיות:
-
קרי אה - קבל נתונים מ- Webex Events כדי שתוכל לבחון אותם או למשוך אותם למערכת אחרת.
-
עדכון - הכנס נתונים לאירועי Webex כדי ליצור פריטים חדשים או לסנכרן נתונים, כגון משתתפים, מפלטפורמה אחרת. כל דבר שמשנה משהו בפלטפורמת Webex Events הוא עדכון.
צוותים וארגונים
-
יצירה, עדכון, קריאה ומחיקה של צוותים וחברי צוות
אירועים
-
לעדכן, לשכפל ולקרוא. לא ניתן ליצור או למחוק אירועים באמצעות ה- API.
משתתפים
-
ליצור, לעדכן, לקרוא, להקצות להפעלות, להקצות לקבוצות ולמחוק פרטי חשבון חברתי (מספר טלפון, ידיות לחשבון חברתי וכו '). לא ניתן למחוק משתתפים, אם כי ניתן לחסום אותם.
שאלות
-
יצירה, עדכון, קריאה ומחיקה
טיפ: ב- API, שאלות נקראות "שדות מותאמים אישית"
קבוצות
-
יצירה, עדכון, קריאה ומחיקה של קבוצות בלעדיות ולא בלעדיות
מפגשים
-
יצירה, עדכון, קריאה ומחיקה
מיקומים
-
יצירה, עדכון, קריאה ומחיקה
טיפ: ב- API, מיקומים נקראים "אזורים".
אפליקציות ממותגות
-
קרא שמות אפליקציות ממותגות, סטטוסים ושמות אירועים שהוקצו
אפליקציית אירועים
-
קרא מידע בסיסי, מראה ו Web App הגדרות בתוספת מידע על הקלטות מרכז הווידאו
-
צור, עדכן, קרא ומחק את התכונות הבאות של אפליקציית האירועים והפריטים שלהן, במידת הצורך:
-
סדר היום
-
נותני חסות
-
רמקולים
-
מציגים
-
שידור חי
-
משתתפים
-
רשימה מותאמת אישית
-
פריט בודד
-
קישור לאינטרנט
-
רשימת אינטרנט
-
קוד ה- QR שלי
-
זכור, עליך להוסיף ולהגדיר באופן ידני כל תכונות של אפליקציית אירועים שאינן מופיעות לעיל.
טיפ: ב- API, תכונות נקראות "רכיבים".
הרשמה
-
קרא מידע בסיסי, מראה והגדרות, כולל הגדרות תשלום
-
צור, קרא, עדכן ומחק כרטיסים, טפסים, שאלות, קודי פרומו
-
יצירה, קריאה ועדכון הזמנות
-
שלח הודעות דוא"ל לאישור הזמנה וכרטיס
-
סמן הזמנות צ'ק או חשבונית כמשולמות
-
עדכן את פרטי רוכש ההזמנה
-
ביטול והחזר כרטיסים
-
צור, קרא, עדכן, מחק, השהה וחידוש קודי פרסום
-
יצירה, קריאה, עדכון ומחיקה של מיסים
טיפ: ב- API, שאלות נקראות "שדות מותאמים אישית".
באתר
-
קראו ועדכנו מידע בסיסי ופרטי האפליקציה באתר
אחזור לידים ותצוגה חיה
-
קרא אם המוצר פעיל או מתפרסם באירוע
דברים שכדאי לדעת
-
לא ניתן להשתמש בממשק ה- API ליצירת אירוע או להפעלת כל אחד מהמוצרים באירוע, כגון אפליקציית האירועים ו- Onsite. לפני שמפתחים יכולים לשנות אירוע באמצעות ה- API, עליך להפעיל כל מוצר שאתה מתכוון להשתמש בו ולמלא את המידע הנדרש הבסיסי עבור כל אחד מהם.
-
מדי פעם נשחרר גרסאות חדשות של ה- API עם שיפורים ותיקונים. אנו נמשיך לתמוך בגרסאות ישנות מספיק זמן כדי שכולם יוכלו להעביר את הגרסה החדשה. אנו נשלח עדכונים בדוא"ל לגבי גרסאות חדשות, תאריכי ביטול הגירסאות הישנות הקרובים והביטול הרשמי.
-
בקשות API נמדדות ומוגבלות כדי למנוע שימוש לרעה.
-
קהילות נתמכות גם עבור לקוחות Suite.
