Onboarding

Bisnis Atas Nama

API Bisnis Atas Nama memungkinkan mitra untuk:

  • Mendapatkan akses untuk bertindak atas nama klien mereka
  • Membuat pengguna sistem di bawah Pengelola Bisnis klien mereka dan mengambil token aksesnya

Pengguna sistem didefinisikan sebagai seseorang yang dapat melakukan tugas terprogram yang berulang-ulang, seperti memperbarui katalog produk, mengirim peristiwa server-ke-server, atau memperbarui pemirsa khusus, dan sebagainya.

Dalam skenario ini, pengguna sistem memiliki akses karyawan dan hanya dapat mengakses aset yang ditetapkan (pada saat pembuatan) menggunakan token akses pengguna admin.

Keuntungan menggunakan pengguna sistem vs. token akses milik pengguna — pengguna dapat menghentikan bisnis, tetapi token akses pengguna sistem tidak kedaluwarsa. Dengan pendekatan ini, klien tetap menjadi pemilik bisnis mereka dan memberikan akses ke Pengelola Bisnis dan aset mereka kepada mitra melalui pengguna sistem. Klien memiliki kemampuan untuk membuka Pengelola Bisnis mereka dan mencabut pengguna sistem atau menghapus akses aset tertentu ke mitra secara terprogram.

Memulai

Sebelum memulai, kami sarankan Anda untuk meninjau persyaratan dan informasi ini:

Pengelola Bisnis untuk Klien

Jika klien Anda telah membuat akun dagang melalui Commerce Manager, akun tersebut sudah terhubung dengan Pengelola Bisnis mereka. Anda dapat menemukan ID Pengelola Bisnis mereka dengan mengikuti instruksi ini.

Jika tidak ada Pengelola Bisnis untuk klien, Anda harus membuatnya sebelum melanjutkan. Untuk instruksi, lihat Pengelola Bisnis API.

Izin Aplikasi

  • business_management

ID

  • PARTNER_BM_ID: ID Pengelola Bisnis dari mitra yang seharusnya memiliki aplikasi.
  • CLIENT_BM_ID: ID Pengelola Bisnis klien yang memiliki Halaman Facebook yang terhubung ke Akun Dagang klien.

Token Akses

  • USERS_ACCESS_TOKEN: Token akses dari admin Pengelola Bisnis klien, dibuat dengan izin business_manage menggunakan aplikasi yang dimiliki oleh Pengelola Bisnis mitra. Token ini dibuat melalui Login Facebook.
  • PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN: Token akses pengguna sistem admin di Pengelola Bisnis mitra untuk aplikasi.
  • CLIENT_BM_SU_ACCESS_TOKEN: Token akses pengguna sistem di bawah Pengelola Bisnis klien.
  • CLIENT_BM_SU_PAGE_ACCESS_TOKEN: Token akses halaman pengguna sistem di bawah Pengelola Bisnis klien.

Langkah yang Direkomendasikan

Langkah 1

Buat hubungan Atas Nama antara mitra dan Pengelola Bisnis klien.

Hal ini menciptakan edge hubungan antara Pengelola Bisnis mitra dan Pengelola Bisnis klien. Hal ini memungkinkan mitra untuk dapat membuat SU melalui API pada langkah berikutnya.

Token Akses yang Digunakan:USERS_ACCESS_TOKEN


curl -i -X POST \
 "https://graph.facebook.com/v21.0/<PARTNER_BM_ID>/managed_businesses?existing_client_business_id=<CLIENT_BM_ID>&access_token=<USERS_ACCESS_TOKEN>"

Langkah 2

Ambil token akses pengguna sistem di bawah Pengelola Bisnis klien. Ini akan menginstal aplikasi di Pengelola Bisnis klien dan membuat pengguna sistem. Secara default, nama pengguna sistem adalah "PENGGUNA SISTEM {Client_Business_Manager_Name}". Klien akan dapat melihat Aplikasi mitra di Pengelola Bisnis mereka sebagai aset bersama. (Mereka tidak akan memiliki akses apa pun ke Aplikasi selain sebagai pengguna uji coba.)

