GET/api/v4/social/brands/{brandId}/connections

Mencantumkan koneksi suatu merek

Mengembalikan akun media sosial yang terhubung ke suatu merek, beserta platform, nama tampilan, dan status pengarsipan masing-masing.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Path

NamaTipeWajibDeskripsi
brandIdstringwajibBrand UUID whose connections should be listed.

Respons

200The brand's connections.
Response
{  "data": {    "listConnectedChannelWithSocialProfile": {      "socialConnected": [        {          "id": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "INSTAGRAM",          "displayName": "Jenny Home",          "userName": "jennyhome",          "userImage": "https://cdn.listingsapi.com/social/channels/b81d5b3c/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": null,          "referenceId": "17841400000000001"        },        {          "id": "2d4e6f80-1c33-4b7a-8e05-9a1b2c3d4e5f",          "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",          "vendorProfileId": null,          "platform": "FACEBOOK",          "displayName": "Jenny Home & Co.",          "userName": "jennyhomeco",          "userImage": "https://cdn.listingsapi.com/social/channels/2d4e6f80/avatar.jpg",          "archived": false,          "archivedAt": null,          "listingConnectedAccountId": "cf12de77-2211-4a09-b7c1-0a6f3b2e91aa",          "referenceId": "102938475601234"        }      ],      "profileCount": 1,      "channelCount": 2    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Mencantumkan akun media sosial yang terhubung ke satu merek. id pada setiap baris adalah ID koneksi: nilai yang Anda berikan dalam connectedChannelIds saat ingin mengirim postingan ke kanal tertentu, nilai yang diterima oleh pemutusan koneksi, dan socialConnectedChannelId yang diperlukan oleh wawasan.

Kasus penggunaan: menampilkan pemilih kanal. Sebelum menampilkan editor postingan, baca daftar ini dan sediakan satu tombol alih untuk setiap baris, dengan label displayName dan platform. Merek dengan array socialConnected kosong tidak memiliki tujuan untuk memublikasikan postingan; arahkan pengguna ke tautan koneksi.

Kasus penggunaan: memastikan koneksi telah terbentuk. Setelah pengguna kembali dari alur koneksi yang dihosting dengan status=success, panggil endpoint ini secara berkala hingga muncul baris yang nilai id-nya cocok dengan connectedAccountId pada URL pengembalian. Koneksi dibuat secara asinkron, jadi tunggu beberapa detik dan lakukan beberapa percobaan ulang sebelum menampilkan kesalahan.

Catatan.

  • platform adalah salah satu dari FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST.
  • id adalah UUID koneksi dan merupakan nilai yang diperlukan oleh setiap endpoint Social yang menerima koneksi. referenceId adalah pengenal akun milik platform itu sendiri — ID Halaman Facebook, ID akun bisnis Instagram — yang berguna untuk dicocokkan dengan catatan yang Anda simpan di luar ListingsAPI, tetapi tidak pernah diterima sebagai masukan di sini.
  • archived: true dengan stempel waktu archivedAt berarti koneksi sudah tidak ada, baik karena seseorang telah memutuskan koneksinya, karena merek diarsipkan, maupun karena platform mencabut token. Postingan yang menargetkan kanal yang diarsipkan akan gagal dengan SY95045.
  • listingConnectedAccountId hanya ditetapkan jika akun yang sama juga ditautkan di sisi Listings; nilainya adalah null untuk koneksi yang hanya digunakan di Social.
  • Hanya satu koneksi per platform per merek yang digunakan untuk publikasi. Menghubungkan platform yang sama lagi pada merek yang sama akan menggantikan kanal sebelumnya, bukan menambahkan kanal kedua.
  • Untuk melihat penggunaan koneksi di seluruh akun Anda dibandingkan dengan batas maksimum Anda, alih-alih kanal milik satu merek, panggil GET /social/limits.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"