Panduan Developer CalDAV API

CalDAV adalah ekstensi WebDAV yang menyediakan standar bagi klien untuk mengakses informasi kalender di server jarak jauh.

Google menyediakan antarmuka CalDAV yang dapat Anda gunakan untuk melihat dan mengelola kalender menggunakan protokol CalDAV.

Spesifikasi

Untuk setiap spesifikasi yang relevan, dukungan CalDAV Google adalah sebagai berikut:

• rfc4918: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)
  • Mendukung metode HTTP GET, PUT, HEAD, DELETE, POST, OPTIONS, PROPFIND, dan PROPPATCH.
  • Tidak mendukung metode HTTP LOCK, UNLOCK, COPY, MOVE, atau MKCOL, atau header If* (kecuali untuk If-Match).
  • Tidak mendukung properti WebDAV arbitrer (yang ditentukan pengguna).
  • Tidak mendukung Kontrol Akses WebDAV (rfc3744).
• rfc4791: Calendaring Extensions to WebDAV (CalDAV)
  • Mendukung metode HTTP REPORT. Semua laporan kecuali free-busy-query telah diterapkan.
  • Tidak mendukung metode HTTP MKCALENDAR.
  • Tidak mendukung tindakan AUDIO.
• rfc5545: iCalendar
  • Data yang diekspos di antarmuka CalDAV diformat sesuai dengan spesifikasi iCalendar.
  • Saat ini tidak mendukung data VTODO atau VJOURNAL.
  • Tidak mendukung ekstensi Apple iCal® untuk mengizinkan properti URL yang dapat ditetapkan pengguna.
• rfc6578: Collection Synchronization for WebDAV
  • Aplikasi klien harus beralih ke mode operasi ini setelah sinkronisasi awal.
• rfc6638: Scheduling Extensions to CalDAV
  • Mendukung "kotak masuk" sepele, yang selalu kosong.
  • Undangan yang Anda terima akan otomatis dikirim ke koleksi "acara" Anda, bukan ke "kotak masuk".
  • Tidak mendukung pencarian waktu luang/sibuk.
• caldav-ctag-02: Tag Entitas Kumpulan Kalender (CTag) di CalDAV
  • Kalender ctag seperti resource etag; kalender ini berubah saat ada perubahan pada kalender. Hal ini memungkinkan aplikasi klien menentukan dengan cepat bahwa aplikasi tidak perlu menyinkronkan peristiwa yang berubah.
• calendar-proxy: Fungsi Proxy Pengguna Kalender di CalDAV
  • Untuk meningkatkan performa sinkronisasi kalender dari perangkat iOS, yang tidak mendukung delegasi, penggunaan properti calendar-proxy-read-for atau calendar-proxy-write-for dengan UserAgent iOS akan gagal.

Kami belum menyediakan penerapan penuh semua spesifikasi yang relevan. Namun, untuk banyak klien seperti aplikasi Kalender Apple, protokol CalDAV harus beroperasi dengan benar.

Catatan: Untuk keamanan akun dan mencegah penyalahgunaan, Google mungkin menyetel cookie di aplikasi klien yang mengakses data melalui CalDAV.

Membuat client ID

Untuk menggunakan CalDAV API, Anda harus memiliki Akun Google. Jika sudah memiliki akun yang dapat digunakan, Anda sudah siap.

Sebelum dapat mengirim permintaan ke CalDAV API, Anda harus mendaftarkan klien Anda dengan Konsol Google API dengan membuat project.

Buka Konsol Google API. Klik Buat project, masukkan nama, lalu klik Buat.

Untuk mengaktifkan API untuk project Anda, lakukan hal berikut:

1. Buka API Library di Konsol API Google. Jika diminta, pilih project atau buat project baru. Library API menampilkan daftar semua API yang tersedia, yang dikelompokkan berdasarkan kelompok produk dan popularitas.
2. Jika API yang ingin Anda aktifkan tidak terlihat dalam daftar, gunakan penelusuran untuk mencarinya.
3. Pilih API yang ingin Anda aktifkan, lalu klik tombol Aktifkan.
4. Jika diminta, aktifkan penagihan.
5. Jika diminta, setujui Persyaratan Layanan API.

Untuk menemukan client ID dan rahasia klien project Anda, lakukan hal berikut:

1. Pilih kredensial OAuth 2.0 yang adaatau buka halaman Kredensial.
2. Jika belum, buat kredensial OAuth 2.0 proyek Anda dengan mengklik Buat kredensial > ID klien OAuth, dan berikan informasi yang diperlukan untuk membuat kredensial.
3. Cari Client ID di bagian OAuth 2.0 client IDs. Untuk mengetahui detailnya, klik ID klien.

Menghubungkan ke server CalDAV Google

Untuk menggunakan antarmuka CalDAV, program klien awalnya terhubung dengan server kalender di salah satu dari dua titik awal. Dalam kedua kasus tersebut, koneksi harus dilakukan melalui HTTPS dan harus menggunakan skema autentikasi OAuth 2.0. Server CalDAV akan menolak untuk mengautentikasi permintaan kecuali jika permintaan tersebut tiba melalui HTTPS dengan autentikasi OAuth 2.0 akun Google. Mencoba terhubung melalui HTTP atau menggunakan Autentikasi Dasar akan menghasilkan kode status HTTP 401 Unauthorized.

Jika program klien (seperti aplikasi Kalender Apple) memerlukan kumpulan utama sebagai titik awal, URI yang akan dihubungkan adalah:

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

Dengan calid harus diganti dengan "ID kalender" dari kalender yang akan diakses. Anda dapat menemukannya melalui antarmuka web Google Kalender sebagai berikut: di menu pull-down di samping nama kalender, pilih Setelan Kalender. Di halaman yang muncul, ID kalender ditampilkan di bagian berlabel Alamat Kalender. ID kalender untuk kalender utama pengguna sama dengan alamat email pengguna tersebut.

Jika program klien (seperti Mozilla Sunbird) memerlukan kumpulan kalender sebagai titik awal, URI untuk terhubung adalah:

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

Endpoint lama https://www.google.com/calendar/dav tidak digunakan lagi dan tidak didukung lagi; gunakan dengan risiko Anda sendiri. Sebaiknya Anda beralih ke format endpoint baru yang dijelaskan di atas.

iCal® adalah merek dagang Apple Inc.