/api/v4/reviews/site-configTampilkan daftar sumber ulasan untuk akun
Mengembalikan platform ulasan yang tersedia untuk akun. Google Maps dan Facebook tersedia di semua paket, Yelp di Growth dan Enterprise.
Parameter
Endpoint ini tidak menerima parameter.
Respons
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.
Mengembalikan katalog lengkap platform sumber ulasan yang berhak diakses akun berdasarkan langganannya. Respons di atas adalah katalog terkini untuk akun dengan paket Launch; kumpulan situs yang tersedia bergantung pada paket dan sektor industri.
Kasus penggunaan: memvalidasi nilai name sebelum mengonfigurasi lokasi
Field siteUrl adalah pengenal situs kanonis yang digunakan di seluruh bagian lain API ulasan. Sumber ulasan diisi secara otomatis saat Anda menghubungkan profil Google dan Facebook milik suatu lokasi; tidak ada langkah penambahan atau pengeditan manual. Gunakan katalog ini untuk mengetahui nilai filter siteUrls yang valid pada endpoint daftar interaksi.
Kasus penggunaan: membangun UI "hubungkan ulasan Anda"
Tampilkan satu baris untuk setiap situs yang dikembalikan agar pemilik lokasi dapat menempelkan URL profil mereka untuk setiap platform. Padukan katalog yang mencakup seluruh akun ini (sumber yang dapat dihubungkan) dengan Tampilkan daftar sumber ulasan untuk lokasi (sumber yang sudah terhubung untuk satu lokasi) untuk menampilkan sumber yang terhubung dan yang tersedia.
Endpoint ini tidak menerima parameter dan cakupannya terbatas pada satu akun, sehingga hasilnya tetap sama di berbagai pemanggilan; simpan hasilnya dalam cache alih-alih mengambilnya kembali untuk setiap lokasi. Endpoint ini tunduk pada batas laju permintaan akun; saat menerima 429, tunda percobaan ulang dengan mengacu pada header Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \ -H "Authorization: API $LISTINGSAPI_KEY"