Listings APIListings API
Iniciar sesión
GET/api/v4/plan-sites

Listar los sitios del plan

Devuelve todos los directorios de plataformas de publicación del plan de la cuenta, con su ID, URL y países admitidos.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Este endpoint no recibe parámetros.

Respuestas

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.
Response
{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Devuelve todos los sitios de directorio de las plataformas de publicación incluidos en el plan asociado a la cuenta actual. Cada entrada tiene un id entero, un name para mostrar, la url del sitio, la lista de códigos de país ISO que acepta el sitio (supportedCountries) y los países en los que se respeta el indicador de ocultar la dirección / área de servicio (hideAddressSupportedCountries).

Caso de uso: crear un selector de ID de sitio válidos. Antes de habilitar o deshabilitar plataformas de publicación para una ubicación, llama a este endpoint para conocer los ID numéricos de sitio que existen para el plan. Solo los ID devueltos aquí son válidos para pasarlos a otras partes de la API. Asocia id con name/url para mostrar una pantalla de configuración de envíos legible para las personas.

Caso de uso: comprobar previamente el país de una ubicación. Filtra la respuesta para seleccionar los sitios cuyo supportedCountries incluya el countryIso de la ubicación, de modo que solo ofrezcas plataformas de publicación que realmente acepten la ficha. Para los negocios con área de servicio, consulta también hideAddressSupportedCountries para comprobar dónde se puede ocultar la dirección.

Aspectos que debes tener en cuenta.

  • Esta lista está limitada al plan y no tiene paginación: devuelve el catálogo completo de sitios del plan en una sola respuesta, por lo que no hay cursor. Prevé decenas de entradas y guarda el resultado en caché en lugar de llamar al endpoint en cada solicitud.
  • supportedCountries y hideAddressSupportedCountries pueden contener más de 50 códigos ISO cada uno; el ejemplo anterior está truncado.
  • Comparte el límite de solicitudes de la cuenta; si recibes un 429, respeta la cabecera Retry-After.
Request
curl -X GET 'https://listingsapi.com/api/v4/plan-sites' \  -H "Authorization: API $LISTINGSAPI_KEY"
Run in playground