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

• Disponible para Canva Empresas, Canva Distritos y Canva Universidades.
• Disponible para quienes administran la organización.
• Disponible para organizaciones con un solo equipo o con varios equipos.

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

• Ámbito de la organización: La API de administración funciona a nivel de organización. Está disponible para organizaciones con uno o varios equipos en los planes Canva Empresas, Canva Distritos y Canva Universidades.
• Cuenta de admin de la organización: Solo quienes administran la organización pueden crear y administrar clientes de la API de administración en la configuración de Canva.
• Equipo de ingeniería interno o externo: 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 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 cómo están organizados tu organización, equipos y grupos en Canva.
• Autenticación multifactor (MFA) o cuenta administrada con 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 con SSO. La cuenta debe ser administrada o pertenecer a 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: consultar eventos del registro de auditoría de forma periódica.
• Invitaciones a equipos: invitar personas a un equipo (incluso a quienes no pertenecen a tu organización), consultar invitaciones pendientes, recuperar un enlace de invitación existente con 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 enviar solicitudes a la API.

Para conocer los detalles técnicos 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 de autenticación de la API de administración de Canva.

Las acciones realizadas mediante la API de administración se registran a nombre del cliente de la API, 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 a la persona a cargo 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.

Quienes administran la organización pueden usar la API de administración para invitar personas a un equipo, incluidas las colaboradoras externas que no pertenecen 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 hace falta, comparte directamente con ella el enlace de invitación.
• 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 hay una invitación pendiente para la persona invitada, al crear una nueva se devuelve el mismo registro de invitación, se restablece su vencimiento a 30 días a partir de la solicitud y se actualiza su rol al 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 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 desarrollar una integración de API personalizada, SCIM es una mejor opción para tus necesidades.

¿Mi organización necesita 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 internos o externos que desarrollen y mantengan 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 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 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 con SSO. La cuenta debe ser administrada o pertenecer a 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 colaboradores externos mediante la API de administración?

Sí. Quienes administran la organización pueden usar la API de administración para invitar 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 recuperar un enlace de invitación existente sin crear una nueva invitación?

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