/api/v4/reviews/site-configListar fontes de avaliações de uma conta
Retorna as plataformas de avaliações disponíveis na conta: Google Maps e Facebook em todos os planos; Yelp nos planos Growth e Enterprise.
Parâmetros
Este endpoint não recebe parâmetros.
Respostas
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.
Retorna o catálogo completo de plataformas de origem das avaliações às quais a conta tem direito de acesso conforme sua assinatura. A resposta acima é o catálogo atual de uma conta do plano Launch; o conjunto exato de sites depende do plano e do segmento de atuação.
Caso de uso: validar valores de name antes de configurar um local
O campo siteUrl é o identificador canônico do site usado em toda a API de avaliações. As fontes de avaliações são preenchidas automaticamente quando você conecta os perfis do Google e do Facebook de um local; não há etapa manual de adição ou edição. Use este catálogo para descobrir os valores válidos do filtro siteUrls no endpoint de listagem de interações.
Caso de uso: criar uma interface de "conecte suas avaliações"
Exiba uma linha para cada site retornado para que o proprietário de um local possa colar a URL do seu perfil em cada plataforma. Combine este catálogo válido para toda a conta (o que é possível) com Listar fontes de avaliações de um local (o que já está conectado para um local) para mostrar as fontes conectadas e as disponíveis.
Este endpoint não aceita parâmetros e tem escopo de conta, portanto o resultado é estável entre chamadas; armazene-o em cache em vez de buscá-lo novamente para cada local. Ele está sujeito ao limite de requisições da conta; em caso de 429, aguarde antes de tentar novamente, usando o cabeçalho Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \ -H "Authorization: API $LISTINGSAPI_KEY"