Dokumen ini sudah diperbarui.
Terjemahan ke Bahasa Indonesia belum selesai.
Bahasa Inggris diperbarui: 21 Nov 2022

Integrasi Onboarding

Onboarding ke Toko adalah langkah yang diperlukan untuk memungkinkan penjual berintegrasi ke dalam Meta Commerce. Onboarding yang lancar memastikan bahwa produk penjual telah terkini, informasi pesanan disinkronkan dengan benar, mudah untuk direkonsiliasi setiap kuartal atau tahunan, dan informasi perbankan serta pembayaran diatur dengan benar agar pembayaran dan pelaporan tepat waktu.

Sebagai provider platform/solusi pihak ketiga:

  • Anda perlu onboarding penjual Anda ke Meta Commerce menggunakan Facebook Business Extension (FBE). Ini biasanya memerlukan penerapan alur login di mana situs web atau aplikasi seluler pihak ketiga Anda meminta penjual untuk memasukkan kredensial Facebook atau Instagram mereka. Bergantung pada sifat integrasi yang Anda buat, penjual juga memilih aset Meta yang perlu diakses aplikasi Anda, seperti akun Instagram atau katalog produk. Di akhir alur ini, token akses dibuat untuk Anda simpan dan gunakan saat melakukan panggilan API atas nama penjual tersebut. Token ini dapat digunakan untuk membuat pengguna sistem dalam sistem bisnis. Ini adalah solusi yang lebih permanen untuk memiliki kemampuan terprogram dalam sistem bisnis tanpa khawatir tentang churn pengguna.
  • Anda akan membutuhkan token akses untuk setiap toko (yaitu penjual yang Anda dukung) yang menjual di saluran Facebook dan Instagram.

Persyaratan

Anda diminta untuk berintegrasi dengan Facebook Business Extension (FBE) demi memenuhi standar kualitas integrasi Toko kami dengan mengaktifkan penjual untuk:

  • Menemukan integrasi Meta di platform dengan mudah
  • Menghubungkan akun 3P mereka ke aset Meta (Pengelola Bisnis, jika ada: katalog yang ada, Pixel yang ada, Halaman, Nama Pengguna Instagram)
  • Menyiapkan dan mengedit pengaturan Toko di tempat mereka (Pengaturan Retur, Info Hukum, Info Rekening Bank, Info Pajak)
  • Menautkan aset tambahan (Halaman, Nama Pengguna Instagram) ke toko
  • Mengedit pengaturan mereka
  • Offboard

Sebelum Memulai

  1. Integrasikan bisnis terverifikasi Anda ke dalam FBE.
  2. Tambahkan FBE ke aplikasi Anda dan dapatkan akses ke Panel Developer FBE. Lihat diagram ini untuk memahami alur FBE untuk Perdagangan.
  3. Ikuti langkah pengaturan FBE, lalu kirimkan integrasi Anda untuk Tinjauan Integrasi FBE. Ini termasuk mengaktifkan pengalaman pengelolaan fitur FBE dalam platform Anda sehingga bisnis dapat mengubah fitur mereka atau bahkan menghapus penginstalan pengaturan FBE mereka.

Persyaratan 1: Berintegrasi dengan Facebook Business Extension

Facebook Business Extension (FBE) adalah antarmuka milik Meta berbasis pop-up yang aktif di situs pihak ketiga sebagai plugin dan menyederhanakan keseluruhan proses integrasi dengan Meta. FBE memungkinkan bisnis dengan mudah menyiapkan Meta Pixel, Katalog, dan Toko. FBE membantu bisnis menghubungkan produk dan layanan mereka dengan saluran Facebook dan Instagram di platform Anda. Setelah terhubung, Anda dapat membantu mereka memanfaatkan serangkaian besar fitur canggih.

Singkatnya, pemisahan tanggung jawab dalam integrasi berbasis FBE adalah seperti yang diuraikan di bawah ini:

  • Dimiliki oleh Meta: Antarmuka, autentikasi, koneksi dan permukaan [(tampilan Pengelolaan FBE)](Tampilan Pengelolaan Fitur FBE) untuk melihat aset yang terhubung, mengelola fitur yang terinstal, dan status integrasi perdagangan
  • Dimiliki oleh Partner: Pengaturan Pixel, unggahan stok ke katalog Facebook melalui API

Setelah diatur, bisnis Anda dapat memulai alur onboarding FBE, baik dengan aset yang ada atau dengan memiliki opsi untuk membuat yang baru, atau kombinasi keduanya.

Langkah 1: Tambahkan Titik Masuk ke FBE pada Aplikasi Anda

