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 realizar 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:

• Alcance de la organización: La API de administración funciona a nivel de la 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 contratada: 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 de SCIM es una mejor opción para automatizar la gestión de usuarios en tu organización.
• Conocimiento de la estructura de Canva: Antes de crear la integración, asegúrate de entender claramente 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 cuenta debe estar administrada o ser propiedad de la organización en cuyo nombre actúa.

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 de forma programada.
• Invitaciones a equipos: invitar personas a un equipo (incluidas personas ajenas a tu organización), ver las invitaciones pendientes, recuperar un enlace de invitación existente mediante el correo electrónico exacto y cancelar invitaciones.

Un admin 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 enviar solicitudes a la API.

Para obtener información técnica sobre cómo autenticar solicitudes a la API y usar tokens de acceso 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 a través de la API de administración se registran a nombre del cliente de la API de administración, no del admin 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, incluidas personas colaboradoras externas a tu organización.

Ten en cuenta lo siguiente

• Cada invitación que crees corresponde a un equipo y una dirección de correo electrónico.
• Puedes usar cada invitación 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 hace falta, 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 esa persona, 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 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 la organización en 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 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 necesita recursos de ingeniería internos o contratados 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 de 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 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 cuenta debe estar administrada o ser propiedad de la organización en cuyo nombre actúa. 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 personas colaboradoras externas 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, 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 recuperar el enlace de una invitación existente sin crear una nueva?

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