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

列出品牌的连接

返回与品牌连接的社交账号,以及每个账号的平台、显示名称和归档状态。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

路径

名称类型必填描述
brandIdstring必填Brand UUID whose connections should be listed.

响应

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`).

列出关联到一个品牌的社交账号。每行的 id 都是连接 ID:当您希望将帖子发布到特定渠道时,这是您在 connectedChannelIds 中传入的值,也是断开连接 所接受的值,以及洞察数据 所需的 socialConnectedChannelId。

使用场景:显示渠道选择器。显示帖子编辑器之前,读取此列表,并为每行提供一个开关,以 displayName 和 platform 作为标签。如果品牌的 socialConnected 数组为空,则没有可用的发布渠道;请引导用户访问连接链接。

使用场景:确认连接已建立。用户从托管连接流程返回并携带 status=success 后,轮询此端点,直到出现 id 与返回 URL 中的 connectedAccountId 匹配的行。连接记录以异步方式创建,因此请等待几秒钟并重试几次,然后再显示错误。

注意事项。

  • platform 的值为 FACEBOOK、INSTAGRAM、TWITTER(X)、LINKEDIN、PINTEREST 之一。
  • id 是连接的 UUID,也是每个接受连接参数的 Social 端点所需的值。referenceId 是平台自身的账号标识符,例如 Facebook 主页 ID 或 Instagram 商业账号 ID,可用于匹配您在 ListingsAPI 之外保存的记录,但此处不接受它作为输入。
  • archived: true 且带有 archivedAt 时间戳,表示连接已不存在,原因可能是有人断开了连接、品牌已被归档,或平台撤销了令牌。向已归档渠道发布帖子会失败,并返回 SY95045。
  • 只有当同一账号也在 Listings 端关联时,才会设置 listingConnectedAccountId;对于仅用于 Social 的连接,其值为 null。
  • 每个品牌在每个平台上仅使用一个连接进行发布。在同一品牌下再次连接同一平台,会替换原有渠道,而不会添加第二个渠道。
  • 要查看您整个账户范围内的连接使用量及其与上限的对比,而非某个品牌的渠道,请调用 GET /social/limits。
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"