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 en Canva Enterprise, Canva Distritos y Canva Universidades.
• Accesible para quienes administran 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 cumple estos requisitos:

• Ámbito de la organización: La API de administración se aplica a toda la organización. Está disponible para organizaciones con uno o varios equipos que tengan los planes Canva Enterprise, Canva Distritos o 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.
• Ingeniería propia o externalizada: Tu organización necesita recursos de ingeniería para desarrollar y mantener la integración. Canva no ofrece asistencia para implementarla.
  • Si tu equipo no puede desarrollar 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 desarrollar la integración, asegúrate de tener claro cómo están organizados tu organización, tus equipos y tus grupos en Canva.
• Cuenta gestionada mediante autenticación multifactor (MFA) o inicio de sesión único (SSO): Quien administre la organización y configure la API de administración debe tener activada la autenticación multifactor (MFA) o una cuenta gestionada mediante SSO. La organización en cuyo nombre actúe debe gestionar o ser titular de la cuenta.

La API de administración ofrece endpoints para:

• Usuarios, equipos y grupos: crearlos, consultarlos, actualizarlos y eliminarlos.
• Membresías: añadir o quitar personas de equipos y grupos, y asignarles roles.
• Registros de auditoría: consultar periódicamente los eventos del registro de auditoría.
• Invitaciones a equipos: invitar a personas a un equipo (también a personas ajenas a tu organización), consultar las invitaciones pendientes, recuperar un enlace de invitación existente indicando el correo electrónico exacto y cancelar invitaciones.

Quien administra 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 tus credenciales de cliente por un token de acceso y empezar a enviar solicitudes a la API.

Para consultar los detalles técnicos sobre cómo autenticar solicitudes a la API y usar tokens bearer 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 se registran a nombre del cliente de la API de administración, no de la persona que administra la organización y lo utilizó.

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 quién administra la organización y creó, actualizó o eliminó un cliente de API concreto.

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 personas 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 la configuración, es posible que Canva no envíe automáticamente un correo electrónico a la persona invitada. Si es necesario, comparte directamente el enlace de invitación con esa persona.
• Mantén la privacidad de 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 esa persona, al crear una nueva se devolverá el mismo registro de invitación, se restablecerá la caducidad a 30 días desde la solicitud y se actualizará el rol de la invitación al 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. 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 personalizada con una API, SCIM es una opción más adecuada.

¿Necesita mi organización contar con 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 propios o externalizados para desarrollar y mantener la integración. Canva no ofrece asistencia para implementarla. Si tu equipo no puede desarrollar 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.

¿Todas las personas de mi organización necesitan autenticación multifactor (MFA) o inicio de sesión único (SSO) para usar la API de administración?

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

¿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 personas 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 obtener un enlace de invitación existente sin crear otra invitación?

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