Facebook oEmbed

Endpoint oEmbed Facebook mengizinkan Anda mendapatkan HTML sematan dan metadata dasar untuk halaman, kiriman, dan video untuk menampilkannya di situs web atau aplikasi lain.

Produk oEmbed telah digantikan dengan fitur Baca oEmbed baru. Jika Anda menerapkan produk oEmbed sebelum 8 Juni 2021, Anda memiliki waktu sampai 7 September 2021 untuk menyelesaikan Tinjauan Aplikasi untuk fitur Baca oEmbed. Jika Anda belum disetujui untuk fitur Baca oEmbed sampai 7 September 2021, penerapan oEmbed Anda akan gagal dimuat.

Penggunaan Umum

  • Me-render halaman, postingan, dan video Facebook dalam aplikasi berkirim pesan.
  • Menyematkan halaman, postingan, dan video Facebook di situs web dan blog.
  • Me-render halaman, postingan, dan video Facebook dalam sistem pengelolaan konten.

Endpoint

EndpointDeskripsi

GET /oembed_page

Dapatkan HTML sematan dan metadata dasar dari halaman Facebook.

GET /oembed_post

Dapatkan HTML sematan dan metadata dasar dari postingan Facebook.

GET /oembed_video

Dapatkan HTML sematan dan metadata dasar dari video Facebook.

Batasan

Endpoint oEmbed Facebook hanya dimaksudkan untuk digunakan dalam menyematkan konten Facebook di situs web dan aplikasi. Tidak boleh digunakan untuk tujuan lain. Dilarang keras menggunakan metadata dan konten halaman, postingan, atau video (atau turunannya) dari endpoint untuk tujuan apa pun selain memberikan tampilan front-end halaman, postingan, atau video.. Larangan ini mencakup menggunakan, memanipulasi, mengekstraksi, atau mempertahankan metadata dan konten, termasuk tetapi tidak terbatas pada memperoleh informasi tentang postingan dari metadata untuk tujuan analitik.

Tinjauan Aplikasi

Untuk menggunakan oEmbed, aplikasi Anda harus menjalani Tinjauan Aplikasi untuk fitur Baca oEmbed.

Untuk menyediakan URL tempat kami dapat menguji kolom formulir Baca oEmbed, gunakan Endpoint oEmbed untuk mendapatkan HTML sematan bagi postingan atau video publik di halaman Facebook atau halaman Instagram resmi kami (atau dapatkan HTML sematan untuk salah satu halaman itu sendiri). Tambahkan HTML sematan yang diberikan ke halaman Anda sendiri tempat Anda akan menampilkan konten oEmbed dan masukkan URL halaman itu di kolom formulir.

Setelah Anda disetujui untuk fitur Baca oEmbed, Anda dapat menyematkan halaman, postingan, atau video Anda sendiri menggunakan URL masing-masing.

Token Akses

Endpoint oEmbed Facebook membutuhkan Token Akses Aplikasi (direkomendasikan) atau Token Akses Klien.

Token Akses Aplikasi

Jika aplikasi Anda mengandalkan server backend, kami rekomendasikan Anda menggunakan Token Akses Aplikasi saat mengakses endpoint oEmbed. Batas laju bergantung pada jenis token yang disertakan dalam permintaan, dan Batas Laju Token Aplikasi mengizinkan hingga 5 juta permintaan per hari.

Instruksi untuk menghasilkan Token Akses Aplikasi dapat ditemukan di bagian Token Aplikasi dari dokumentasi Token Akses kami.

Harap diperhatikan bahwa Token Akses Aplikasi tidak boleh digunakan di sisi klien. Token Akses Aplikasi harus selalu dijaga agar tetap aman dan disimpan di server Anda. Jika aplikasi Anda harus menggunakan token sisi klien, gunakan Token Akses Klien sebagai gantinya.

Token Akses Klien

Jika aplikasi Anda harus mengakses endpoint oEmbed dari agen pengguna seperti perangkat seluler atau browser web, aplikasi Anda harus menggunakan Token Akses Klien dan akan tunduk pada Batas Laju Token Klien.

Untuk mendapatkan Token Akses Klien, masuk ke Dasbor Aplikasi, buka Pengaturan > Lanjutan > Keamanan > Token Klien.

Tidak seperti Token Akses Aplikasi, Token Akses Klien tidak dapat digunakan dalam permintaan endpoint oEmbed sendiri, Token Akses Klien harus dikombinasikan dengan ID Aplikasi Anda. Untuk melakukannya, tambahkan token Anda ke akhir ID aplikasi, dipisahkan dengan simbol pipa (|):

{app-id}|{client-token}

Contoh:

