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 recupera eventos del registro de auditoría sin tener que completar estas tareas manualmente en Canva.

• Disponible para Canva Empresas, Canva Distritos y Canva Universidades.
• Accesible 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:

• Nivel de organización: La API de administración tiene alcance organizacional. Está disponible para organizaciones con uno o varios equipos que tengan planes de 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.
• Personal de ingeniería interno o externo: Tu organización necesita contar con recursos de ingeniería para crear 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 de SCIM es una mejor opción 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 comprender bien cómo están organizados tu organización, tus equipos y tus grupos en Canva.
• Autenticación multifactor (MFA) o cuenta administrada mediante inicio de sesión único (SSO): El admin de la organización que configure la API de administración debe tener MFA habilitada o una cuenta administrada mediante SSO. La organización a la que representa 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: recuperar 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 las invitaciones pendientes, recuperar un enlace de invitación existente mediante la dirección de correo electrónico exacta y cancelar invitaciones.

Un admin de la organización crea un cliente de la API de administración y lo usa para hacer solicitudes a la API.

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

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

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 a cargo que lo 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 al admin de la organización que creó, actualizó o eliminó un cliente de API específico.

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 a tu organización.

Ten en cuenta lo siguiente

• 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 para 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 invitada, al crear una nueva se devuelve el mismo registro de invitación, se restablece el vencimiento a 30 días a partir de 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 Canva Admin API.

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 el aprovisionamiento y 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 mejor opción para 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 debe contar con 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 desarrollar una integración con una API, el aprovisionamiento de SCIM es una mejor opción para automatizar la gestión de usuarios de tu organización.

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

No. Solo el admin de la organización que configure la API de administración debe tener MFA habilitada o una cuenta administrada mediante SSO. La organización a la que representa debe administrar o ser propietaria de la cuenta. Las demás personas de la organización no necesitan 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 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 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.