/api/v4/social/brands/{brandId}/connectionsListar as conexões de uma marca
Retorna as contas sociais conectadas a uma marca, com a plataforma, o nome de exibição e o estado de arquivamento de cada uma.
Parâmetros
Caminho
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| brandId | string | obrigatório | Brand UUID whose connections should be listed. |
Respostas
200The brand's connections.
{ "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`).
Lista as contas sociais vinculadas a uma marca. O id de cada linha é o ID da conexão: o valor que você passa em connectedChannelIds quando quer direcionar uma publicação a canais específicos, o valor que desconectar aceita e o socialConnectedChannelId que estatísticas exige.
Caso de uso: exibir o seletor de canais. Antes de mostrar um editor de publicações, consulte esta lista e ofereça uma opção de seleção por linha, identificada por displayName e platform. Uma marca com um array socialConnected vazio não tem onde publicar; nesse caso, direcione o usuário para um link de conexão.
Caso de uso: confirmar que uma conexão foi estabelecida. Depois que o usuário retornar do fluxo de conexão hospedado com status=success, consulte este endpoint periodicamente até aparecer a linha cujo id corresponda ao connectedAccountId na URL de retorno. As conexões são criadas de forma assíncrona, portanto, aguarde alguns segundos e faça duas novas tentativas antes de exibir um erro.
Observações.
platformé um destes valores:FACEBOOK,INSTAGRAM,TWITTER(X),LINKEDIN,PINTEREST.idé o UUID da conexão e o valor esperado por todo endpoint de Social que aceita uma conexão.referenceIdé o identificador da conta na própria plataforma — um ID de Página do Facebook, um ID de conta comercial do Instagram — útil para fazer a correspondência com registros que você mantém fora do ListingsAPI, mas nunca aceito como entrada aqui.archived: truecom um carimbo de data e hora emarchivedAtsignifica que a conexão deixou de existir, seja porque alguém a desconectou, porque a marca foi arquivada ou porque a plataforma revogou o token. Uma publicação direcionada a um canal arquivado falha comSY95045.listingConnectedAccountIdsó é definido quando a mesma conta também está vinculada no lado de Listings; seu valor énullpara uma conexão exclusiva de Social.- Apenas uma conexão por plataforma por marca é usada para publicação. Conectar a mesma plataforma novamente à mesma marca substitui o canal anterior em vez de adicionar um segundo.
- Para ver o uso de conexões em toda a sua conta em relação ao seu limite, em vez dos canais de uma marca, chame
GET /social/limits.
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \ -H "Authorization: API $LISTINGSAPI_KEY"