CalDAV API Developer's Guide

CalDAV è un'estensione di WebDAV che fornisce uno standard per i client per l'accesso alle informazioni del calendario su un server remoto.

Google offre un'interfaccia CalDAV che puoi utilizzare per visualizzare e gestire i calendari utilizzando il protocollo CalDAV.

Specifiche

Per ciascuna delle specifiche pertinenti, il supporto CalDAV di Google è il seguente:

  • RFC4918: Estensioni HTTP per Web Distributed Authoring and Versioning (WebDAV)
    • Supporta i metodi HTTP GET, PUT, HEAD, DELETE, POST, OPTIONS, PROPFIND e PROPPATCH.
    • Non supporta i metodi HTTP LOCK, UNLOCK, COPY, MOVE o MKCOL o l'intestazione If* (tranne If-Match).
    • Non supporta proprietà WebDAV arbitrarie (definite dall'utente).
    • Non supporta il controllo dell'accesso WebDAV (RFC3744).
  • RFC4791: Estensioni di calendario per WebDAV (CalDAV)
    • Supporta il metodo HTTP REPORT. Vengono implementati tutti i report, tranne la query sulla disponibilità.
    • Non supporta il metodo HTTP MKCALENDAR.
    • Non supporta l'azione AUDIO.
  • RFC5545: iCalendar
    • I dati esposti nell'interfaccia CalDAV sono formattati in base alla specifica iCalendar.
    • Attualmente non supporta i dati di VTODO o VJOURNAL.
    • Non supporta l'estensione iCal® di Apple per consentire le proprietà URL impostabili dall'utente.
  • RFC6578: Sincronizzazione delle raccolte per WebDAV
    • Le applicazioni client devono passare a questa modalità di funzionamento dopo la sincronizzazione iniziale.
  • RFC6638: Programmazione delle estensioni in CalDAV
    • Supporta una "Posta in arrivo" banale, sempre vuota.
    • Gli inviti che ricevi vengono inviati automaticamente alla tua raccolta "Eventi" e non nella tua "Posta in arrivo".
    • Non supporta la ricerca disponibile/occupato.
  • caldav-ctag-02: Tag entità raccolta calendario (CTag) in CalDAV
    • Il calendario ctag è come una risorsa etag e cambia quando qualcosa nel calendario viene modificato. Ciò consente all'applicazione client di determinare rapidamente che non è necessario sincronizzare gli eventi modificati.
  • calendar-proxy: funzionalità proxy utente di Calendar in CalDAV
    • Per migliorare le prestazioni della sincronizzazione del calendario dai dispositivi iOS, che non supportano la delega, l'utilizzo delle proprietà calendar-proxy-read-for o calendar-proxy-write-for con uno user agent iOS non riuscirà.

Non abbiamo ancora fornito un'implementazione completa di tutte le specifiche pertinenti. Tuttavia, per molti client, ad esempio Apple iCal, il protocollo CalDAV dovrebbe interoperare correttamente.

Nota: per la sicurezza dell'account e per prevenire comportamenti illeciti, Google potrebbe impostare cookie nelle applicazioni client che accedono ai dati tramite CalDAV.

Creazione dell'ID client

Per utilizzare l'API CalDAV devi avere un Account Google. Se hai già un account che puoi utilizzare, non devi fare altro.

Prima di poter inviare richieste all'API CalDAV, devi registrare il tuo client nella console API di Google creando un progetto.

Vai alla console dell'API di Google. Fai clic su Crea progetto, inserisci un nome e fai clic su Crea.

Il passaggio successivo consiste nell'attivare l'API CalDAV.

Per abilitare un'API per il tuo progetto:

  1. Apri la libreria API nella console API di Google. Se richiesto, seleziona un progetto o creane uno nuovo. La libreria API elenca tutte le API disponibili, raggruppate per famiglia di prodotti e popolarità.
  2. Se l'API che vuoi abilitare non è visibile nell'elenco, utilizza la funzione di ricerca per trovarla.
  3. Seleziona l'API che vuoi abilitare, quindi fai clic sul pulsante Abilita.
  4. Se richiesto, abilita la fatturazione.
  5. Se richiesto, accetta i Termini di servizio dell'API.
Per eseguire le richieste API CalDAV, avrai bisogno di ID client e client secret.

Per trovare l'ID client e il client secret del progetto:

  1. Seleziona una credenziale OAuth 2.0 esistente o apri la pagina Credenziali.
  2. Se non l'hai ancora fatto, crea le credenziali OAuth 2.0 del tuo progetto facendo clic su Crea credenziali > ID client OAuth e fornendo le informazioni necessarie per creare le credenziali.
  3. Cerca l'ID client nella sezione ID client OAuth 2.0. Per maggiori dettagli, fai clic sull'ID client.

Connessione al server CalDAV di Google

Per utilizzare l'interfaccia CalDAV, un programma client si connette inizialmente con il server di calendario da uno dei due punti di partenza. In entrambi i casi, la connessione deve essere effettuata tramite HTTPS e utilizzare lo schema di autenticazione OAuth 2.0. Il server CalDAV rifiuta di autenticare una richiesta, a meno che non arriva tramite HTTPS con autenticazione OAuth 2.0 di un Account Google. Il tentativo di connessione tramite HTTP o l'utilizzo dell'autenticazione di base genera un codice di stato HTTP 401 Unauthorized.

Se il programma client (ad esempio iCal di Apple) richiede una raccolta di entità come punto di partenza, l'URI a cui connettersi è:

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

Dove calid deve essere sostituito dall'"ID calendario" del calendario a cui si accede. Puoi trovarlo nell'interfaccia web di Google Calendar nel seguente modo: nel menu a discesa accanto al nome del calendario, seleziona Impostazioni calendario. Nella pagina visualizzata, l'ID calendario viene visualizzato in una sezione con l'etichetta Calendar Address. L'ID calendario del calendario principale di un utente corrisponde all'indirizzo email dell'utente.

Se un programma client (come Mozilla Sunbird) richiede una raccolta del calendario come punto di partenza, l'URI a cui connettersi è:

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

Il vecchio endpoint https://www.google.com/calendar/dav è deprecato e non è più supportato; utilizzalo a tuo rischio. Ti consigliamo di passare al nuovo formato degli endpoint descritto in precedenza.

iCal è un marchio di Apple Inc.