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

Lister les connexions d'une marque

Renvoie les comptes sociaux connectés à une marque, avec la plateforme, le nom d'affichage et l'état d'archivage de chacun.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chemin

NomTypeObligatoireDescription
brandIdstringobligatoireBrand UUID whose connections should be listed.

Réponses

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

Liste les comptes sociaux rattachés à une marque. Le champ id de chaque ligne est l'identifiant de connexion : c'est la valeur que vous transmettez dans connectedChannelIds lorsque vous souhaitez qu'une publication soit diffusée sur des canaux précis, la valeur qu'accepte déconnecter et le socialConnectedChannelId requis par statistiques.

Cas d'utilisation : afficher le sélecteur de canaux. Avant d'afficher un éditeur de publication, consultez cette liste et proposez un bouton à bascule par ligne, libellé avec displayName et platform. Une marque dont le tableau socialConnected est vide ne dispose d'aucun canal de publication ; dirigez plutôt l'utilisateur vers un lien de connexion.

Cas d'utilisation : confirmer qu'une connexion a bien été établie. Lorsque l'utilisateur revient du parcours de connexion hébergé avec status=success, interrogez régulièrement cet endpoint jusqu'à ce que la ligne dont le champ id correspond au connectedAccountId de l'URL de retour apparaisse. Les connexions sont créées de manière asynchrone ; attendez donc quelques secondes et effectuez deux nouvelles tentatives avant d'afficher une erreur.

Remarques.

  • platform prend l'une des valeurs suivantes : FACEBOOK, INSTAGRAM, TWITTER (X), LINKEDIN, PINTEREST.
  • id est l'UUID de la connexion et la valeur attendue par chaque endpoint Social qui prend une connexion en paramètre. referenceId est l'identifiant du compte propre à la plateforme — un identifiant de Page Facebook, un identifiant de compte professionnel Instagram — utile pour établir une correspondance avec les enregistrements que vous conservez en dehors de ListingsAPI, mais jamais accepté en entrée ici.
  • archived: true accompagné d'un horodatage archivedAt signifie que la connexion n'existe plus, soit parce que quelqu'un l'a déconnectée, soit parce que la marque a été archivée, soit parce que la plateforme a révoqué le jeton. Une publication ciblant un canal archivé échoue avec SY95045.
  • listingConnectedAccountId n'est défini que lorsque le même compte est également lié côté Listings ; sa valeur est null pour une connexion uniquement Social.
  • Une seule connexion par plateforme et par marque est utilisée pour la publication. Connecter de nouveau la même plateforme à la même marque remplace le canal précédent au lieu d'en ajouter un second.
  • Pour consulter le nombre de connexions utilisées à l'échelle de votre compte par rapport à votre plafond, plutôt que les canaux d'une seule marque, appelez GET /social/limits.
Request
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \  -H "Authorization: API $LISTINGSAPI_KEY"