/api/v4/reviews/site-configRépertorier les sources d’avis d’un compte
Renvoie les plateformes d’avis disponibles pour le compte : Google Maps et Facebook pour toutes les offres, Yelp pour Growth et Enterprise.
Paramètres
Cet endpoint ne prend aucun paramètre.
Réponses
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.
Renvoie le catalogue complet des plateformes sources d’avis auxquelles le compte a droit dans le cadre de son abonnement. La réponse ci-dessus correspond au catalogue actuel d’un compte disposant de l’offre Launch ; l’ensemble exact des sites dépend de l’offre et du secteur d’activité.
Cas d’utilisation : valider les valeurs de name avant de configurer un établissement
Le champ siteUrl est l’identifiant canonique du site utilisé partout ailleurs dans l’API des avis. Les sources d’avis sont renseignées automatiquement lorsque vous connectez les profils Google et Facebook d’un établissement ; aucune étape manuelle d’ajout ou de modification n’est nécessaire. Utilisez ce catalogue pour découvrir les valeurs valides du filtre siteUrls sur l’endpoint de liste des interactions.
Cas d’utilisation : créer une interface « Connectez vos avis »
Affichez une ligne par site renvoyé afin que le propriétaire d’un établissement puisse coller l’URL de son profil pour chaque plateforme. Associez ce catalogue à l’échelle du compte (ce qui est possible) à Répertorier les sources d’avis d’un établissement (ce qui est déjà connecté pour un établissement) pour afficher les sources connectées et les sources disponibles.
Cet endpoint ne prend aucun paramètre et sa portée est limitée au compte ; le résultat est donc stable d’un appel à l’autre : mettez-le en cache plutôt que de le récupérer à nouveau pour chaque établissement. Il est soumis à la limite de débit du compte ; en cas de 429, espacez les tentatives en vous appuyant sur l’en-tête Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \ -H "Authorization: API $LISTINGSAPI_KEY"