Dalam parameter scope, Anda harus menyertakan izin apa pun yang perlu dimiliki oleh pengguna sistem agar dapat mengakses endpoint API yang relevan. Lihat referensi masing-masing API untuk mengetahui izin yang diperlukan untuk mengaksesnya.

Token Akses yang Digunakan:PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN. Token akses ini harus memiliki izin business_management, dan semua izin yang tercakup dalam parameter scope di atas.


curl -i -X POST \
 "https://graph.facebook.com/v21.0/<CLIENT_BM_ID>/access_token?scope=ads_management,pages_read_engagement&app_id=<APP_ID>&access_token=<PARTNER_BM_ADMIN_SYSTEM_USER_ACCESS_TOKEN>"

Tanggapan berisi token untuk pengguna sistem yang terhubung dengan hubungan OBO. Anda tidak perlu membuat atau menggunakan pengguna sistem lain untuk integrasi perdagangan.

Langkah 3

Dapatkan ID pengguna sistem.

Token Akses yang Digunakan:CLIENT_BM_SU_ACCESS_TOKEN

curl -i -X GET \
 "https://graph.facebook.com/v21.0/me?access_token=<CLIENT_BM_SU_ACCESS_TOKEN>"

Langkah 4

Tetapkan aset (halaman dan katalog) ke pengguna sistem di Pengelola Bisnis klien.

Token Akses yang Digunakan:USERS_ACCESS_TOKEN

curl -i -X POST \
 "https://graph.facebook.com/v21.0/<ASSET_ID>/assigned_users?user=<SYSTEM_USER_ID>&tasks=MANAGE&access_token=<USERS_ACCESS_TOKEN>"

Langkah 5

Simpan CLIENT_BM_SU_ACCESS_TOKEN ini dalam basis data yang aman dan gunakan untuk mengakses API yang memerlukan token akses pengguna, seperti Pengelolaan Katalog.

Langkah 6

Buat Token Akses Halaman menggunakan CLIENT_BM_SU_ACCESS_TOKEN dengan memanggil:

curl -i -X GET \
 "https://graph.facebook.com/v21.0/me/accounts?access_token=<CLIENT_BM_SU_ACCESS_TOKEN>"

Permintaan ini akan mencantumkan semua Halaman yang dikelola oleh pengguna sistem termasuk access_token yang sesuai. Contoh tanggapan:

{
  "data": [
    {
      "access_token": "<access token sanitized>",
      "category": "Retail Company",
      "category_list": [
        {
          "id": "2239",
          "name": "Retail Company"
        }
      ],
      "name": "Test_Shop_Page",
      "id": "<content sanitized>",
      "tasks": [
        "ANALYZE",
        "ADVERTISE",
        "MODERATE",
        "CREATE_CONTENT",
        "MANAGE"
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "<content sanitized>",
      "after": "<content sanitized>"
    }
  }
}

Salin access_token yang sesuai dengan halaman yang ditautkan dengan Akun Dagang klien, dan simpan dengan aman. Anda akan menggunakannya untuk mengakses API yang memerlukan Token Akses Halaman atas nama Akun Dagang, seperti Pengelolaan Pesanan dan Pelaporan Keuangan.

Pertanyaan Umum

Bagaimana cara menghapus hubungan Atas Nama untuk menghapus pengguna Sistem di bawah Pengelola Bisnis klien yang ditetapkan untuk saya?


curl -i -X DELETE \
 "https://graph.facebook.com/v21.0/<PARTNER_BM_ID>/managed_businesses?existing_client_business_id=<CLIENT_BM_ID>&access_token=<USERS_ACCESS_TOKEN>"

Jika Klien ingin menghapus koneksi dan Pengguna Sistem Mitra, mereka dapat melakukannya di Tampilan aplikasi Pengelola Bisnis.