/api/v4/reviews/site-configElenca le fonti delle recensioni per un account
Restituisce le piattaforme di recensioni disponibili per l'account: Google Maps e Facebook in ogni piano, Yelp con Growth ed Enterprise.
Parametri
Questo endpoint non accetta parametri.
Risposte
200Account-level review source catalog.
{ "data": { "interactionSiteConfig": [ { "site": "Google", "siteUrl": "maps.google.com" }, { "site": "Facebook", "siteUrl": "facebook.com" }, { "site": "Yelp", "siteUrl": "yelp.com" } ] }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Restituisce il catalogo completo delle piattaforme da cui provengono le recensioni a cui l'account ha diritto in base al proprio abbonamento. La risposta qui sopra è il catalogo attuale per un account con piano Launch; l'insieme esatto dei siti dipende dal piano e dal settore.
Caso d'uso: convalida i valori di name prima di configurare una sede
Il campo siteUrl è l'identificatore canonico del sito utilizzato in tutto il resto dell'API delle recensioni. Le fonti delle recensioni vengono inserite automaticamente quando colleghi i profili Google e Facebook di una sede; non è previsto alcun passaggio manuale di aggiunta o modifica. Usa questo catalogo per individuare i valori validi del filtro siteUrls nell'endpoint che elenca le interazioni.
Caso d'uso: crea un'interfaccia "collega le tue recensioni"
Visualizza una riga per ogni sito restituito, in modo che il titolare di una sede possa incollare l'URL del proprio profilo per ciascuna piattaforma. Abbina questo catalogo valido per l'intero account (ciò che è possibile) a Elenca le fonti delle recensioni per una sede (ciò che è già collegato per una singola sede) per mostrare le fonti collegate e quelle disponibili.
Questo endpoint non accetta parametri e ha come ambito l'account, quindi il risultato è stabile tra una chiamata e l'altra; memorizzalo nella cache invece di recuperarlo di nuovo per ogni sede. È soggetto al limite di frequenza delle richieste dell'account; in caso di 429, attendi prima di riprovare usando l'header Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \ -H "Authorization: API $LISTINGSAPI_KEY"