Guia para desenvolvedores da API CalDAV

O CalDAV é uma extensão do WebDAV que fornece um padrão para que os clientes acessem informações da agenda em um servidor remoto.

O Google oferece uma interface CalDAV que pode ser usada para conferir e gerenciar agendas usando o protocolo CalDAV.

Especificações

Para cada uma das especificações relevantes, o suporte do Google para CalDAV é o seguinte:

  • rfc4918: Extensões HTTP para criação e controle de versões distribuídos na Web (WebDAV)
    • Oferece suporte aos métodos HTTP GET, PUT, HEAD, DELETE, POST, OPTIONS, PROPFIND e PROPPATCH.
    • Não oferece suporte aos métodos HTTP LOCK, UNLOCK, COPY, MOVE ou MKCOL, nem ao cabeçalho If* (exceto If-Match).
    • Não oferece suporte a propriedades arbitrárias (definidas pelo usuário) do WebDAV.
    • Não oferece suporte ao controle de acesso do WebDAV (rfc3744).
  • rfc4791: extensões de agendamento para WebDAV (CalDAV)
    • Oferece suporte ao método HTTP REPORT. Todos os relatórios, exceto a consulta de disponibilidade, são implementados.
    • Não oferece suporte ao método HTTP MKCALENDAR.
    • Não oferece suporte à ação AUDIO.
  • rfc5545: iCalendar
    • Os dados expostos na interface do CalDAV são formatados de acordo com a especificação do iCalendar.
    • No momento, não é compatível com dados VTODO ou VJOURNAL.
    • Não oferece suporte à extensão Apple iCal® para permitir propriedades de URL configuráveis pelo usuário.
  • rfc6578: sincronização de coleções para WebDAV
    • Os aplicativos clientes precisam mudar para esse modo de operação após a sincronização inicial.
  • rfc6638: Scheduling Extensions to CalDAV
    • Suporta uma "caixa de entrada" trivial, que está sempre vazia.
    • Os convites que você recebe são enviados automaticamente para a coleção "eventos" em vez de serem colocados na "caixa de entrada".
    • Não oferece suporte para pesquisa de disponibilidade.
  • caldav-ctag-02: tag de entidade de coleção de calendários (CTag) no CalDAV
    • A ctag do calendário é como um recurso etag. Ela muda quando algo no calendário muda. Isso permite que o aplicativo cliente determine rapidamente que não precisa sincronizar nenhum evento alterado.
  • calendar-proxy: funcionalidade de proxy do usuário da agenda no CalDAV
    • Para melhorar o desempenho da sincronização de calendário em dispositivos iOS, que não oferecem suporte à delegação, o uso das propriedades calendar-proxy-read-for ou calendar-proxy-write-for com um UserAgent do iOS vai falhar.

Ainda não implementamos todas as especificações relevantes. No entanto, para muitos clientes, como o app Agenda da Apple, o protocolo CalDAV precisa interagir corretamente.

Observação: para proteger a conta e evitar abusos, o Google pode definir cookies em aplicativos clientes que acessam dados por CalDAV.

Como criar seu ID do cliente

Para usar a API CalDAV, você precisa ter uma Conta do Google. Se você já tem uma conta que pode usar, está tudo pronto.

Antes de enviar solicitações à API CalDAV, você precisa criar um projeto e registrar seu cliente no Console de APIs do Google.

Vá para o Console de APIs do Google. Clique em Criar projeto, insira um nome e clique em Criar.

A próxima etapa é ativar a API CalDAV.

Para ativar uma API no seu projeto, siga estas etapas:

  1. Abra a biblioteca de APIs no Console de APIs do Google. Se necessário, selecione um projeto ou crie um novo. A biblioteca de APIs lista todas as APIs disponíveis, agrupadas por família de produtos e popularidade.
  2. Se a API que você quer ativar não estiver visível na lista, use a pesquisa para encontrá-la.
  3. Selecione a API que você quer ativar e clique no botão Ativar.
  4. Se necessário, ative o faturamento.
  5. Se necessário, aceite os Termos de Serviço da API.
Para realizar solicitações da API CalDAV, você vai precisar do ID do cliente e da chave secreta do cliente.

Para localizar o ID do cliente e a chave secreta do cliente do projeto, faça o seguinte:

  1. Selecione uma credencial OAuth 2.0 existente ou abra a página de credenciais.
  2. Se ainda não tiver feito isso, crie as credenciais OAuth 2.0 do seu projeto clicando em Criar credenciais > ID do cliente OAuth e fornecendo as informações necessárias.
  3. Procure o ID do cliente na seção IDs do cliente OAuth 2.0. Para mais detalhes, clique no ID do cliente.

Como se conectar ao servidor CalDAV do Google

Para usar a interface CalDAV, um programa cliente se conecta inicialmente ao servidor de calendário em um dos dois pontos de partida. Em ambos os casos, a conexão precisa ser feita por HTTPS e usar o esquema de autenticação OAuth 2.0. O servidor CalDAV vai recusar a autenticação de uma solicitação, a menos que ela chegue por HTTPS com autenticação OAuth 2.0 de uma conta do Google. A tentativa de conexão por HTTP ou o uso da autenticação básica resulta em um código de status 401 Unauthorized HTTP.

Se o programa cliente (como o app de calendário da Apple) exigir uma coleção principal como ponto de partida, o URI para conexão será:

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

Em que calid precisa ser substituído pelo "ID da agenda" da agenda a ser acessada. Ela pode ser encontrada na interface da Web do Google Agenda da seguinte maneira: no menu suspenso ao lado do nome da agenda, selecione Configurações da agenda. Na página resultante, o ID da agenda é mostrado em uma seção chamada Endereço da agenda. O ID da agenda principal de um usuário é o mesmo que o endereço de e-mail dele.

Se um programa cliente (como o Mozilla Sunbird) exigir uma coleção de calendários como ponto de partida, o URI a ser conectado será:

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

O endpoint antigo https://www.google.com/calendar/dav foi descontinuado e não tem mais suporte. Use-o por sua conta e risco. Recomendamos que você faça a transição para o novo formato de endpoint descrito acima.

iCal® é uma marca registrada da Apple Inc.