Referensi Graph API

Ringkasan

Graph API untuk Workplace adalah cara terprogram untuk memasukkan dan mengeluarkan data dari Workplace. Ini adalah API berbasis HTTP tingkat rendah yang dapat Anda gunakan untuk mengueri data tentang objek dalam grafik Workplace.

Nama Graph API diambil dari ide model data grafik, di mana objek diwakili oleh node dan dihubungkan melalui edge. Pada level API, inilah cara aplikasi mengakses informasi di Workplace. Graph API untuk Workplace memungkinkan penggunaan subset fungsi dari Graph API untuk Facebook. Fungsi ini terbatas pada interaksi dengan komunitas Workplace dan mungkin berbeda dalam beberapa kasus demi performa atau kegunaan yang lebih baik.

Objek Workplace Graph API

Node berikut dapat diakses melalui Workplace Graph API dengan menggunakan integrasi khusus atau token akses aplikasi pihak ketiga.

Komunitas

Komunitas Workplace. Grup root untuk panggilan Workplace Graph API Anda.

Grup

Grup Workplace.

Postingan

Postingan yang dibuat di grup atau di profil anggota.

Anggota

Akun untuk pengguna Workplace tertentu. Node ini juga digunakan untuk melihat dan mengedit pesan yang diterima dan dikirim oleh pengguna ini.

Keterampilan

Keterampilan ditambahkan ke profil anggota.

Acara

Acara Komunitas atau Grup Workplace.

Kategori

Kategori di Galeri Pengetahuan untuk menyimpan konten penting perusahaan.

Set Orang

Kumpulan orang yang ditentukan menggunakan kriteria atau daftar.

Konten Dilaporkan

Konten di Workplace yang telah dilaporkan untuk ditinjau oleh admin.

Sif

Data jadwal sif untuk pekerja dengan bayaran per jam di Workplace.

Survei

Survei yang telah dibuat di Workplace.

Ekspor Data

Pekerjaan ekspor data untuk ekspor data massal dari Workplace.

Untuk melihat contoh penggabungan panggilan Graph API untuk menyelesaikan isu tertentu, lihat daftar Contoh Aplikasi.

Menggunakan Graph API

Objek Graph API

Graph API adalah representasi informasi di Workplace, yang terdiri dari:

• Node - objek seperti Pengguna, Foto, Postingan, Komentar
• Edge - hubungan antara "hal-hal" tersebut, seperti file Postingan, atau Komentar Foto
• Kolom - metadata tentang objek, seperti nama orang atau privasi Grup

Setiap item di grafik Workplace diwakili oleh id unik. Grup, Anggota, Postingan dan bahkan Komentar memiliki id sendiri, dan id ini dapat digunakan untuk mengambil informasi tentang hal-hal tersebut dari Graph API.

Mengelola Komunitas Anda

Setiap komunitas Workplace dipisahkan dari komunitas lainnya, sehingga Anda hanya dapat menggunakan Graph API untuk mengakses konten di dalam komunitas Anda sendiri, dan di grup multi-perusahaan tempat anggota komunitas Anda telah ditambahkan.

Untuk keperluan akses Graph API, Komunitas Anda diperlakukan sebagai Grup. Anda dapat menganggap komunitas Anda sebagai grup root, tempat semua grup Anda ditambahkan sebagai grup anak. Untuk mengambil informasi tentang komunitas Anda di Graph API, Anda memerlukan ID Komunitas, yang diambil secara terprogram dari Graph API, dengan membuat permintaan HTTP GET ke graph.facebook.com/community dengan token akses aplikasi yang valid.

Penetapan Versi Graph API

Graph API untuk Workplace dibuat di atas Graph API untuk platform Facebook. Artinya, Graph API tersebut mewarisi perilaku penetapan versi API yang sama dengan yang digunakan di Facebook.

Versi Graph API dirilis kira-kira setiap tiga bulan, dan perubahan di seluruh API Workplace serta Facebook dipublikasikan di Catatan Perubahan Graph API .

Saat melakukan panggilan API ke Graph API, Anda dapat menentukan versi di jalur API, sebagai berikut:

      https://graph.facebook.com/v2.11/community/groups
    

