Nastavte a používejte rozhraní API pro správce Canvy

Pomocí Canva Admin API můžete automatizovat správu organizace z vlastních systémů. Spravujte uživatele, týmy, skupiny a členství a načítejte události z protokolu auditu, aniž byste tyto úkoly museli provádět ručně v Canvě.

• Dostupné pro Canva Enterprise, Canva Districts a Canva pro kampusy.
• Přístup mají správci organizace.
• Dostupné pro organizace s jedním i více týmy.

Než nastavíte Admin API, ujistěte se, že vaše organizace splňuje tyto požadavky:

• Úroveň organizace: Admin API je určeno pro organizace. Je dostupné organizacím s jedním i více týmy v rámci tarifů Canva Enterprise, Canva Districts a Canva pro kampusy.
• Účet správce organizace: Klienty Admin API mohou v nastavení Canvy vytvářet a spravovat pouze správci organizace.
• Interní nebo externí vývojový tým: Vaše organizace potřebuje vývojářské kapacity k vytvoření a údržbě integrace. Canva neposkytuje podporu při implementaci.
  • Pokud váš tým nedokáže pracovat s API, zřizování přes SCIM je pro automatizaci správy uživatelů ve vaší organizaci vhodnější.
• Znalost struktury vaší Canvy: Před vytvořením integrace si ujasněte, jak máte v Canvě nastavenou organizaci, týmy a skupiny.
• Vícefaktorové ověřování (MFA) nebo účet spravovaný přes jednotné přihlašování (SSO): Správce organizace, který nastavuje Admin API, musí mít zapnuté MFA nebo účet spravovaný přes SSO. Účet musí spravovat nebo vlastnit organizace, jejímž jménem správce jedná.

Admin API nabízí koncové body pro:

• Uživatele, týmy a skupiny: vytváření, čtení, aktualizaci a mazání.
• Členství: přidávání a odebírání lidí z týmů a skupin a nastavování jejich rolí.
• Protokoly auditu: plánované načítání událostí z protokolu auditu.
• Pozvánky do týmů: zvání lidí do týmu (včetně lidí mimo vaši organizaci), zobrazení nevyřízených pozvánek, načtení odkazu na existující pozvánku podle přesné e-mailové adresy a rušení pozvánek.

Správce organizace vytvoří klienta Admin API a použije ho k volání API.

Postupujte podle dokumentace Canva Admin APIe, kde se dozvíte, jak vyměnit přihlašovací údaje klienta za přístupový token a začít odesílat požadavky API.

Technické podrobnosti o ověřování požadavků API a používání nosných tokenů OAuth 2.0 sdílejte se svým vývojovým týmem prostřednictvím dokumentace k ověřování v Canva Admin API.

Akce provedené prostřednictvím Admin API se zaznamenávají pod klientem Admin API, nikoli pod konkrétním správcem, který klienta použil.

V protokolech auditu se v poli Actor zobrazuje název a ID klienta Admin API. Díky tomu zjistíte, která integrace danou akci provedla.

Můžete také zjistit, který správce organizace konkrétního klienta API vytvořil, aktualizoval nebo odstranil.

Další informace najdete v článku O protokolech auditu Canva.

Správci organizace mohou pomocí Admin API zvát lidi do týmu, včetně externích spolupracovníků mimo vaši organizaci.

Co je dobré vědět

• Každá vytvořená pozvánka platí pro jeden tým a jednu e-mailovou adresu.
• Každou pozvánku lze použít pouze jednou a platnost vyprší po 30 dnech.
• V závislosti na vašem nastavení nemusí Canva pozvané osobě poslat e-mail automaticky. V případě potřeby jí odkaz na pozvánku pošlete přímo.
• Odkazy na pozvánky uchovávejte v soukromí. Odkaz na pozvánku funguje pouze pro e-mailovou adresu, pro kterou byl vytvořen.
• Na pozvané osoby se stále vztahuje stávající nastavení pozvánek a domén vašeho týmu.
• Pokud už pro pozvanou osobu existuje nevyřízená pozvánka, vytvořením nové pozvánky se vrátí tentýž záznam pozvánky. Platnost se nastaví znovu na 30 dní od požadavku a role v pozvánce se změní na požadovanou roli.

Podrobnosti o koncových bodech najdete v dokumentaci Canva Admin API.

Admin API i SCIM umožňují zřizování uživatelských účtů.

Admin API umožňuje správu organizace Canva nad rámec zřizování uživatelských účtů. Zahrnuje týmy, skupiny, členství a protokoly auditu.

SCIM podporuje standardní zřizování a rušení zřízení účtů. Pokud potřebujete pouze standardní zřizování uživatelských účtů nebo váš tým nedokáže vytvořit vlastní integraci API, bude pro vás SCIM vhodnější.

Potřebuje moje organizace k používání Admin API vývojáře?

Ano. Vaše organizace potřebuje interní nebo externí vývojářské kapacity k vytvoření a údržbě integrace Admin API. Canva neposkytuje podporu při implementaci. Pokud váš tým nedokáže pracovat s API, je pro automatizaci správy uživatelů ve vaší organizaci vhodnější zřizování přes SCIM.

Potřebují všichni v mé organizaci k používání Admin API MFA nebo SSO?

Ne. MFA musí mít zapnuté nebo účet spravovaný přes jednotné přihlašování (SSO) musí mít pouze správce organizace, který nastavuje Admin API. Účet musí spravovat nebo vlastnit organizace, jejímž jménem správce jedná. Ostatní členové organizace MFA ani SSO k fungování Admin API nepotřebují.

Může moje organizace zvát externí spolupracovníky pomocí Admin API?

Ano. Správci organizace mohou pomocí Admin API zvát lidi do týmů, včetně externích spolupracovníků. Na pozvané osoby se stále vztahuje stávající nastavení pozvánek a domén vašeho týmu.

Můžeme znovu načíst odkaz na existující pozvánku, aniž bychom vytvářeli novou?

Ano. Odkaz na existující pozvánku můžete načíst pomocí přesné e-mailové adresy pozvané osoby, aniž byste vytvářeli novou pozvánku.