Állítsd be és használd a Canva adminisztrátor API-t
Megjegyzés: az Admin API használatához egy Canva-szervezettel kell rendelkezned. Az Admin API szervezeti szinten működik.
A Canva Admin API segítségével saját rendszereidből automatizálhatod a szervezetkezelést. Kezeld a felhasználókat, csapatokat, csoportokat és tagságokat, valamint kérd le az auditnapló eseményeit anélkül, hogy ezeket a feladatokat manuálisan kellene elvégezned a Canvában.
Ellenőrizd az elérhetőséget
- A Canva Enterprise, a Canva Districts és a Canva Campus csomagban érhető el.
- A szervezeti adminisztrátorok férhetnek hozzá.
- Egycsapatos és többcsapatos szervezetek számára is elérhető.
Ellenőrizd a követelményeket
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. Egycsapatos és többcsapatos szervezetek számára érhető el a Canva Enterprise, a Canva Districts és a Canva Campus csomagban.
- 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ő fejlesztői erőforrások: A szervezetednek szüksége van fejlesztői erőforrásokra az integráció létrehozásához és karbantartásához. A Canva nem nyújt megvalósítási támogatást.
- Ha a csapatod nem tud API-integrációt fejleszteni, a SCIM-alapú kiépítés megfelelőbb megoldás a szervezeti felhasználókezelés automatizálására.
- A Canva-struktúra ismerete: Az integráció létrehozása előtt fontos, hogy tisztában legyél azzal, hogyan épül fel a szervezeted, és 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 engedélyezett MFA-val vagy SSO-val kezelt fiókkal kell rendelkeznie. A fiókot annak a szervezetnek kell kezelnie vagy birtokolnia, amelynek a nevében eljár.
Tudd meg, mit kezelhetsz
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 szervezeteden kívülieket is), 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.
Az Admin API beállítása
Egy szervezeti adminisztrátor létrehoz egy Admin API-klienst, majd ezt használja az API-hívásokhoz.
Állítsd be az adminisztrátor API-t
- Menjen a beállításokhoz.
- Válassza az adminisztrátor API-t, majd válassza az API-kliens létrehozása lehetőséget.
- Nevezze el a klienst, és válassza ki azokat a hatóköröket, amelyek meghatározzák, hogy a kliens mihez férhet hozzá.
- Válassza a Folytatáslehetőséget.
- Másolja ki az ügyfél-azonosítót és az ügyfélkulcsot, majd válassza a Kész lehetőséget.
- Cserélje ki a hitelesítő adatokat egy hozzáférési jogkivonatra, amely négy óráig érvényes.
- Használja a hozzáférési jogkivonatot az adminisztrátor API meghívásához.
Kövesd a Canva Admin API dokumentációját, hogy a kliens hitelesítő adataidat hozzáférési jogkivonatra váltsd, és API-kéréseket küldhess.
Az API-kérések hitelesítésével és az OAuth 2.0 bearer tokenek használatával kapcsolatos technikai részletekért oszd meg a fejlesztői csapatoddal a Canva Admin API hitelesítési dokumentációját.
Ismerd meg az Admin API auditnaplóit
Az Admin API-n keresztül végrehajtott műveleteket az Admin API-klienshez rögzítjük, nem pedig ahhoz az egyéni adminisztrátorhoz, aki a klienst használta.
Az auditnaplókban a Műveletvégző mező az Admin API-kliens nevét és kliensazonosítóját jeleníti meg. Így beazonosíthatod, melyik integráció hajtott végre egy műveletet.
Azt is megállapíthatod, melyik szervezeti adminisztrátor hozott létre, frissített vagy törölt egy adott API-klienst.
További információért lásd: A Canva auditnaplóinak bemutatása.
Személyek meghívása csapatokba
A szervezeti adminisztrátorok az Admin API segítségével személyeket hívhatnak meg egy csapatba, köztük a szervezetükön kívüli közreműködőket is.
Fontos tudnivalók
- Minden létrehozott meghívó egy csapatra és egy e-mail-címre szól.
- Minden meghívó egyszer használható fel, és 30 nap után lejár.
- A beállításaidtó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.
- A meghívólinkeket tartsd bizalmasan. Egy meghívólink csak azzal az e-mail-címmel használható, amelyhez létrehozták.
- A meghívottakra továbbra is érvényesek a csapatod meglévő meghívási és domainbeállításai.
- Ha a meghívottnak már van függőben lévő meghívója, új meghívó létrehozásakor a rendszer ugyanazt a meghívórekordot adja vissza. A lejárati idő a kéréstől számított 30 napra módosul, a meghívó 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.
Válassz az Admin API és a SCIM között
Az Admin API és a SCIM is támogatja a felhasználók kiépítését.
Az Admin API a felhasználók kiépítésén túl a Canva-szervezetek kezelését is támogatja. 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 megfelelőbb megoldás az igényeidre.
Gyakori kérdések
Szüksége van a szervezetemnek fejlesztőre az Admin API használatához?
Igen. Az Admin API használatához a szervezetednek belső vagy külső fejlesztői erőforrásokra van szüksége az integráció létrehozásához és karbantartásához. A Canva nem nyújt megvalósítási támogatást. Ha a csapatod nem tud API-integrációt fejleszteni, a SCIM-alapú kiépítés megfelelőbb megoldás a szervezeti felhasználókezelés automatizálására.
A szervezetemben mindenkinek MFA-t vagy SSO-t kell használnia az Admin API használatához?
Nem. Csak az Admin API-t beállító szervezeti adminisztrátornak kell engedélyezett MFA-val vagy SSO-val 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 használatával?
Igen. A szervezeti adminisztrátorok az Admin API segítségével személyeket hívhatnak meg csapatokba, a külső közreműködőket is beleértve. A meghívottakra továbbra is érvényesek a csapatod meglévő meghívási és domainbeállításai.
Új meghívó létrehozása nélkül is lekérhetjük újra egy meglévő meghívó linkjét?
Igen. A meghívott pontos e-mail-címével lekérheted a meglévő meghívólinket, új meghívó létrehozása nélkül.
Hasznos volt az információ?
Hasznos
Nem volt hasznos