Nastavte a používajte rozhranie Canva API správcu
Poznámka: Na používanie rozhrania Admin API potrebujete organizáciu v Canve. Rozhranie Admin API funguje na úrovni organizácie.
Pomocou rozhrania Canva Admin API môžete automatizovať správu organizácie z vlastných systémov. Spravujte používateľov, tímy, skupiny a členstvá a získavajte udalosti z auditového protokolu bez toho, aby ste tieto úlohy museli vykonávať manuálne v Canve.
Skontrolujte dostupnosť
- Dostupné v rámci plánov Canva Enterprise, Canva Districts a Canva Kampusy.
- Prístup majú správcovia organizácie.
- Dostupné pre organizácie s jedným aj viacerými tímami.
Skontrolujte požiadavky
Pred nastavením rozhrania Admin API sa uistite, že vaša organizácia spĺňa tieto požiadavky:
- Úroveň organizácie: Rozhranie Admin API sa vzťahuje na celú organizáciu. Je dostupné pre organizácie s jedným aj viacerými tímami v rámci plánov Canva Enterprise, Canva Districts a Canva Kampusy.
- Účet správcu organizácie: Iba správcovia organizácie môžu v nastaveniach Canvy vytvárať a spravovať klientov Admin API.
- Interný alebo externý technický tím: Vaša organizácia potrebuje technické kapacity na vytvorenie a údržbu integrácie. Canva neposkytuje podporu pri jej implementácii.
- Ak váš tím nedokáže vytvoriť integráciu pomocou rozhrania API, na automatizáciu správy používateľov vo vašej organizácii sa viac hodí spravovanie SCIM .
- Znalosť štruktúry vašej organizácie v Canve: Pred vytvorením integrácie si ujasnite, ako sú v Canve nastavené vaša organizácia, tímy a skupiny.
- Viacfaktorové overenie (MFA) alebo účet spravovaný cez jediné prihlásenie: Správca organizácie, ktorý konfiguruje rozhranie Admin API, musí mať zapnuté MFA alebo účet spravovaný cez jediné prihlásenie. Účet musí spravovať alebo vlastniť organizácia, v mene ktorej koná.
Zistite, čo môžete spravovať
Rozhranie Admin API poskytuje koncové body na:
- Používateľov, tímy a skupiny: Vytváranie, zobrazovanie, aktualizovanie a odstraňovanie.
- Členstvá: Pridávanie a odoberanie ľudí z tímov a skupín a nastavovanie ich rolí.
- Auditové protokoly: Plánované získavanie udalostí z auditového protokolu.
- Pozvánky do tímov: Pozývanie ľudí do tímu (vrátane ľudí mimo vašej organizácie), zobrazenie čakajúcich pozvánok, získanie odkazu na existujúcu pozvánku podľa presnej e-mailovej adresy a zrušenie pozvánok.
Nastavte rozhranie Admin API
Správca organizácie vytvorí klienta Admin API a použije ho na volanie rozhrania API.
Nastavte rozhranie Admin API
- Prejdite na Nastavenia.
- Vyberte API správcu, potom vyberte Vytvoriť klienta API.
- Pomenujte klienta a vyberte rozsahy, ktoré definujú, k čomu má klient prístup.
- Vyberte Pokračovať.
- Skopírujte ID klienta a tajný kľúč klienta, potom vyberte Hotovo.
- Vymeňte prihlasovacie údaje za prístupový token, ktorý je platný štyri hodiny.
- Pomocou prístupového tokenu volajte API správcu.
Postupujte podľa dokumentáciu k rozhraniu Canva Admin API, vymeňte prihlasovacie údaje klienta za prístupový token a začnite odosielať požiadavky rozhraniu API.
Technické podrobnosti o overovaní požiadaviek rozhrania API a používaní nosných tokenov OAuth 2.0 nájdete v dokumentácii k overovaniu Canva Admin API, ktorú môžete poskytnúť svojmu technickému tímu.
Zistite viac o auditových protokoloch Admin API
Akcie vykonané prostredníctvom rozhrania Admin API sa zaznamenávajú pod klientom Admin API, nie pod správcom, ktorý klienta použil.
V auditových protokoloch sa v poli Actor zobrazuje názov a ID klienta Admin API. Vďaka tomu zistíte, ktorá integrácia vykonala danú akciu.
Môžete tiež zistiť, ktorý správca organizácie vytvoril, aktualizoval alebo odstránil konkrétneho klienta API.
Ďalšie informácie nájdete v článku Informácie o auditových protokoloch Canvy.
Pozývanie ľudí do tímov
Správcovia organizácie môžu pomocou rozhrania Admin API pozývať ľudí do tímu vrátane externých spolupracovníkov mimo organizácie.
Čo treba vedieť
- Každá pozvánka, ktorú vytvoríte, platí pre jeden tím a jednu e-mailovú adresu.
- Každú pozvánku možno použiť iba raz a platnosť jej vyprší po 30 dňoch.
- V závislosti od vašich nastavení Canva nemusí pozvanému automaticky poslať e-mail. V prípade potreby mu odkaz na pozvánku pošlite priamo.
- Odkazy na pozvánky uchovávajte v súkromí. Odkaz na pozvánku funguje iba pre e-mailovú adresu, pre ktorú bol vytvorený.
- Na pozvaných ľudí sa naďalej vzťahujú existujúce nastavenia pozvánok a domény vášho tímu.
- Ak už pre pozvanú osobu existuje čakajúca pozvánka, vytvorením novej pozvánky sa vráti rovnaký záznam pozvánky. Jej platnosť sa obnoví na 30 dní od podania žiadosti a rola v pozvánke sa aktualizuje na požadovanú rolu.
Podrobnosti o koncových bodoch nájdete v dokumentácii k rozhraniu Canva Admin API.
Vyberte si medzi rozhraniami Admin API a SCIM
Rozhrania Admin API aj SCIM podporujú spravovanie používateľských účtov.
Rozhranie Admin API umožňuje spravovať v Canve viac než len používateľské účty. Zahŕňa tímy, skupiny, členstvá a auditové protokoly.
SCIM podporuje štandardné spravovanie a odoberanie prístupu. Ak potrebujete iba štandardné spravovanie používateľských účtov alebo váš tím nedokáže vytvoriť vlastnú integráciu API, SCIM bude pre vás vhodnejšou voľbou.
Najčastejšie otázky
Potrebuje moja organizácia na používanie rozhrania Admin API vývojára?
Áno. Na vytvorenie a údržbu integrácie potrebuje vaša organizácia interné alebo externé technické kapacity. Canva neposkytuje podporu pri jej implementácii. Ak váš tím nedokáže vytvoriť integráciu pomocou rozhrania API, na automatizáciu správy používateľov vo vašej organizácii sa viac hodí spravovanie SCIM.
Potrebujú všetci v mojej organizácii na používanie rozhrania Admin API MFA alebo jediné prihlásenie?
Nie. Iba správca organizácie, ktorý konfiguruje rozhranie Admin API, musí mať zapnuté MFA alebo účet spravovaný cez jediné prihlásenie. Účet musí spravovať alebo vlastniť organizácia, v mene ktorej koná. Ostatní členovia organizácie nepotrebujú MFA ani jediné prihlásenie špeciálne na to, aby rozhranie Admin API fungovalo.
Môže naša organizácia pozývať externých spolupracovníkov pomocou rozhrania Admin API?
Áno. Správcovia organizácie môžu pomocou rozhrania Admin API pozývať ľudí do tímov vrátane externých spolupracovníkov. Na pozvaných ľudí sa naďalej vzťahujú existujúce nastavenia pozvánok a domény vášho tímu.
Môžeme znova získať odkaz na existujúcu pozvánku bez vytvorenia novej?
Áno. Odkaz na existujúcu pozvánku môžete získať pomocou presnej e-mailovej adresy pozvanej osoby bez vytvorenia novej pozvánky.
Boli tieto informácie užitočné?
Užitočné
Neužitočné