GET/api/v4/reviews/site-config

Bewertungsquellen für ein Konto auflisten

Gibt die für das Konto verfügbaren Bewertungsplattformen zurück. Google Maps und Facebook sind in jedem Tarif verfügbar, Yelp in Growth und Enterprise.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Dieser Endpunkt hat keine Parameter.

Antworten

200Account-level review source catalog.
Response
{  "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.

Gibt den vollständigen Katalog der Plattformen für Bewertungsquellen zurück, auf die das Konto im Rahmen seines Abonnements Zugriff hat. Die obige Antwort zeigt den aktuellen Katalog für ein Konto im Launch-Tarif; welche Websites genau enthalten sind, hängt vom Tarif und der Branche ab.

Anwendungsfall: name-Werte vor der Konfiguration eines Standorts validieren

Das Feld siteUrl ist die kanonische Website-Kennung, die überall sonst in der Bewertungs-API verwendet wird. Bewertungsquellen werden automatisch eingetragen, wenn Sie die Google- und Facebook-Profile eines Standorts verbinden; es gibt keinen manuellen Schritt zum Hinzufügen oder Bearbeiten. Verwenden Sie diesen Katalog, um die gültigen siteUrls-Filterwerte für den Endpunkt zum Auflisten von Interaktionen zu ermitteln.

Anwendungsfall: Eine Benutzeroberfläche zum Verbinden Ihrer Bewertungen erstellen

Zeigen Sie für jede zurückgegebene Website eine Zeile an, damit Standortinhaber ihre Profil-URL für jede Plattform einfügen können. Kombinieren Sie diesen kontoweiten Katalog (was möglich ist) mit Bewertungsquellen für einen Standort auflisten (was für einen Standort bereits verbunden ist), um verbundene und verfügbare Quellen anzuzeigen.

Dieser Endpunkt akzeptiert keine Parameter und gilt für das gesamte Konto, sodass das Ergebnis über mehrere Aufrufe hinweg stabil bleibt; speichern Sie es im Cache, statt es für jeden Standort erneut abzurufen. Er unterliegt dem Anfragelimit des Kontos; warten Sie bei 429 entsprechend dem Header Retry-After, bevor Sie weitere Anfragen senden.

Request
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \  -H "Authorization: API $LISTINGSAPI_KEY"