Buat titik masuk ke FBE tempat pengguna memilih, mengelola, atau membuat aset mereka (misalnya: bisnis, katalog, toko, pixel, dsb.). Titik masuk ini bisa berupa salah satu bentuk ini:

  • Login Bisnis (alias Facebook Login) – Memungkinkan bisnis untuk memulai koneksi mereka dari platform Anda menggunakan tombol yang ditempatkan di situs Anda.
  • Aplikasi Bisnis – Memungkinkan bisnis untuk memulai koneksi mereka dari Meta Surface. Untuk mengaktifkan alur ini dan agar aplikasi Anda terdaftar di Aplikasi Bisnis Meta, Anda harus menyediakan UI autentikasi khusus di situs Anda. UI ini harus memungkinkan pengguna untuk memilih bisnis mereka, lalu mengarahkan mereka kembali ke alur Meta dengan informasi yang dipilih.

Contoh

https://facebook.com/dialog/oauth?
client_id=<FB_APP_ID>
&display=page
&redirect_uri="https://partner-site.com/redirectlanding"
&response_type=token
&scope=manage_business_extension
//   additionally use catalog_management or ads_management
//   &scope=manage_business_extension,catalog_management,ads_management
&extras={
  "setup": {
    "external_business_id": "foo-123",
    "timezone": "America/Los_Angeles",
    "currency": "USD",
    "domain": "https://example-shop.partner-site.com/",
    "channel": "ECOMMERCE",
    "business_vertical": "ECOMMERCE"
  },
  "business_config": {
    "business": {
      "name": "Foo Business"
    },
    "catalog_feed_scheduled": {
      "enabled": true,
      "feed_url": "https://partner-site.com/feed-url"
    },
    "page_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business",
      "below_button_text": "Powered by FBE Partner"
    },
    "ig_cta": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    },
    "messenger_menu": {
      "enabled": true,
      "cta_button_text": "Shop Now",
      "cta_button_url": "https://partner-site.com/foo-business"
    }
  },
  "repeat": false
}

Tergantung pengaturan pilihan Anda, Anda bisa mendapatkan token akses bisnis untuk langkah-langkah selanjutnya dalam berbagai cara:

  • Login Bisnis – Seperti halnya Facebook Login normal, akhir alur ini memberikan access_token, yang Anda gunakan untuk mendapatkan lebih banyak aset (misalnya: ID Pixel, ID Halaman, dan ID Instagram Business)
  • Aplikasi Bisnis – melalui Webhooks.

Langkah 2: Siapkan Webhooks FBE_install

Webhooks wajib bagi semua partner yang ingin terdaftar di App Store. Jika Anda tidak berencana untuk mendaftarkan aplikasi Anda di app store, Anda dapat memilih untuk mengabaikan bagian ini atau mengunjungi kembali nanti. Meta memicu peristiwa Webhooks setiap kali salah satu bisnis Anda menginstal, mengubah, atau menghapus penginstalan FBE. Setiap kali peristiwa Webhooks diterima, aplikasi Anda diharapkan akan menggunakan peristiwa ini dan memahami aset apa yang telah diubah, ditambahkan, atau dihapus oleh bisnis dari koneksinya dengan aplikasi Anda. Perilaku aplikasi Anda harus diperbarui berdasarkan aset terbaru yang terhubung. Kami sangat merekomendasikan Anda menerapkan dan menguji langganan Anda ke Webhooks kami.

Untuk menyiapkan Webhooks:

  1. Anda harus membuat endpoint di server aman yang dapat memproses permintaan dari Meta.
  2. Di Dasbor Aplikasi, konfigurasikan deskripsi Webhooks FBE Anda:
    1. Di bagian FBE > tab Webhooks, ketikkan URL panggilan balik aplikasi Anda.
    2. Masukkan token verifikasi lalu validasi endpoint Anda.

Setelah pengaturan, otomatis akan berlangganan Webhooks fbe_install.

Untuk langkah yang lebih mendetail, lihat Webhooks.

Notifikasi

Setelah menerima notifikasi Webhooks tentang penginstalan, Anda harus:

  1. Menyimpan token akses (dan jenisnya) serta mencatat aset yang aksesnya telah diberikan ke aplikasi Anda.
  2. Mengaktifkan satu set fitur berdasarkan aset apa yang telah diberikan.
  3. Jika aset wajib untuk fitur tertentu tidak ada, nonaktifkan fitur tersebut. Contoh: jika aplikasi Anda telah diberikan akses ke katalog, tetapi bukan pixel, hanya terapkan fitur yang didukung oleh katalog, bukan fitur yang didukung oleh pixel.
  4. Beri tahu pengguna melalui pembaruan tentang perilaku aplikasi Anda berdasarkan aset yang dapat mereka akses.

Setelah menerima pembaruan tentang penginstalan yang ada, Anda harus:

  1. Memperbarui token akses dan catatan aset yang telah diberikan kepada Anda.
  2. Memperbarui set fitur aplikasi Anda akan diaktifkan untuk penjual berdasarkan aset yang telah diberikan ke platform.
  3. Beri tahu pengguna melalui pembaruan tentang perilaku aplikasi Anda berdasarkan aset yang dapat mereka akses.

Setelah menerima pembaruan tentang penghapusan penginstalan, Anda harus:

  1. Menonaktifkan fitur yang diterapkan aplikasi Anda untuk penjual.
  2. Memberi tahu penjual tentang perubahan konfigurasinya.

