CalDAV é uma extensão do WebDAV que fornece um padrão para os clientes acessarem as informações da agenda em um servidor remoto.
O Google fornece uma interface CalDAV que você pode usar para visualizar e gerenciar agendas usando o protocolo CalDAV.
Especificações
Para cada uma das especificações relevantes, o suporte ao CalDAV do Google é o seguinte:
- rfc4918: extensões HTTP para criação e controle de versões distribuídos na Web (WebDAV, na sigla em inglês)
- Oferece suporte aos métodos HTTP
GET
,PUT
,HEAD
,DELETE
,POST
,OPTIONS
,PROPFIND
ePROPPATCH
. - Não é compatível com os métodos HTTP
LOCK
,UNLOCK
,COPY
,MOVE
ouMKCOL
, ou com o cabeçalhoIf*
(exceto porIf-Match
). - Não oferece suporte a propriedades WebDAV arbitrárias (definidas pelo usuário).
- Não oferece suporte ao controle de acesso WebDAV (rfc3744).
- Oferece suporte aos métodos HTTP
- rfc4791: extensões de agenda para WebDAV (CalDAV)
- Oferece suporte ao método HTTP
REPORT
. Todos os relatórios, exceto a consulta de disponível/ocupado, são implementados. - Não oferece suporte ao método HTTP
MKCALENDAR
. - Não oferece suporte à ação
AUDIO
.
- Oferece suporte ao método HTTP
- rfc5545: iCalendar
- Os dados expostos na interface CalDAV são formatados de acordo com a especificação do iCalendar.
- No momento, não oferece suporte a dados
VTODO
ouVJOURNAL
. - Não é compatível com a 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 alternar para esse modo de operação após a sincronização inicial.
- rfc6638: programação de extensões para CalDAV
- Oferece suporte a uma "caixa de entrada" trivial, que está sempre vazia.
- Os convites recebidos são automaticamente enviados à coleção "eventos", em vez de na "caixa de entrada".
- Não oferece suporte à pesquisa de disponibilidade.
- caldav-ctag-02: Tag de entidade da coleção da agenda (CTag) no CalDAV
- A agenda
ctag
é como um recursoetag
. Ela muda sempre que algo na agenda muda. Isso permite que o aplicativo cliente determine rapidamente que não precisa sincronizar nenhum evento alterado.
- A agenda
- calendar-proxy: funcionalidade de proxy do usuário do Agenda no CalDAV
- Para melhorar o desempenho da sincronização de agendas de dispositivos iOS, que não são compatíveis com delegação, o uso das propriedades
calendar-proxy-read-for
oucalendar-proxy-write-for
com um UserAgent iOS falhará.
- Para melhorar o desempenho da sincronização de agendas de dispositivos iOS, que não são compatíveis com delegação, o uso das propriedades
Ainda não fornecemos uma implementação completa de todas as especificações relevantes. No entanto, para muitos clientes, como o app Agenda da Apple, o protocolo CalDAV funciona corretamente.
Observação: para a segurança da conta e para evitar abusos, o Google pode definir cookies em aplicativos clientes que acessam dados via CalDAV.
Como criar seu ID de cliente
Para usar a API CalDAV, você precisa ter uma Conta do Google. Se você já tem uma conta que pode usar, então está tudo pronto.
Antes de enviar solicitações para a API CalDAV, é preciso criar um projeto para registrar seu cliente no Console de APIs do Google.
Vá para o Console de APIs do Google. Clique em Criar projeto, digite um nome e clique em Criar.
A próxima etapa é ativar a API CalDAV.Para ativar uma API no seu projeto, siga estas etapas:
- Abra a Biblioteca de APIs no Console de APIs do Google. Se solicitado, 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.
- Se a API que você quer ativar não estiver visível na lista, use a pesquisa para encontrá-la.
- Selecione a API que você quer ativar e clique no botão Ativar.
- Se necessário, ative o faturamento.
- Se solicitado, aceite os Termos de Serviço da API.
Para localizar o ID do cliente e a chave secreta do cliente do projeto, faça o seguinte:
- Selecione uma credencial OAuth 2.0 atual ou abra a página Credenciais.
- Se você ainda não tiver feito isso, crie as credenciais do OAuth 2.0 do seu projeto clicando em Criar credenciais > ID do cliente OAuth e forneça as informações necessárias para criar as credenciais.
- 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 da agenda 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 se recusará a autenticar uma solicitação, a menos que chegue por HTTPS com a autenticação OAuth 2.0 de uma Conta do Google.
A tentativa de se conectar por HTTP ou usar a autenticação básica resulta em um código de status HTTP 401 Unauthorized
.
Se o programa cliente (como o app Agenda da Apple) exigir uma coleção principal como ponto de partida, o URI a ser conectado será:
https://apidata.googleusercontent.com/caldav/v2/calid/user
Em que calid
deve ser substituído pelo
"ID 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 é igual ao
endereço de e-mail dele.
Se um programa cliente (como o Mozilla Sunbird) exigir uma coleção de agenda 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 recebe 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.