הגדירו את ה-API של Canva לניהול והשתמשו בו
הערות: עליכם להשתמש בארגון ב-Canva כדי להשתמש ב-API ל מנהל. ה-API למנהל פועל ברמת הארגון.
אפשר להשתמש ב-Canva Admin API כדי להפוך את ניהול הארגון לאוטומטי מתוך המערכות שלכם. נהלו משתמשים, צוותים, קבוצות וחברויות, ושלפו אירועים מיומן הביקורת בלי לבצע את המשימות האלה ידנית ב-Canva.
בדיקת זמינות
- זמין בתוכניות Canva Enterprise, Canva Districts וקמפוס Canva.
- נגיש למנהלי ארגון.
- זמין לארגונים עם צוות אחד או כמה צוותים.
בדיקת דרישות
לפני שמגדירים את Admin API, חשוב לוודא שהארגון עומד בדרישות הבאות:
- רמת הארגון: ההיקף של Admin API הוא ארגוני. הוא זמין לארגונים עם צוות אחד או כמה צוותים בתוכניות Canva Enterprise, Canva Districts וקמפוס Canva.
- חשבון מנהל ארגון: רק מנהלי ארגון יכולים ליצור ולנהל לקוחות Admin API בהגדרות Canva.
- משאבי הנדסה פנימיים או במיקור חוץ: הארגון שלכם זקוק למשאבי הנדסה כדי לבנות את האינטגרציה ולתחזק אותה. Canva לא מספקת תמיכה בהטמעה.
- אם הצוות שלכם לא יכול לבנות אינטגרציה באמצעות API, הקצאה באמצעות SCIM מתאימה יותר לאוטומציה של ניהול המשתמשים בארגון.
- היכרות עם מבנה Canva שלכם: לפני בניית האינטגרציה, חשוב להבין היטב כיצד הארגון, הצוותים והקבוצות שלכם מוגדרים ב-Canva.
- אימות רב-שלבי (MFA) או חשבון המנוהל באמצעות כניסה יחידה (SSO): מנהל הארגון שמגדיר את Admin API חייב להפעיל MFA או להשתמש בחשבון המנוהל באמצעות SSO. החשבון חייב להיות מנוהל או בבעלות הארגון שבשמו הוא פועל.
הבנת האפשרויות לניהול
Admin API מספק נקודות קצה עבור:
- משתמשים, צוותים וקבוצות: יצירה, הצגה, עדכון ומחיקה.
- חברויות: הוספה או הסרה של אנשים מצוותים ומקבוצות, והגדרת התפקידים שלהם.
- יומני ביקורת: שליפה מתוזמנת של אירועים מיומן הביקורת.
- הזמנות לצוות: הזמנת אנשים לצוות, כולל אנשים מחוץ לארגון, הצגת הזמנות ממתינות, שליפת קישור להזמנה קיימת לפי כתובת אימייל מדויקת וביטול הזמנות.
הגדרת Admin API
מנהל ארגון יוצר לקוח Admin API ומשתמש בו כדי לשלוח בקשות ל-API.
הגדר את ה-API למנהל מערכת
- עבור אל הגדרות.
- בחר/י מנהל API, ולאחר מכן בחר/י ליצור לקוח API.
- תן/י שם ללקוח ובחר/י את ההיקפים שמגדירים למה הלקוח יכול לגשת.
- בחר/י המשך.
- העתק/י את מזהה הלקוח ואת סוד הלקוח, ולאחר מכן בחר/י בוצע.
- החלף/י את פרטי הכניסה באסימון גישה, שתקף לארבע שעות.
- השתמש/י באסימון הגישה כדי לקרוא ל-מנהל API.
פעלו לפי התיעוד של Canva Admin API כדי להחליף את פרטי הכניסה של הלקוח באסימון גישה ולהתחיל לשלוח בקשות API.
לפרטים טכניים על אימות בקשות API ושימוש באסימוני bearer של OAuth 2.0, שתפו עם צוות ההנדסה שלכם את התיעוד בנושא אימות Canva Admin API.
הבנת יומני הביקורת של Admin API
פעולות שמתבצעות באמצעות Admin API נרשמות על שם לקוח Admin API, ולא על שם המנהל שהפעיל אותו.
ביומני הביקורת, בשדה Actor מופיעים שם לקוח Admin API ומזהה הלקוח. כך אפשר לזהות איזו אינטגרציה ביצעה פעולה.
אפשר גם לזהות את מנהל הארגון שיצר, עדכן או מחק לקוח API מסוים.
למידע נוסף, ראו מידע על יומני הביקורת של Canva.
הזמנת אנשים לצוותים
מנהלי ארגון יכולים להשתמש ב-Admin API כדי להזמין אנשים לצוות, כולל משתפי פעולה חיצוניים מחוץ לארגון.
דברים שחשוב לדעת
- כל הזמנה שתיצרו מיועדת לצוות אחד ולכתובת אימייל אחת.
- אפשר להשתמש בכל הזמנה פעם אחת, והיא פגה אחרי 30 יום.
- בהתאם להגדרות שלכם, ייתכן ש-Canva לא תשלח למוזמנים אימייל באופן אוטומטי. אם צריך, שתפו את קישור ההזמנה ישירות עם המוזמנים.
- שמרו על פרטיות קישורי ההזמנה. קישור להזמנה פועל רק עבור כתובת האימייל שעבורה נוצר.
- הגדרות ההזמנות והדומיין הקיימות של הצוות שלכם עדיין חלות על האנשים שתזמינו.
- אם כבר קיימת הזמנה ממתינה עבור המוזמנים, יצירת הזמנה חדשה תחזיר את אותה רשומת הזמנה, תעדכן את תאריך התפוגה ל-30 יום ממועד הבקשה ותעדכן את תפקיד המוזמנים לתפקיד המבוקש.
לפרטים על נקודות הקצה, ראו את התיעוד של Canva Admin API.
בחירה בין Admin API ל-SCIM
גם Admin API וגם SCIM יכולים לתמוך בהקצאת משתמשים.
Admin API תומך בניהול הארגון ב-Canva מעבר להקצאת משתמשים. הוא כולל צוותים, קבוצות, חברויות ויומני ביקורת.
SCIM תומך בהקצאה ובביטול הקצאה בתהליכים סטנדרטיים. אם אתם זקוקים רק להקצאת משתמשים סטנדרטית או שהצוות שלכם לא יכול לבנות אינטגרציה מותאמת אישית ל-API, SCIM מתאים יותר לצרכים שלכם.
שאלות נפוצות
האם הארגון שלי צריך מפתח כדי להשתמש ב-Admin API?
כן. כדי להשתמש ב-Admin API, הארגון שלכם זקוק למשאבי הנדסה פנימיים או במיקור חוץ כדי לבנות את האינטגרציה ולתחזק אותה. Canva לא מספקת תמיכה בהטמעה. אם הצוות שלכם לא יכול לבנות אינטגרציה באמצעות API, הקצאה באמצעות SCIM מתאימה יותר לאוטומציה של ניהול המשתמשים בארגון.
האם כל האנשים בארגון שלי צריכים MFA או SSO כדי להשתמש ב-Admin API?
לא. רק מנהל הארגון שמגדיר את Admin API חייב להפעיל MFA או להשתמש בחשבון המנוהל באמצעות SSO. החשבון חייב להיות מנוהל או בבעלות הארגון שבשמו הוא פועל. שאר חברי הארגון לא צריכים MFA או SSO כדי ש-Admin API יפעל.
האם הארגון שלי יכול להזמין משתפי פעולה חיצוניים באמצעות Admin API?
כן. מנהלי ארגון יכולים להשתמש ב-Admin API כדי להזמין אנשים לצוותים, כולל משתפי פעולה חיצוניים. הגדרות ההזמנות והדומיין הקיימות של הצוות שלכם עדיין חלות על האנשים שתזמינו.
האם אפשר לשלוף שוב קישור להזמנה קיימת בלי ליצור הזמנה חדשה?
כן. אפשר לשלוף קישור להזמנה קיימת באמצעות כתובת האימייל המדויקת של המוזמנים, בלי ליצור הזמנה חדשה.
האם זה עזר?
מועיל
לא מועיל