עמוד הבית של Canva
עזרה

הגדירו את ה-API של Canva לניהול והשתמשו בו


מאמר זה תורגם על ידי מכונה. אם נתקלתם בשגיאות, הודיעו לנו.

הערות: עליכם להשתמש בארגון ב-Canva כדי להשתמש ב-API ל מנהל. ה-API למנהל פועל ברמת הארגון.

אפשר להשתמש ב-Admin API של Canva כדי להפוך את ניהול הארגון לאוטומטי מתוך המערכות שלכם. ניהול משתמשים, צוותים, קבוצות וחברויות, וכן שליפה של אירועים מיומן הביקורת — בלי לבצע את המשימות האלה באופן ידני ב-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 למנהל מערכת

  1. עבור אל
    הגדרות.
  2. בחר/י מנהל API, ולאחר מכן בחר/י ליצור לקוח API.
  3. תן/י שם ללקוח ובחר/י את ההיקפים שמגדירים למה הלקוח יכול לגשת.
  4. בחר/י המשך.
  5. העתק/י את מזהה הלקוח ואת סוד הלקוח, ולאחר מכן בחר/י בוצע.
  6. החלף/י את פרטי הכניסה באסימון גישה, שתקף לארבע שעות.
  7. השתמש/י באסימון הגישה כדי לקרוא ל-מנהל API.

פעלו לפי התיעוד של Admin API של Canva כדי להחליף את פרטי הכניסה של הלקוח באסימון גישה ולהתחיל לשלוח בקשות ל-API.

לפרטים טכניים על אימות בקשות API ושימוש באסימוני bearer של OAuth 2.0, שתפו עם צוות ההנדסה שלכם את התיעוד בנושא אימות ב-Admin API של Canva.

היכרות עם יומני הביקורת של Admin API

פעולות שמתבצעות דרך Admin API נרשמות על שם לקוח Admin API, ולא על שם מנהל הארגון שהפעיל אותו.

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

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

למידע נוסף, ראו אודות יומני הביקורת של Canva.

הזמנת אנשים לצוותים

מנהלי ארגון יכולים להשתמש ב-Admin API כדי להזמין אנשים לצוות, כולל משתפי פעולה חיצוניים מחוץ לארגון.

חשוב לדעת

  • כל הזמנה שתיצרו מיועדת לצוות אחד ולכתובת אימייל אחת.
  • אפשר להשתמש בכל הזמנה פעם אחת, והיא פגה אחרי 30 יום.
  • בהתאם להגדרות שלכם, ייתכן ש-Canva לא תשלח את ההזמנה למוזמנים באימייל באופן אוטומטי. במקרה הצורך, שתפו את קישור ההזמנה ישירות עם המוזמנים.
  • שמרו על פרטיות קישורי ההזמנה. קישור להזמנה פועל רק עבור כתובת האימייל שעבורה נוצר.
  • הגדרות ההזמנות והדומיין הקיימות של הצוות עדיין חלות על האנשים שתזמינו.
  • אם כבר קיימת הזמנה ממתינה למוזמנים, יצירת הזמנה חדשה תחזיר את אותה רשומת הזמנה, תאפס את תוקפה ל-30 יום ממועד הבקשה ותעדכן את תפקיד המוזמנים לתפקיד המבוקש.

לפרטים על נקודות הקצה, ראו את התיעוד של Admin API של Canva.

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

האם אפשר לשלוף שוב קישור להזמנה קיימת בלי ליצור הזמנה חדשה?

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

האם זה עזר?

מועיל

לא מועיל

אנשים גם צפו ב-