/api/v4/reviews/site-configعرض مصادر التقييمات لحساب
يُرجع منصات التقييمات المتاحة للحساب. تتوفر Google Maps وFacebook في جميع الخطط، وتتوفر Yelp في خطتَي Growth وEnterprise.
المعلمات
لا تأخذ نقطة النهاية هذه أي معلمات.
الاستجابات
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.
يُرجع القائمة الكاملة لمنصات مصادر التقييمات التي يحق للحساب الوصول إليها بموجب اشتراكه. تعرض الاستجابة أعلاه القائمة الحالية لحساب مشترك في خطة Launch؛ وتتوقف المجموعة المحددة من المواقع الإلكترونية على الخطة وقطاع النشاط.
حالة استخدام: التحقق من صحة قيم name قبل إعداد موقع
الحقل siteUrl هو المعرّف المعتمد للموقع الإلكتروني والمستخدم في جميع المواضع الأخرى في واجهة API للتقييمات. تُملأ مصادر التقييمات تلقائيًا عند ربط الملفات التعريفية للموقع على Google وFacebook، ولا توجد خطوة إضافة أو تعديل يدوية. استخدم هذه القائمة لمعرفة قيم عامل التصفية siteUrls الصالحة في نقطة نهاية عرض قائمة التفاعلات.
حالة استخدام: إنشاء واجهة مستخدم بعنوان "اربط تقييماتك"
اعرض صفًا واحدًا لكل موقع إلكتروني تُرجعه الاستجابة ليتمكن مالك الموقع من لصق عنوان URL لملفه التعريفي على كل منصة. اجمع بين هذه القائمة التي تشمل الحساب بأكمله (ما يمكن ربطه) وعرض مصادر التقييمات لموقع (ما رُبط بالفعل لموقع واحد) لعرض المصادر المرتبطة مقابل المصادر المتاحة.
لا تقبل نقطة النهاية هذه أي معاملات ويقتصر نطاقها على الحساب، لذا تظل النتيجة ثابتة عبر الاستدعاءات؛ خزّنها مؤقتًا بدلًا من إعادة جلبها لكل موقع. تخضع نقطة النهاية لحد معدل الطلبات الخاص بالحساب؛ وعند تلقي 429، انتظر قبل إعادة المحاولة باستخدام الترويسة Retry-After.
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \ -H "Authorization: API $LISTINGSAPI_KEY"