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 mediante el protocolo CalDAV.

Especificaciones

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

• rfc4918: Extensiones HTTP para la creación y el control de versiones web distribuido (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 es compatible con el control de acceso WebDAV (rfc3744).
• rfc4791: Extensiones de calendario para WebDAV (CalDAV)
  • Admite el método HTTP REPORT. Se implementan todos los informes, excepto la consulta de disponibilidad.
  • No es compatible con el método HTTP MKCALENDAR.
  • No admite la acción AUDIO.
• rfc5545: iCalendario
  • Los datos expuestos en la interfaz de CalDAV reciben el formato de acuerdo con la especificación de iCalendario.
  • Actualmente, no es compatible con datos de VTODO ni de VJOURNAL.
  • No es compatible con la extensión 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 funcionamiento después de la sincronización inicial.
• rfc6638: Cómo programar extensiones para CalDAV
  • Admite una bandeja de entrada trivial, que siempre está vacía.
  • Las invitaciones que recibes se envían automáticamente a tu colección de “eventos” en lugar de colocarse en tu “bandeja de entrada”.
  • No admite la búsqueda de disponible-ocupado.
• caldav-ctag-02: Etiqueta de entidad de colección de calendario (CTag) en CalDAV
  • El calendario ctag es como un recurso etag; cambia cuando se modifica algo en el calendario. Esto permite que la aplicación cliente determine con rapidez que no necesita sincronizar ningún evento modificado.
• calendar-proxy: Funcionalidad del proxy de usuario del calendario en CalDAV
  • Para mejorar el rendimiento de la sincronización de calendarios desde dispositivos iOS, que no admiten la delegación, el uso de las propiedades calendar-proxy-read-for o calendar-proxy-write-for con un UserAgent de iOS fallará.

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 de forma correcta.

Nota: Para garantizar la seguridad de la cuenta y evitar abusos, Google podría configurar cookies en 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, no necesitas hacer nada más.

Antes de que puedas enviar solicitudes a la API de CalDAV, debes registrar tu cliente con la Consola de APIs de Google mediante la creación de 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 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 deseas habilitar y 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, 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 crear las credenciales.
3. Busca el ID de cliente en la sección ID de cliente de OAuth 2.0. Para obtener más información, haz clic en el ID de cliente.

Conéctate al servidor de CalDAV de Google

Para usar la interfaz de CalDAV, un programa cliente se conecta inicialmente con el servidor de calendario en uno de 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 OAuth 2.0. El servidor de CalDAV rechazará la solicitud, a menos que llegue a través de HTTPS con la autenticación OAuth 2.0 de una Cuenta de Google. Si intentas conectarte mediante 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 de Calendario de Apple) requiere una colección principal como punto de partida, el URI al que debes conectarte es el siguiente:

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

Donde calid debe reemplazarse por el "ID del calendario" del calendario al que se accederá. Puedes encontrarlo 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 Dirección del calendario. El ID del calendario 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 para conectarse es el siguiente:

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

El extremo anterior https://www.google.com/calendar/dav está obsoleto y ya no es compatible. Úsalo bajo tu responsabilidad. Te recomendamos realizar la transición al nuevo formato de extremo descrito anteriormente.

iCal® es una marca de Apple Inc.