Állítsd be és használd a Canva adminisztrátor API-t

A Canva Admin API-val automatizálhatod a szervezeted kezelését a saját rendszereidből. Kezeld a felhasználókat, csapatokat, csoportokat és tagságokat, valamint kérd le az auditnapló eseményeit anélkül, hogy ezeket manuálisan kellene elvégezned a Canvában.

• A Canva Enterprise, a Canva Districts és a Canva Campus csomagban érhető el.
• A szervezeti adminisztrátorok férhetnek hozzá.
• Egy- és többcsapatos szervezetek számára is elérhető.

Mielőtt beállítod az Admin API-t, győződj meg róla, hogy a szervezeted megfelel az alábbi követelményeknek:

• Szervezeti szint: Az Admin API szervezeti szinten működik. A Canva Enterprise, a Canva Districts és a Canva Campus csomag egy- és többcsapatos szervezetei számára érhető el.
• Szervezeti adminisztrátori fiók: Csak a szervezeti adminisztrátorok hozhatnak létre és kezelhetnek Admin API-klienseket a Canva beállításaiban.
• Belső vagy külső mérnöki erőforrások: A szervezetednek szüksége van mérnöki erőforrásokra az integráció létrehozásához és karbantartásához. A Canva nem nyújt segítséget a megvalósításhoz.
  • Ha a csapatod nem tud API-val dolgozó megoldást fejleszteni, a SCIM-alapú kiépítés jobban megfelel a szervezeten belüli felhasználókezelés automatizálására.
• A Canva-struktúra ismerete: Mielőtt elkészíted az integrációt, pontosan ismerd meg, hogyan épül fel a szervezeted, illetve hogyan vannak beállítva a csapatok és csoportok a Canvában.
• Többtényezős hitelesítéssel (MFA) vagy egyszeri bejelentkezéssel (SSO) kezelt fiók: Az Admin API-t beállító szervezeti adminisztrátornak be kell kapcsolnia az MFA-t, vagy egyszeri bejelentkezéssel kezelt fiókkal kell rendelkeznie. A fiókot annak a szervezetnek kell kezelnie vagy birtokolnia, amelynek a nevében eljár.

Az Admin API az alábbi műveletekhez biztosít végpontokat:

• Felhasználók, csapatok és csoportok: létrehozás, lekérdezés, frissítés és törlés.
• Tagságok: személyek hozzáadása csapatokhoz és csoportokhoz, illetve eltávolítása onnan, valamint szerepkörök beállítása.
• Auditnaplók: auditnapló-események ütemezett lekérése.
• Csapatmeghívók: személyek meghívása egy csapatba (a szervezeten kívülieket is beleértve), függőben lévő meghívók megtekintése, meglévő meghívólink lekérése a pontos e-mail-cím alapján, valamint meghívók visszavonása.

A szervezeti adminisztrátor létrehoz egy Admin API-klienst, majd ezzel hívja meg az API-t.

Kövesd a Canva Admin API dokumentációját, hogy hozzáférési jogkivonatra váltsd be a kliens hitelesítő adatait, és elkezdj API-kéréseket küldeni.

Az API-kérések hitelesítésével és az OAuth 2.0 bearer tokenek használatával kapcsolatos műszaki részletekért oszd meg a mérnöki csapatoddal a Canva Admin API-hitelesítés dokumentációját.

Az Admin API-n keresztül végrehajtott műveletek az Admin API-klienshez lesznek rögzítve, nem pedig ahhoz az adminisztrátorhoz, aki meghívta a klienst.

Az auditnaplókban a Actor mező az Admin API-kliens nevét és kliensazonosítóját jeleníti meg. Így beazonosíthatod, hogy melyik integráció hajtotta végre az adott műveletet.

Azt is megállapíthatod, hogy melyik szervezeti adminisztrátor hozott létre, frissített vagy törölt egy adott API-klienst.

További információért lásd: Tudnivalók a Canva auditnaplóiról.

A szervezeti adminisztrátorok az Admin API-val személyeket hívhatnak meg egy csapatba, köztük a szervezeten kívüli külső közreműködőket is.

Fontos tudnivalók

• Minden létrehozott meghívó egyetlen csapatra és egyetlen e-mail-címre szól.
• Minden meghívó egyszer használható fel, és 30 nap után lejár.
• A beállításoktól függően előfordulhat, hogy a Canva nem küld automatikusan e-mailt a meghívottnak. Ha szükséges, oszd meg vele közvetlenül a meghívólinket.
• Tartsd bizalmasan a meghívólinkeket. Egy meghívólink csak ahhoz az e-mail-címhez használható, amelyhez létrehozták.
• A csapatod meglévő meghívási és domainbeállításai a meghívottakra is érvényesek.
• Ha már van függőben lévő meghívó a meghívottnak, új meghívó létrehozásakor ugyanaz a meghívórekord érkezik vissza. A lejárati idő a kéréstől számított 30 napra áll vissza, a meghívott szerepköre pedig a kért szerepkörre frissül.

A végpontok részleteiért lásd a Canva Admin API dokumentációját.

Az Admin API és a SCIM is használható a felhasználók kiépítésére.

Az Admin API a felhasználók kiépítésén túlmutató Canva-szervezetkezelést is támogat. Ide tartoznak a csapatok, csoportok, tagságok és auditnaplók.

A SCIM támogatja a szabványos kiépítést és a hozzáférések megszüntetését. Ha csak szabványos felhasználó-kiépítésre van szükséged, vagy a csapatod nem tud egyedi API-integrációt fejleszteni, a SCIM jobban megfelel az igényeidnek.

Szüksége van fejlesztőre a szervezetemnek az Admin API használatához?

Igen. Az Admin API használatához a szervezetednek belső vagy külső mérnöki erőforrásokra van szüksége az integráció létrehozásához és karbantartásához. A Canva nem nyújt segítséget a megvalósításhoz. Ha a csapatod nem tud API-val dolgozó megoldást fejleszteni, a SCIM-alapú kiépítés jobban megfelel a szervezeten belüli felhasználókezelés automatizálására.

Szüksége van mindenkinek MFA-ra vagy SSO-ra a szervezetemben az Admin API használatához?

Nem. Csak az Admin API-t beállító szervezeti adminisztrátornak kell bekapcsolnia az MFA-t, vagy egyszeri bejelentkezéssel kezelt fiókkal rendelkeznie. A fiókot annak a szervezetnek kell kezelnie vagy birtokolnia, amelynek a nevében eljár. A szervezet többi tagjának nem kell MFA-t vagy SSO-t használnia ahhoz, hogy az Admin API működjön.

Meghívhat a szervezetem külső közreműködőket az Admin API-val?

Igen. A szervezeti adminisztrátorok az Admin API-val személyeket hívhatnak meg a csapatokba, köztük külső közreműködőket is. A csapatod meglévő meghívási és domainbeállításai a meghívottakra is érvényesek.

Új meghívó létrehozása nélkül is újra lekérhetjük egy meglévő meghívó linkjét?

Igen. Új meghívó létrehozása nélkül is lekérheted egy meglévő meghívó linkjét a meghívott pontos e-mail-címe alapján.