La API de Calendly conecta tus sistemas de software con nuestra plataforma de programación. Puedes automatizar tareas, sincronizar datos y mejorar la programación.
Esta guía cubre los aspectos básicos para ayudarte a comenzar. Consulta el Portal de Desarrolladores y la Comunidad de Desarrolladores para obtener ayuda avanzada.
Cómo funciona la API de Calendly
Solicitud de API
Todos los usuarios de Calendly pueden enviar una solicitud para obtener información o completar una tarea utilizando nuestra API. Incluirás qué tipo de datos o acción necesitas en la solicitud.
Cada solicitud está asegurada con un token de acceso personal (PAT), que permite a la API saber qué puedes hacer. Nuestras páginas de referencia en el portal explican cómo dar formato a tu solicitud e incluyen todos los detalles que necesitas.
Procesamiento de API
Cuando se envía una solicitud, nuestros servidores recopilan datos, procesan cálculos o completan tareas según tus entradas. Luego, el servidor envía una respuesta que coincide con tu solicitud.
Ejemplo de solicitud:
Respuesta
Una vez que se procesa tu solicitud, se te envía una respuesta. Incluirá los datos que solicitaste o confirmará que se completó la acción. Todas las respuestas siguen formatos de API estándar.
Ejemplo de respuesta:
Gestión de errores
Si se produce un error, se maneja con mensajes y códigos preestablecidos. Estos te ayudan a resolver problemas o cuando necesitas ayuda del equipo de Calendly.
Ejemplo de error:
Webhooks
Disponible en los planes Professional, Standard, Teams y Enterprise
Los webhooks proporcionan actualizaciones en tiempo real en tus sistemas cuando se producen eventos en Calendly. Una vez configurada, Calendly te notificará al instante si se ha programado, reprogramado o cancelado una reunión. Esto te permite automatizar tareas o desencadenar acciones en función de estas actualizaciones. Para obtener más detalles, revisa nuestro artículo sobre webhooks.
Acceso API por plan de suscripción
Los desarrolladores pueden realizar solicitudes GET y POST en puntos finales de API en nombre de un usuario de Calendly en cualquier plan de suscripción, incluido el plan Básico.
Sin embargo, ciertos endpoints solo están disponibles en el plan Enterprise:
- Listar registros de entrada de actividad
- Eliminar los datos de los invitados
- Eliminar datos de eventos programados
Para los webhooks, el usuario de Calendly debe tener una suscripción pagada en el plan Professional, Standard, Teams o Enterprise. Explora las funciones de cada plan en nuestra página de precios.
Usuario vs. ámbitos de administrador o propietario
Al generar tokens para autenticar la API de Calendly, el nivel de acceso depende del rol del usuario. El alcance de los datos disponibles depende de si el token es generado por un usuario o un administrador o propietario:
- Rol de usuario: si un usuario genera un token, este solo permite el acceso a los datos vinculados a ese usuario específico. Esto incluye webhooks que se activan para eventos, como reuniones programadas o canceladas relacionadas con el usuario individual.
- Rol de administrador o propietario: los tokens generados por un administrador o propietario proporcionan un acceso más amplio. Estos tokens permiten que las llamadas a la API administren datos en toda la organización o dentro de grupos.
Crear un token de acceso personal
Verifica que estás generando el token desde la cuenta correcta (usuario o administrador o propietario) para establecer el ámbito de acceso adecuado.
- Visita la página de integraciones y selecciona API y webhooks.
- Selecciona Obtener un token ahora.
- En Elige un nombre para este token, añade un nombre.
- Selecciona Crear token.
- Se te pedirá que introduzcas un código de autenticación. Consulta el código en el email e introdúcelo para completar la verificación.
- Una vez que se haya generado el token de acceso personal, selecciona Copiar token.
Después de generar tu token de acceso personal, consulte nuestra guía sobre funciones de API y creación de integraciones en nuestra Guía de introducción en el Portal para desarrolladores.
Nota
Mantén tus tokens de acceso personal privados y seguros, como lo harías con una contraseña.
Seguridad y cumplimiento normativo
La seguridad de su integración es nuestra principal prioridad. Nuestra API cumple las mejores prácticas de seguridad y conformidad con el tratamiento de datos, lo que garantiza que tu información se mantenga segura. Para obtener más detalles, consulta nuestro artículo Seguridad y cumplimiento de la plataforma de Calendly.
A través de la API, puedes gestionar los usuarios de la organización de las siguientes maneras:
- Invitar a usuarios a unirse a tu organización
- Revocar invitaciones
- Eliminar usuarios de tu organización
También puedes integrar tu aplicación mediante OAuth 2.0 para una autorización segura.