Configura i utilitza l'API d'administració de Canva

Pots fer servir l’API d’administració de Canva per automatitzar la gestió de l’organització des dels teus propis sistemes. Gestiona usuaris, equips, grups i membres, i recupera esdeveniments del registre d’auditoria sense haver de fer aquestes tasques manualment a Canva.

• Disponible per a Canva Enterprise, Canva Districts i Canva Campus.
• Accessible per als administradors de l’organització.
• Disponible per a organitzacions amb un sol equip i amb diversos equips.

Abans de configurar l’API d’administració, assegura’t que l’organització compleix aquests requisits:

• Àmbit de l’organització: L’API d’administració s’aplica a tota l’organització. Està disponible per a organitzacions amb un sol equip i amb diversos equips que tinguin els plans Canva Enterprise, Canva Districts i Canva Campus.
• Compte d’administrador de l’organització: Només els administradors de l’organització poden crear i gestionar clients de l’API d’administració a la configuració de Canva.
• Enginyeria interna o externalitzada: L’organització necessita recursos d’enginyeria per crear i mantenir la integració. Canva no ofereix assistència per a la implementació.
  • Si el teu equip no pot crear una integració amb una API, l’aprovisionament SCIM és més adequat per automatitzar la gestió d’usuaris de l’organització.
• Familiaritat amb l’estructura de Canva: Abans de crear la integració, assegura’t d’entendre clarament com s’organitzen l’organització, els equips i els grups a Canva.
• Autenticació multifactor (MFA) o compte gestionat mitjançant l’inici de sessió únic (SSO): L’administrador de l’organització que configura l’API d’administració ha de tenir l’MFA activada o bé un compte gestionat mitjançant SSO. L’organització en nom de la qual actua ha de gestionar o ser propietària del compte.

L’API d’administració ofereix punts d’accés per a:

• Usuaris, equips i grups: crear, consultar, actualitzar i suprimir.
• Membres: afegir o eliminar persones dels equips i grups, i assignar-los rols.
• Registres d’auditoria: recuperar esdeveniments del registre d’auditoria segons un calendari.
• Invitacions a equips: convidar persones a un equip (incloses persones externes a l’organització), consultar les invitacions pendents, recuperar un enllaç d’invitació existent mitjançant l’adreça electrònica exacta i cancel·lar invitacions.

Un administrador de l’organització crea un client de l’API d’administració i l’utilitza per fer crides a l’API.

Segueix la documentació de l’API d’administració de Canva per intercanviar les credencials del client per un testimoni d’accés i començar a fer sol·licituds a l’API.

Per obtenir informació tècnica sobre com autenticar les sol·licituds a l’API i utilitzar els testimonis d’usuari de l’OAuth 2.0, comparteix la documentació d’autenticació de l’API d’administració de Canva amb el teu equip d’enginyeria.

Les accions fetes a través de l’API d’administració queden registrades a nom del client de l’API d’administració, no de l’administrador que l’ha utilitzat.

Als registres d’auditoria, el camp «Actor» mostra el nom i l’identificador del client de l’API d’administració. Això t’ajuda a identificar quina integració ha fet una acció.

També pots identificar l’administrador de l’organització que ha creat, actualitzat o suprimit un client concret de l’API.

Per obtenir més informació, consulta Sobre els registres d’auditoria de Canva.

Els administradors de l’organització poden fer servir l’API d’administració per convidar persones a un equip, incloses persones col·laboradores externes a l’organització.

Informació important

• Cada invitació que crees és per a un equip i una adreça electrònica.
• Cada invitació es pot fer servir una sola vegada i caduca al cap de 30 dies.
• Segons la configuració, és possible que Canva no enviï automàticament un correu electrònic a la persona convidada. Si cal, comparteix-hi directament l’enllaç d’invitació.
• Mantén privats els enllaços d’invitació. Cada enllaç només funciona amb l’adreça electrònica per a la qual s’ha creat.
• La configuració actual d’invitacions i dominis de l’equip també s’aplica a les persones que convidis.
• Si ja hi ha una invitació pendent per a la persona convidada, crear-ne una de nova retorna el mateix registre d’invitació, en reinicia la caducitat perquè sigui de 30 dies a partir de la sol·licitud i actualitza el rol de la invitació amb el rol sol·licitat.

Per consultar els detalls dels punts d’accés, consulta la documentació de l’API d’administració de Canva.

Tant l’API d’administració com SCIM permeten aprovisionar usuaris.

L’API d’administració permet gestionar altres aspectes de l’organització de Canva, més enllà de l’aprovisionament d’usuaris. Això inclou equips, grups, membres i registres d’auditoria.

SCIM permet fer l’aprovisionament i la desactivació d’usuaris estàndard. Si només necessites l’aprovisionament estàndard d’usuaris o el teu equip no pot crear una integració personalitzada amb una API, SCIM s’adapta millor a les teves necessitats.

La meva organització necessita una persona desenvolupadora per fer servir l’API d’administració?

Sí. Per fer servir l’API d’administració, l’organització necessita recursos d’enginyeria interns o externalitzats per crear i mantenir la integració. Canva no ofereix assistència per a la implementació. Si el teu equip no pot crear una integració amb una API, l’aprovisionament SCIM és més adequat per automatitzar la gestió d’usuaris de l’organització.

Tothom de l’organització necessita l’MFA o l’SSO per fer servir l’API d’administració?

No. Només l’administrador de l’organització que configura l’API d’administració ha de tenir l’MFA activada o bé un compte gestionat mitjançant SSO. L’organització en nom de la qual actua ha de gestionar o ser propietària del compte. La resta de membres de l’organització no necessiten l’MFA ni l’SSO perquè l’API d’administració funcioni.

La meva organització pot convidar persones col·laboradores externes mitjançant l’API d’administració?

Sí. Els administradors de l’organització poden fer servir l’API d’administració per convidar persones als equips, incloses persones col·laboradores externes. La configuració actual d’invitacions i dominis de l’equip també s’aplica a les persones que convidis.

Podem tornar a recuperar un enllaç d’invitació existent sense crear-ne una de nova?

Sí. Pots recuperar un enllaç d’invitació existent fent servir l’adreça electrònica exacta de la persona convidada, sense generar una invitació nova.