access_token=1234|5678

Batas Laju

Batas laju bergantung pada jenis Token Akses yang disertakan aplikasi Anda di setiap permintaan.

Batas Laju Token Aplikasi

Aplikasi yang mengandalkan Token Akses Aplikasi dapat membuat hingga 5 juta permintaan per 24 jam.

Batas Laju Token Klien

Batas Laju Token Klien secara signifikan lebih rendah daripada Batas Laju Token Aplikasi. Kami tidak mengungkapkan batas sebenarnya karena akan berubah, tergantung aktivitas aplikasi Anda. Namun, Anda dapat dengan aman berasumsi bahwa aplikasi Anda tidak akan mencapai batasnya kecuali jika aplikasi Anda menunjukkan perilaku seperti bot, misalnya mengelompokkan ribuan permintaan, atau mengirimkan ribuan permintaan per agen atau pengguna aplikasi.

Mendapatkan HTML Sematan

Untuk mendapatkan HTML sematan dari halaman, postingan, atau video, kirim permintaan ke endpoint oEmbed halaman, postingan, atau video yang sesuai:

TargetEndpoint dan Struktur Kueri

Halaman

GET /oembed_page?url={url}&access_token={access-token}

Postingan

GET /oembed_post?url={url}&access_token={access-token}

Video

GET /oembed_video?url={url}&access_token={access-token}

Ganti {url} dengan URL halaman, postingan, atau video yang ingin Anda kueri dan {access-token} dengan Token Akses Aplikasi atau Token Akses Klien (atau teruskan kepada kami di header HTTP). Jika Anda menggunakan Token Akses Klien, ingatlah bahwa Anda harus menggabungkannya dengan ID Aplikasi Anda menggunakan simbol pipa, kalau tidak, permintaan akan gagal.

Setelah berhasil, API akan menanggapi dengan objek JSON yang berisi HTML sematan halaman, postingan, atau video dan data tambahan tentang halaman, postingan, atau video. HTML sematan akan ditetapkan ke properti html.

Baca referensi setiap endpoint untuk daftar parameter string kueri yang dapat Anda sertakan untuk menambah permintaan. Anda juga dapat menyertakan parameter string kueri fields di permintaan untuk menentukan Kolom mana yang Anda ingin dikembalikan. Jika tidak ada, semua Kolom default akan disertakan dalam tanggapan.

Contoh Permintaan Halaman

curl -i -X GET \
 "https://graph.facebook.com/v21.0/oembed_page?url=https%3A%2F%2Fwww.facebook.com%2FCDC&access_token=96481..."

Contoh Tanggapan

Beberapa nilai terpotong dengan elipsis (...) agar mudah dibaca.

{
  "provider_url": "https://www.facebook.com",
  "provider_name": "Facebook",
  "height": 500,
  "html": "<div id=\"fb-root\"></div><script async=\"1\" defer=...",
  "type": "rich",
  "version": "1.0",
  "width": 340
}

Format URL

Parameter string kueri url menerima format URL berikut ini:

Halaman

https://www.facebook.com/{page-name}
https://www.facebook.com/{page-id}

Postingan

https://www.facebook.com/{page-name}/posts/{post-id}
https://www.facebook.com/{username}/posts/{post-id}
https://www.facebook.com/{username}/activity/{activity-id}
https://www.facebook.com/photo.php?fbid={photo-id}
https://www.facebook.com/photos/{photo-id}
https://www.facebook.com/permalink.php?story_fbid={post-id}&id={page-or-user-id}
https://www.facebook.com/media/set?set={set-id}
https://www.facebook.com/questions/{question-id}
https://www.facebook.com/notes/{username}/{note-url}/{note-id}

Video

https://www.facebook.com/{page-name}/videos/{video-id}/
https://www.facebook.com/{username}/videos/{video-id}/
https://www.facebook.com/video.php?id={video-id}
https://www.facebook.com/video.php?v={video-id}

SDK JS

Secara default, HTML sematan berisi referensi ke pustaka JavaScript sdk.js. Untuk mendapatkan HTML sematan tanpa referensi sehingga Anda dapat memuatnya secara terpisah, sertakan parameter string kueri omitscript=true.

Meneruskan Token Akses di Header

Jika Anda tidak ingin menyertakan Token Akses Anda ke string kueri permintaan, Anda bisa meneruskannya kepada kami melalui header HTTP Authorization.

Authorization: Bearer {access-token}

Contoh:

curl -i -X GET \
  "https://graph.facebook.com/v21.0/oembed_page?url=https%3A%2F%2Fwww.facebook.com%2FCDC" \
  --header "Authorization: Bearer 96481..."