GET/api/v4/locations/{locationId}/photos

Obtener fotos de una ubicación

Devuelve todos los archivos multimedia adjuntos a una única ubicación, incluidas las fotos con y sin estrella.

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

Parámetros

Ruta

NombreTipoObligatorioDescripción
locationIdstringobligatorioThe location's Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). The raw numeric database ID (`1800289`) is also accepted, and so is a percent-encoded value such as `...%3D%3D`.

Respuestas

200Array of media files for the location. Returns an empty array when the location has no photos.
Response
{  "data": {    "mediaFilesOfLocation": [      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzE=",        "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/f47d62a6.jpg",        "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_f47d62a6.jpg",        "categoryName": "Logo",        "categoryId": "4",        "fileType": "image",        "starred": false,        "viewsCount": 0      },      {        "id": "TWVkaWFGaWxlOjU4Nzg5MzI=",        "url": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg",        "thumbnailUrl": "https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_ef4ffb12.jpg",        "categoryName": "Additional",        "categoryId": "12",        "fileType": "image",        "starred": true,        "viewsCount": 143      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Devuelve todos los archivos multimedia adjuntos a una ubicación: logotipo, portada e imágenes adicionales, con el url público de cada archivo, su thumbnailUrl, su categoría, si es starred y un viewsCount acumulado durante toda su existencia.

Caso de uso: mostrar la galería de fotos de una ubicación. Obtén la lista de archivos multimedia para mostrar las imágenes que un negocio ya tiene publicadas, usando thumbnailUrl para la cuadrícula y url para la vista a tamaño completo. starred te indica qué fotos adicionales están fijadas para que se muestren de forma prioritaria en las plataformas de publicación compatibles.

Caso de uso: auditar la cobertura multimedia antes de subir un archivo. Llama primero a este endpoint para comprobar si a una ubicación le falta una imagen de la categoría Logo o Cover y, después, sube solo lo que falte. Los valores de id devueltos son exactamente los que debes pasar a los endpoints para marcar con estrella y eliminar.

Aspectos que debes tener en cuenta.

  • Cualquiera de las formas de id funciona en la ruta: 1800289, TG9jYXRpb246MTgwMDI4OQ== y TG9jYXRpb246MTgwMDI4OQ%3D%3D corresponden a la misma ubicación. Si el valor no corresponde a ninguna de estas formas, el endpoint devuelve HTTP 200 con un array errors que contiene SY90002: Invalid Id y una carga útil null.
  • Una ubicación sin archivos multimedia devuelve { "data": { "mediaFilesOfLocation": [] } }; esta es la respuesta real para una ubicación recién creada, como "Jenny Home", y no un error.
Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/photos' \  -H "Authorization: API $LISTINGSAPI_KEY"