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 pertinentes, la compatibilidad de CalDAV de Google es la siguiente:

• rfc4918: Extensiones HTTP para la creación y el control de versiones distribuidas 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 de WebDAV arbitrarias (definidas por el usuario).
  • No admite el control de acceso de WebDAV (rfc3744).
• rfc4791: Extensiones de calendario para WebDAV (CalDAV)
  • Admite el método HTTP REPORT. Se implementan todos los informes, excepto free-busy-query.
  • No admite el método HTTP MKCALENDAR.
  • No admite la acción AUDIO.
• rfc5545: iCalendar
  • Los datos expuestos en la interfaz de CalDAV se formatean según la especificación de iCalendar.
  • Actualmente, no admite datos VTODO ni VJOURNAL.
  • No admite la extensión iCal® de Apple para permitir propiedades de URL configurables por el usuario.
• 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: Extensiones de programación para CalDAV
  • Admite una "bandeja de entrada" trivial, que siempre está vacía.
  • Las invitaciones que recibes se entregan automáticamente en tu colección de "eventos" en lugar de colocarse en tu "bandeja de entrada".
  • No admite la búsqueda de disponibilidad.
• caldav-ctag-02: Etiqueta de entidad de colección de calendario (CTag) en CalDAV
  • La ctag del calendario es como una etag de recursos; cambia cuando cambia algo en el calendario. Esto permite que la aplicación cliente determine rápidamente que no necesita sincronizar ningún evento modificado.
• calendar-proxy: Funcionalidad de proxy de usuario de calendario en CalDAV
  • Para mejorar el rendimiento de la sincronización del calendario desde dispositivos iOS, que no admiten la delegación, no se podrán usar las propiedades calendar-proxy-read-for o calendar-proxy-write-for con un UserAgent de iOS.

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

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

Cómo crear tu ID de cliente

Para usar la API de CalDAV, debes tener una Cuenta de Google. Si ya tienes una cuenta que puedes usar, ya tienes todo listo.

Para poder enviar solicitudes a la API de CalDAV, debes registrar tu cliente en la Consola de APIs de Google creando un proyecto.

Ve a la Consola de APIs 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 APIs 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 quieres 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 el ID de cliente y el 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, haz clic en Crear credenciales > ID de cliente de OAuth y proporciona la información necesaria para crear las credenciales de OAuth 2.0 de tu proyecto.
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 rechazará la autenticación de 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 usar la autenticación básica, se generará un código de estado HTTP 401 Unauthorized.

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

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

En el que valid debe reemplazarse por el "ID de calendario" del calendario al que se accederá. Esto se puede encontrar a través de 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 Dirección del calendario. El ID del calendario principal de un usuario es el mismo que la dirección de correo electrónico de ese usuario.

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

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

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

iCal® es una marca registrada de Apple Inc.