/api/v4/social/brands/{brandId}/connectionsElenca le connessioni di un brand
Restituisce gli account social collegati a un brand, con la piattaforma, il nome visualizzato e lo stato di archiviazione di ciascuno.
Parametri
Percorso
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| brandId | string | obbligatorio | Brand UUID whose connections should be listed. |
Risposte
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`).
Elenca gli account social collegati a un singolo brand. Il valore id di ogni riga è l'ID della connessione: il valore che passi in connectedChannelIds quando vuoi indirizzare un post a canali specifici, il valore accettato da disconnect e il valore socialConnectedChannelId richiesto da insights.
Caso d'uso: visualizzare il selettore dei canali. Prima di mostrare un editor di post, leggi questo elenco e proponi un interruttore per ogni riga, con un'etichetta contenente displayName e platform. Un brand con un array socialConnected vuoto non ha canali su cui pubblicare; indirizza invece l'utente a un link di connessione.
Caso d'uso: confermare che una connessione sia stata completata. Dopo che l'utente torna dal flusso di connessione ospitato con status=success, interroga periodicamente questo endpoint finché non compare la riga il cui valore id corrisponde al valore connectedAccountId nell'URL di ritorno. Le connessioni vengono create in modo asincrono, quindi attendi qualche secondo ed effettua un paio di nuovi tentativi prima di mostrare un errore.
Note.
platformassume uno dei seguenti valori:FACEBOOK,INSTAGRAM,TWITTER(X),LINKEDIN,PINTEREST.idè l'UUID della connessione ed è il valore richiesto da ogni endpoint Social che accetta una connessione.referenceIdè l'identificatore dell'account assegnato dalla piattaforma stessa — l'ID di una Pagina Facebook, l'ID di un account aziendale Instagram — utile per trovare corrispondenze con i record che conservi al di fuori di ListingsAPI, ma mai accettato come input qui.archived: truecon un timestamparchivedAtindica che la connessione non è più disponibile, perché qualcuno l'ha scollegata, perché il brand è stato archiviato oppure perché la piattaforma ha revocato il token. Un post indirizzato a un canale archiviato fallisce conSY95045.listingConnectedAccountIdviene impostato solo quando lo stesso account è collegato anche sul lato Listings; valenullper una connessione solo Social.- Per la pubblicazione viene utilizzata una sola connessione per piattaforma per brand. Collegare nuovamente la stessa piattaforma allo stesso brand sostituisce il canale precedente anziché aggiungerne un secondo.
- Per vedere l'utilizzo delle connessioni nell'intero account rispetto al tuo limite massimo, anziché i canali di un singolo brand, chiama
GET /social/limits.
curl -X GET 'https://listingsapi.com/api/v4/social/brands/<brandId>/connections' \ -H "Authorization: API $LISTINGSAPI_KEY"