Configura y usa la API de administración de Canva

Puedes usar la API de administración de Canva para automatizar la gestión de tu organización desde tus propios sistemas. Administra usuarios, equipos, grupos y membresías, y consulta eventos del registro de auditoría sin tener que realizar estas tareas manualmente en Canva.

• Disponible en los planes Canva Empresas, Canva Distritos y Canva Universidades.
• Disponible para admins de la organización.
• Disponible para organizaciones con uno o varios equipos.

Antes de configurar la API de administración, asegúrate de que tu organización cumpla estos requisitos:

• Capa de la organización: La API de administración tiene alcance a nivel de organización. Está disponible para organizaciones con uno o varios equipos que tengan los planes Canva Empresas, Canva Distritos y Canva Universidades.
• Cuenta de admin de la organización: Solo los admins de la organización pueden crear y administrar clientes de la API de administración en la configuración de Canva.
• Ingeniería interna o subcontratada: Tu organización necesita recursos de ingeniería para desarrollar y mantener la integración. Canva no ofrece asistencia para la implementación.
  • Si tu equipo no puede desarrollar una integración con una API, el aprovisionamiento con SCIM es una mejor opción para automatizar la gestión de usuarios en tu organización.
• Familiaridad con la estructura de Canva: Antes de desarrollar la integración, asegúrate de entender bien cómo están configurados tu organización, tus equipos y tus grupos en Canva.
• Autenticación multifactor (MFA) o cuenta administrada mediante inicio de sesión único (SSO): La persona a cargo de la organización que configure la API de administración debe tener activada la MFA o usar una cuenta administrada mediante SSO. La organización en cuyo nombre actúe debe administrar o ser propietaria de la cuenta.

La API de administración ofrece endpoints para:

• Usuarios, equipos y grupos: crear, consultar, actualizar y eliminar.
• Membresías: agregar o quitar personas de equipos y grupos, y asignarles roles.
• Registros de auditoría: consultar eventos del registro de auditoría según una programación.
• Invitaciones a equipos: invitar personas a un equipo (incluso a personas ajenas a tu organización), consultar invitaciones pendientes, recuperar un enlace de invitación existente usando el correo electrónico exacto y cancelar invitaciones.

Una persona a cargo de la organización crea un cliente de la API de administración y lo usa para llamar a la API.

Sigue la documentación de la API de administración de Canva para intercambiar las credenciales de tu cliente por un token de acceso y empezar a hacer solicitudes a la API.

Para obtener detalles técnicos sobre cómo autenticar solicitudes a la API y usar tokens de portador de OAuth 2.0, comparte la documentación sobre la autenticación de la API de administración de Canva con tu equipo de ingeniería.

Las acciones realizadas mediante la API de administración quedan registradas a nombre del cliente de la API de administración, no de la persona a cargo que la usó.

En los registros de auditoría, el campo Actor muestra el nombre y el ID del cliente de la API de administración. Esto te ayuda a identificar qué integración realizó una acción.

También puedes identificar a la persona a cargo de la organización que creó, actualizó o eliminó un cliente específico de la API.

Para obtener más información, consulta Acerca de los registros de auditoría de Canva.

Los admins de la organización pueden usar la API de administración para invitar personas a un equipo, incluso a colaboradores externos ajenos a la organización.

Información importante

• Cada invitación que crees es para un equipo y una dirección de correo electrónico.
• Cada invitación se puede usar una sola vez y vence después de 30 días.
• Según tu configuración, es posible que Canva no envíe automáticamente un correo electrónico a la persona invitada. Si es necesario, comparte el enlace de invitación directamente con esa persona.
• Mantén privados los enlaces de invitación. Cada enlace solo funciona con la dirección de correo electrónico para la que se creó.
• La configuración actual de invitaciones y dominios de tu equipo también se aplica a las personas que invites.
• Si ya existe una invitación pendiente para la persona, al crear una nueva se devolverá el mismo registro de invitación, se restablecerá su vencimiento a 30 días a partir de la solicitud y se actualizará el rol de la invitación al rol solicitado.

Para consultar los detalles de los endpoints, revisa la documentación de la API de administración de Canva.

Tanto la API de administración como SCIM pueden facilitar el aprovisionamiento de usuarios.

La API de administración permite gestionar más aspectos de una organización de Canva además del aprovisionamiento de usuarios. Esto incluye equipos, grupos, membresías y registros de auditoría.

SCIM permite realizar el aprovisionamiento y desaprovisionamiento estándar. Si solo necesitas el aprovisionamiento estándar de usuarios o tu equipo no puede desarrollar una integración de API personalizada, SCIM se adapta mejor a tus necesidades.

¿Mi organización necesita una persona desarrolladora para usar la API de administración?

Sí. Para usar la API de administración, tu organización necesita recursos de ingeniería internos o subcontratados para desarrollar y mantener la integración. Canva no ofrece asistencia para la implementación. Si tu equipo no puede desarrollar una integración con una API, el aprovisionamiento con SCIM es una mejor opción para automatizar la gestión de usuarios en tu organización.

¿Todas las personas de mi organización necesitan usar MFA o SSO para utilizar la API de administración?

No. Solo la persona a cargo de la organización que configure la API de administración debe tener activada la MFA o usar una cuenta administrada mediante SSO. La organización en cuyo nombre actúe debe administrar o ser propietaria de la cuenta. El resto de las personas de la organización no necesita usar MFA ni SSO específicamente para que funcione la API de administración.

¿Mi organización puede invitar a colaboradores externos mediante la API de administración?

Sí. Los admins de la organización pueden usar la API de administración para invitar personas a los equipos, incluso a colaboradores externos. La configuración actual de invitaciones y dominios de tu equipo también se aplica a las personas que invites.

¿Podemos volver a obtener un enlace de invitación existente sin crear una invitación nueva?

Sí. Puedes recuperar un enlace de invitación existente usando la dirección de correo electrónico exacta de la persona invitada, sin generar una invitación nueva.