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 la organización desde tus propios sistemas. Gestiona usuarios, equipos, grupos y membresías, y consulta eventos del registro de auditoría sin tener que realizar estas tareas manualmente en Canva.

• Disponible para Canva Enterprise, Canva Districts y Canva Universidades.
• La pueden usar quienes administran la organización.
• Disponible para organizaciones con un equipo o con varios equipos.

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

• Ámbito de la organización: la API de administración funciona en el ámbito de la organización. Está disponible para organizaciones con un equipo o con varios equipos que tengan los planes Canva Enterprise, Canva Districts y Canva Universidades.
• Cuenta de administración de la organización: solo quienes administran la organización pueden crear y gestionar clientes de la API de administración en la configuración de Canva.
• Personal de ingeniería interno o externo: tu organización necesita recursos de ingeniería para crear y mantener la integración. Canva no ofrece asistencia para la implementación.
  • Si tu equipo no puede crear una integración con una API, el aprovisionamiento mediante SCIM es una opción más adecuada para automatizar la gestión de usuarios de tu organización.
• Familiaridad con la estructura de Canva: antes de crear 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 gestionada mediante el inicio de sesión único (SSO): quien administre la organización y configure la API de administración debe tener activada la MFA o usar una cuenta gestionada mediante el inicio de sesión único (SSO). La organización en cuyo nombre actúe debe gestionar 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: añadir o quitar personas de equipos y grupos, y asignarles roles.
• Registros de auditoría: consultar eventos del registro de auditoría de forma programada.
• Invitaciones a equipos: invitar a personas a un equipo (incluidas personas ajenas a tu organización), consultar las invitaciones pendientes, recuperar un enlace de invitación existente usando la dirección de correo exacta y cancelar invitaciones.

Quien administre la organización crea un cliente de la API de administración y lo utiliza para realizar llamadas 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 enviar solicitudes a la API.

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

Las acciones realizadas a través de la API de administración se registran a nombre del cliente de la API de administración, no de la persona que lo administra y lo ha utilizado.

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 ha realizado una acción.

También puedes identificar a quien haya creado, actualizado o eliminado un cliente de API concreto en la administración de la organización.

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

Quienes administran la organización pueden usar la API de administración para invitar a personas a un equipo, incluidas las colaboradoras externas 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 caduca al cabo de 30 días.
• Según tu configuración, es posible que Canva no envíe automáticamente un correo a la persona invitada. Si hace falta, comparte directamente con ella el enlace de invitación.
• Mantén en privado 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 hay una invitación pendiente para la persona invitada, al crear una nueva se devuelve el mismo registro de invitación, se restablece la caducidad a 30 días desde la solicitud y se actualiza el rol de la invitación al rol solicitado.

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

Tanto la API de administración como SCIM permiten aprovisionar usuarios.

La API de administración permite gestionar otros aspectos de una organización de Canva, además del aprovisionamiento de usuarios. Entre ellos se incluyen los equipos, los grupos, las membresías y los registros de auditoría.

SCIM permite realizar el aprovisionamiento y el desaprovisionamiento estándar. Si solo necesitas el aprovisionamiento estándar de usuarios o tu equipo no puede crear una integración de API personalizada, SCIM es una opción más adecuada para ti.

¿Necesita mi organización contar con personal de desarrollo 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 externos para crear y mantener la integración. Canva no ofrece asistencia para la implementación. Si tu equipo no puede crear una integración con una API, el aprovisionamiento mediante SCIM es una opción más adecuada para automatizar la gestión de usuarios de tu organización.

¿Necesitan todas las personas de mi organización tener activada la MFA o usar el inicio de sesión único (SSO) para utilizar la API de administración?

No. Solo quien administre la organización y configure la API de administración debe tener activada la MFA o usar una cuenta gestionada mediante el inicio de sesión único (SSO). La organización en cuyo nombre actúe debe gestionar o ser propietaria de la cuenta. El resto de las personas de la organización no necesita tener activada la MFA ni usar el inicio de sesión único (SSO) para que la API de administración funcione.

¿Puede mi organización invitar a colaboradores externos mediante la API de administración?

Sí. Quienes administran la organización pueden usar la API de administración para invitar a personas a equipos, incluidas las colaboradoras externas. La configuración actual de invitaciones y dominios de tu equipo también se aplica a las personas que invites.

¿Podemos volver a recuperar 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.