Langkah 3: Ambil Detail Aset dengan Token yang Diberikan

Anda bisa mendapatkan informasi tentang bisnis yang terhubung ke platform Anda melalui FBE via salah satu atau kedua metode berikut:

  • WebhooksWajib untuk semua partner yang ingin terdaftar di App Store. Dengan pengaturan Webhooks, detail onboarding bisnis atau pengeditan melalui FBE akan diterima melalui muatan Webhooks dari pengaturan Webhooks di Langkah 2.
  • Endpoint API Penginstalan FBEDirekomendasikan untuk bisnis dengan hosting mandiri. Untuk bisnis apa pun yang telah menginstal FBE, Anda dapat meminta informasi penginstalan dasar mereka menggunakan endpoint fbe_installs. Menggunakan token akses bisnis dan ID bisnis eksternal, Anda dapat memanggil endpoint API Penginstalan FBE untuk informasi mendetail tentang pengaturan mereka.

Anda harus menyiapkan setidaknya satu dari metode ini. Diperlukan untuk mendapatkan ID aset bisnis untuk mengonfigurasikan fitur yang relevan untuk bisnis dengan benar.

Contoh: FBE Menginstal Panggilan API

curl -i -X GET \   "https://graph.facebook.com/<version>/fbe_business/fbe_installs?fbe_external_business_id=<external business id>&access_token=<access token sanitized>"

Langkah 4: Ambil Token Pengguna Sistem

Setelah pengguna menginstal FBE, ekstensi membuat pengguna sistem karyawan pada Pengelola Bisnis klien. Perhatikan bahwa pengguna sistem ini tidak lagi terlihat di Pengelola Bisnis, tetapi ada di backend. Penamaan untuk pengguna sistem baru ini mengikuti skema {App Name} System User (FBE).

Sistem token pengguna dan akses API tidak dikaitkan dengan satu orang. Ini sangat berguna jika karyawan keluar dari perusahaan atau menonaktifkan profil mereka. Jika Anda menerima token akses pengguna melalui Webhooks atau Login Bisnis setelah penginstalan FBE, Anda dapat menggunakan token yang sama untuk mendapatkan token akses pengguna sistem Pengelola Bisnis.

Untuk melakukannya, lakukan panggilan API berikut:

curl -X POST \
  -F 'app_id={app_id}' \
  -F 'scope=ads_management,catalog_management,manage_business_extension' \ 
  -F 'access_token={user_access_token}' \
  -F 'fbe_external_business_id={fbe_external_business_id}' \ 
https://graph.facebook.com/<API_VERSION>/<client_business_manager_id>/access_token

Untuk kolom scope, gunakan izin manage_business_extension. Tergantung kasus penggunaan Anda (lihat Langkah 5), izin ads_management, catalog_management, pages_read_engagement, business_management, instagram_basic, dan manage_business_extension kemungkinan besar masih akan diperlukan.

  • Jika aplikasi Anda perlu membaca dan mengelola akun Iklan bisnis, minta izin ads_management. Dengan izin ini, Anda memiliki kemampuan untuk membuat kampanye iklan, mengambil metrik iklan, membuat fitur pengelolaan iklan, dan banyak lagi.
  • Jika aplikasi Anda perlu membuat, membaca, memperbarui, atau menghapus katalog produk milik bisnis yang adminnya adalah bisnis itu sendiri, Anda harus meminta izin catalog_management. Kami merekomendasikan izin ini untuk semua aplikasi. Hal ini memungkinkan aplikasi Anda untuk membangun solusi terkait perdagangan, iklan dinamis, dan solusi pengelolaan stok.

Langkah 5: Menyiapkan Tampilan Pengelolaan

Untuk memungkinkan bisnis mengonfigurasikan fitur lebih lanjut (di luar apa yang ditentukan dalam penginstalan), Anda dapat mengarahkan bisnis ke Tampilan Pengelolaan Fitur FBE dari platform Anda. Anda dapat menggunakan JavaScript SDK atau URL untuk menambahkan titik masuk guna meluncurkan Tampilan Pengelolaan FBE. Kedua metode ini menampilkan tombol untuk diklik, yang akan meluncurkan jendela Tampilan Pengelolaan FBE.

Langkah 6: Tambahkan Titik Masuk untuk Menghapus Penginstalan FBE

Platform Anda sebaiknya menambahkan titik masuk (misalnya: tombol) agar bisnis dapat menghapus penginstalan FBE. Kami merekomendasikan untuk melakukan ini dengan membuat permintaan DELETE ke endpoint yang sesuai.

Contoh: Panggilan ke Endpoint Penghapusan kita

curl -X DELETE \
"https://graph.facebook.com/v<API_VERSION>/fbe_business/fbe_installs?fbe_external_business_id=<FBE_EXTERNAL_BUSINESS_ID>&access_token=<ACCESS_TOKEN>"

Jika Anda telah menerapkan Webhooks fbe_install, Anda akan menerima peristiwa ketika pengguna menghapus penginstalan FBE.