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 ručně provádět v Canvě.

• Dostupné v tarifech 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, ověřte, že vaše organizace splňuje tyto požadavky:

• Vrstva organizace: Admin API je vázané na organizaci. Je dostupné organizacím s jedním i více týmy v tarifech Canva Enterprise, Canva Districts a Canva pro kampusy.
• Účet správce organizace: Klienty Admin API v nastavení Canvy mohou vytvářet a spravovat pouze správci organizace.
• Interní nebo externí technické kapacity: Vaše organizace potřebuje technické kapacity k vytvoření a údržbě integrace. Canva neposkytuje podporu při implementaci.
  • Pokud váš tým nedokáže vytvořit řešení využívající API, pro automatizaci správy uživatelů ve vaší organizaci se lépe hodí zřizování uživatelů pomocí SCIM.
• Znalost struktury vaší Canvy: Než začnete integraci vytvářet, ujistěte se, že dobře rozumíte tomu, jak jsou v Canvě nastavené vaše organizace, týmy a skupiny.
• Vícefaktorové ověřování (MFA) nebo účet spravovaný pomocí jednotného přihlašování: Správce organizace, který nastavuje Admin API, musí mít zapnuté MFA nebo účet spravovaný pomocí jednotného přihlašování. Účet musí být spravován organizací, za kterou jedná, nebo jí musí patřit.

Admin API nabízí koncové body pro:

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

Správce organizace vytvoří klienta Admin API a pomocí něj volá API.

Podle pokynů v dokumentaci Canva Admin API dokumentaci vyměňte přihlašovací údaje klienta za přístupový token a začněte odesílat požadavky na API.

Technické podrobnosti o ověřování požadavků API a používání bearer tokenů OAuth 2.0 sdílejte se svým technickým týmem v dokumentaci 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 akci provedla.

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

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

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

Co je dobré vědět

• Každá pozvánka, kterou vytvoříte, 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ě automaticky poslat e-mail. V případě potřeby jí odkaz na pozvánku pošlete přímo.
• Odkazy na pozvánky uchovávejte v soukromí. Každý odkaz 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ény vašeho týmu.
• Pokud už pro pozvanou osobu existuje čekající pozvánka, vytvořením nové pozvánky získáte stejný záznam pozvánky. Platnost se obnoví na 30 dní od žádosti a role v pozvánce se aktualizuje na požadovanou roli.

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

Admin API i SCIM podporují zřizování uživatelů.

Admin API umožňuje spravovat v organizaci Canva víc než jen zřizování uživatelů. Zahrnuje týmy, skupiny, členství a protokoly auditu.

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

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

Ano. Vaše organizace potřebuje interní nebo externí technické kapacity k vytvoření a údržbě integrace Admin API. Canva neposkytuje podporu při implementaci. Pokud váš tým nedokáže vytvořit řešení využívající API, pro automatizaci správy uživatelů ve vaší organizaci se lépe hodí zřizování uživatelů pomocí SCIM.

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

Ne. Správce organizace, který nastavuje Admin API, musí mít zapnuté MFA nebo účet spravovaný pomocí jednotného přihlašování. Účet musí být spravován organizací, za kterou jedná, nebo jí musí patřit. Ostatní členové organizace nemusí mít MFA ani jednotné přihlašování, aby Admin API fungovalo.

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

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ény vašeho týmu.

Můžeme znovu načíst odkaz na existující pozvánku, aniž bychom vytvořili 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.