Namun, ada beberapa batasan pada versi yang tersedia:

• Ketika versi baru dirilis, versi tersebut menjadi versi API terkini, dan dijamin berfungsi selama dua tahun setelah perilisannya.
• Saat aplikasi dibuat, default aplikasi tersebut adalah versi API terkini pada saat pembuatan, dan versi ini menjadi versi API minimum yang tersedia untuk aplikasi tersebut.
• Aplikasi bebas untuk menentukan versi API apa pun saat melakukan panggilan API, tetapi tidak dapat melakukan panggilan ke versi API yang tidak digunakan lagi, atau ke versi di bawah versi API minimum aplikasi.
• Panggilan API tidak berversi akan default ke versi API minimum untuk aplikasi tersebut.

Ketika integrasi khusus yang baru dibuat, versi API minimum yang tersedia akan menjadi versi API terkini pada saat pembuatan. Versi minimum ini memengaruhi baik panggilan Graph API maupun langganan Webhook.

Memeriksa Versi Graph API

Jika Anda tidak yakin versi mana yang Anda gunakan, ada beberapa cara untuk memeriksanya. Untuk memeriksa versi Graph API mana yang dapat digunakan dengan aplikasi Anda, Anda dapat menambahkan parameter debug ke panggilan API Anda.

      https://graph.facebook.com/community?debug=all
    

Cara ini akan menampilkan informasi debug tambahan yang mengonfirmasi versi yang sedang digunakan.

      {
         "name": "Example Community",
         "privacy": "CLOSED",
         "id": "855210357923606",
         "__debug__": {
            "messages": [
               {
                  "link": "https://developers.facebook.com/docs/apps/versions/",
                  "message": "No API version was specified. This request defaulted to version v2.8.",
                  "type": "warning"
               }
            ]
         }
      }
    

Jika Anda mencoba menggunakan versi di bawah versi API minimum untuk aplikasi Anda, pesan debug akan memberi tahu Anda.

      https://graph.facebook.com/v2.6/community?debug=all
      
      {
         "name": "Example Community",
         "privacy": "CLOSED",
         "id": "855210357923606",
         "__debug__": {
            "messages": [
               {
                  "link": "https://developers.facebook.com/docs/apps/versions/",
                  "message": "The app tried to call version v2.6. This app can only call versions v2.8 and higher, so the request defaulted to version v2.8.",
                  "type": "warning"
               }
            ]
         }
      }
    

Memeriksa Versi Webhook

Langganan webhook menggunakan versi API minimum jika langganan dibuat melalui dialog pop-up Integrasi Khusus, atau versi API yang ditentukan adalah langganan yang dibuat melalui endpoint Graph API langganan, /app/subscriptions.

Anda dapat menggunakan endpoint langganan untuk mengonfirmasi versi webhook yang diterapkan untuk setiap kolom dan topik webhook. Endpoint ini memerlukan token akses aplikasi.

      https://graph.facebook.com/v2.11/app/subscriptions
      
      {
        "data": [
          {
            "object": "group",
            "callback_url": "https://www.example.com/callback",
            "active": true,
            "fields": [
              {
                "name": "comments",
                "version": "v2.8"
              },
      ...
    

Menggunakan Token Akses

Mendapatkan Token Akses Aplikasi

Untuk melakukan panggilan Graph API bagi komunitas Anda, Anda harus membuat aplikasi dan mengambil token akses. Tindakan ini melibatkan pembuatan integrasi khusus baru, lalu pemberian izin yang diperlukan untuk fungsi yang ingin Anda buat.

Untuk mempelajari pembuatan aplikasi dan model izin selengkapnya, lihat Panduan izin.

Mendapatkan Token Akses Anggota

Meskipun token akses aplikasi memungkinkan aplikasi untuk mengakses dan berinteraksi dengan objek di seluruh komunitas, token akses anggota memungkinkan layanan untuk melakukan panggilan atas nama akun tertentu.

Anda dapat mengambil token akses anggota dengan membuat permintaan GET ke endpoint /member_id untuk anggota tertentu, dengan menggunakan token akses admin dan meminta kolom tambahan impersonate_token.

Fungsi ini memerlukan izin Menyamar untuk aplikasi yang melakukan panggilan.