Guía para desarrolladores de la API de CalDAV

CalDAV es una extensión de WebDAV que proporciona un estándar para que los clientes accedan a la información del calendario en un servidor remoto.

Google proporciona una interfaz de CalDAV que puedes usar para ver y administrar calendarios con el protocolo CalDAV.

Especificaciones

Para cada una de las especificaciones relevantes, la compatibilidad de CalDAV de Google es la siguiente:

• rfc4918: Extensiones de HTTP para la autoría y el control de versiones distribuidos en la Web (WebDAV)
  • Admite los métodos HTTP GET, PUT, HEAD, DELETE, POST, OPTIONS, PROPFIND y PROPPATCH.
  • No admite los métodos HTTP LOCK, UNLOCK, COPY, MOVE ni MKCOL, ni el encabezado If* (excepto If-Match).
  • No admite propiedades WebDAV arbitrarias (definidas por el usuario).
  • No es compatible con el control de acceso de WebDAV (rfc3744).
• rfc4791: Extensiones de calendario para WebDAV (CalDAV)
  • Admite el método HTTP REPORT. Se implementaron todos los informes, excepto la consulta de disponibilidad.
  • No admite el método HTTP MKCALENDAR.
  • No admite la acción AUDIO.
• rfc5545: iCalendar
  • Los datos expuestos en la interfaz de CalDAV tienen el formato según la especificación de iCalendar.
  • Actualmente, no admite datos de VTODO ni VJOURNAL.
  • No admite la extensión de Apple iCal® para permitir propiedades de URL que el usuario pueda configurar.
• rfc6578: Sincronización de colecciones para WebDAV
  • Las aplicaciones cliente deben cambiar a este modo de operación después de la sincronización inicial.
• rfc6638: Scheduling Extensions to CalDAV
  • Admite una "bandeja de entrada" trivial, que siempre está vacía.
  • Las invitaciones que recibes se envían automáticamente a la colección de "eventos" en lugar de a la "bandeja de entrada".
  • No admite la búsqueda de disponibilidad.
• caldav-ctag-02: Etiqueta de entidad de colección de calendario (CTag) en CalDAV
  • El calendario ctag es como un recurso etag; cambia cuando cambia cualquier elemento del calendario. Esto permite que la aplicación cliente determine rápidamente que no necesita sincronizar ningún evento modificado.
• calendar-proxy: Función de proxy de usuario de Calendario en CalDAV
  • Para mejorar el rendimiento de la sincronización de calendarios desde dispositivos iOS, que no admiten la delegación, no se debe usar las propiedades calendar-proxy-read-for o calendar-proxy-write-for con un usuario-agente de iOS.

Aún no proporcionamos una implementación completa de todas las especificaciones relevantes. Sin embargo, para muchos clientes, como la app de Calendario de Apple, el protocolo CalDAV debería interoperar correctamente.

Nota: Para la seguridad de la cuenta y para evitar abusos, es posible que Google establezca cookies en las aplicaciones cliente que acceden a los datos a través de CalDAV.

Crea tu ID de cliente

Para usar la API de CalDAV, debes tener una Cuenta de Google. Si ya tienes una cuenta que puedes usar, no tienes que hacer nada más.

Para poder enviar solicitudes a la API de CalDAV, debes registrar tu cliente con la Consola de API de Google. Para ello, crea un proyecto.

Ve a la Consola de API de Google. Haz clic en Crear proyecto, ingresa un nombre y haz clic en Crear.

El siguiente paso es activar la API de CalDAV.

Si deseas habilitar una API para tu proyecto, haz lo siguiente:

1. Abre la Biblioteca de APIs en la Consola de APIs de Google. Si se te solicita, selecciona un proyecto o crea uno nuevo. La Biblioteca de API muestra todas las APIs disponibles, agrupadas por familia de productos y popularidad.
2. Si la API que quieres habilitar no está en la lista, usa la búsqueda para encontrarla.
3. Selecciona la API que deseas habilitar y, luego, haz clic en el botón Habilitar.
4. Si se te solicita, habilita la facturación.
5. Si se te solicita, acepta las Condiciones del Servicio de la API.

Para realizar solicitudes a la API de CalDAV, necesitarás un ID de cliente y un secreto de cliente.

Para encontrar el ID de cliente y el secreto de cliente de tu proyecto, haz lo siguiente:

1. Selecciona una credencial de OAuth 2.0 existente o abre la página Credenciales.
2. Si aún no lo hiciste, crea las credenciales de OAuth 2.0 de tu proyecto. Para ello, haz clic en Crear credenciales > ID de cliente de OAuth y proporciona la información necesaria para crearlas.
3. Busca el ID de cliente en la sección IDs de cliente de OAuth 2.0. Para obtener más información, haz clic en el ID de cliente.

Cómo conectarse al servidor CalDAV de Google

Para usar la interfaz de CalDAV, un programa cliente se conecta inicialmente con el servidor de calendario en uno de los dos puntos de partida. En cualquier caso, la conexión debe realizarse a través de HTTPS y debe usar el esquema de autenticación de OAuth 2.0. El servidor CalDAV se negará a autenticar una solicitud a menos que llegue a través de HTTPS con la autenticación de OAuth 2.0 de una Cuenta de Google. Si intentas conectarte a través de HTTP o con la autenticación básica, se muestra un código de estado HTTP 401 Unauthorized.

Si el programa cliente (como la app de Calendario de Apple) requiere una recopilación principal como punto de partida, el URI al que se debe conectar es el siguiente:

https://apidata.googleusercontent.com/caldav/v2/calid/user

En el que calid se debe reemplazar por el "ID de calendario" del calendario al que se accederá. Puedes encontrar esta opción en la interfaz web del Calendario de Google de la siguiente manera: en el menú desplegable junto al nombre del calendario, selecciona Configuración del calendario. En la página resultante, el ID del calendario se muestra en una sección etiquetada como Calendar Address. El ID del calendario principal de un usuario es el mismo que su dirección de correo electrónico.

Si un programa cliente (como Mozilla Sunbird) requiere una colección de calendarios como punto de partida, el URI al que se debe conectar es el siguiente:

https://apidata.googleusercontent.com/caldav/v2/calid/events

El extremo anterior https://www.google.com/calendar/dav dejó de estar disponible y ya no es compatible. Úsalo bajo tu propio riesgo. Te recomendamos que realices la transición al nuevo formato de extremo que se describió anteriormente.

iCal® es una marca de Apple Inc.