Documentación

# Place Fields

Una vez que tenga un place_id de un lugar, puede solicitar más detalles sobre un establecimiento o punto de interés en particular iniciando una solicitud de Place Fields. Una solicitud de Place Fields devuelve información más completa sobre el lugar indicado, como su dirección completa, número de teléfono.

# Solicitudes de Place Fields

Una solicitud de Place Fields es una URL HTTP con el siguiente formato:

https://apis.geodir.co/places/fields/v1/**output**?**parameters**

donde output puede ser cualquiera de los siguientes valores:

  • json (recomendado) indica la salida en Notación de Objetos JavaScript (JSON); o
  • xml indica salida en XML

Algunos parámetros son obligatorios mientras que otros son opcionales. Como es estándar en las URL, los parámetros se separan mediante el carácter comercial (&).

Parámetros obligatorios en una solicitud de Place Fields:

  • place_id: un identificador textual que identifica de forma única un lugar, devuelto de un lugar. Para obtener más información sobre los ID de Places, consulte la descripción general de ID de Places
  • key: la clave API de su aplicación. Esta clave identifica su aplicación a los efectos de la gestión de cuotas. Obtén información sobre cómo Obtener tu clave de API.

# Campos

# Ejemplos de Place Fields

El siguiente ejemplo solicita los detalles de un lugar por place_id e incluye los campos de nombre y teléfono:

Esta solicitud demuestra el uso de la marca JSON output:

https://apis.geodir.co/places/fields/v1/json?place_id=6bf0e3e686f1db678ba68c38ce7d98427e&key=YOUR_KEY

Vea a continuación la respuesta JSON:

{
    "status": "OK",
    "category": [
        "route_number",
        " geocode"
    ],
    "address_segments": [
        {
            "name": "1597",
            "name_abbr": "1597",
            "types": [
                "route_number"
            ]
        },
        {
            "name": "San Carlos",
            "name_abbr": "San Carlos",
            "types": [
                "route"
            ]
        },
        {
            "name": "Jirón",
            "name_abbr": "Jr",
            "types": [
                "route_type"
            ]
        },
        {
            "name": "Lima",
            "name_abbr": "Lima",
            "types": [
                "admin_level_1",
                "political"
            ]
        },
        {
            "name": "15",
            "name_abbr": "15",
            "types": [
                "admin_level_1_code",
                "political"
            ]
        },
        {
            "name": "Lima",
            "name_abbr": "Lima",
            "types": [
                "admin_level_2",
                "political"
            ]
        },
        {
            "name": "1501",
            "name_abbr": "1501",
            "types": [
                "admin_level_2_code",
                "political"
            ]
        },
        {
            "name": "El Agustino",
            "name_abbr": "El Agustino",
            "types": [
                "admin_level_3",
                "political"
            ]
        },
        {
            "name": "150111",
            "name_abbr": "150111",
            "types": [
                "admin_level_3_code",
                "political"
            ]
        },
        {
            "name": "El Agustino Zona 4",
            "name_abbr": "El Agustino Zona 4",
            "types": [
                "sublocality",
                "political"
            ]
        },
        {
            "name": "Pueblo Joven",
            "name_abbr": "Pjj",
            "types": [
                "sublocality_type"
            ]
        },
        {
            "name": "Perú",
            "name_abbr": "PE",
            "types": [
                "country",
                "political"
            ]
        },
        {
            "name": "15006",
            "name_abbr": "15006",
            "types": [
                "postal_code"
            ]
        }
    ],
    "standard_address": "Jirón San Carlos 1597, El Agustino, Lima, Perú",
    "geometry": {
        "coordinates": {
            "lat": -12.0447283,
            "lon": -76.9998987
        }
    },
    "place_id": "NTk1MmE1NjEtZDViNS01NGIwLWE5OGUtYmEzZGE5NjM0OTcz",
    "hours": "",
    "phone": ""
}

# Códigos de Estado

El campo "status" dentro del objeto de respuesta de lugar contiene el estado de la solicitud y puede contener información de depuración para ayudarlo a rastrear por qué falla la solicitud de lugar. El campo "status" puede contener los siguientes valores:

  • "OK" indica que no se produjeron errores; el lugar se analizó correctamente y se devolvió al menos un código geográfico.
  • "ZERO_RESULTS" indica que la ubicación referenciada (place_id) era válida pero ya no se refiere a un resultado válido. Esto puede ocurrir si el establecimiento ya no está en funcionamiento.
  • "OVER_QUERY_LIMIT" indica cualquiera de los siguientes:
    • Has superado los límites.
    • La facturación no se ha habilitado en su cuenta.
    • El método de pago proporcionado ya no es válido (por ejemplo, una tarjeta de crédito ha caducado).
  • "REQUEST_DENIED" indica que su solicitud fue denegada, generalmente porque el parámetro clave no es válido.
  • "INVALID_REQUEST" generalmente indica que falta la consulta (place_id).
  • "UNKNOWN_ERROR" indica un error del lado del servidor; intentarlo de nuevo puede tener éxito.
  • "NOT_FOUND" indica que la ubicación de referencia (place_id) no se encontró en la base de datos de Places.

# Resultados de Place Fields

Cuando el servicio de Places devuelve resultados de una solicitud de campos, los coloca dentro de un único result. Dado que los resultados de los datos de lugares no pueden estar vacíos, solo se devuelven los resultados de lugares con datos. Cada resultado puede contener los siguientes campos:

  • address_segments[] es una matriz que contiene los segmentos separados aplicables a esta dirección. Cada segmento de dirección normalmente contiene los siguientes campos:
    • types[] es una matriz que indica el de los segmentos de dirección. Consulte la lista de tipos admitidos.
    • name es la descripción de texto completo o el nombre del componente de dirección como lo devuelve el API de Places.
    • name_abbr es un nombre textual abreviado para el componente de dirección, si está disponible. Por ejemplo, un segmento de dirección para el país de Perú puede tener un name de "Perú" y un name_abbr de "PE" usando la abreviatura de 2 letras.

Tenga en cuenta los siguientes datos sobre la matriz address_segments[]:

  • La matriz de segmentos de dirección puede contener más segmentos que standard_address
  • La matriz no incluye necesariamente todas las entidades políticas que contienen una dirección, además de las incluidas en standard_address. Para recuperar todas las entidades políticas que contienen una dirección específica, debe utilizar la API de Reverse Geocoding, pasando la latitud / longitud de la dirección como parámetro a la solicitud.
  • No se garantiza que el formato de la respuesta siga siendo el mismo entre solicitudes. En particular, la cantidad de address_segments varía según la dirección solicitada y puede cambiar con el tiempo para la misma dirección. Un componente puede cambiar de posición en la matriz. El tipo de segmento puede cambiar. Es posible que falte un segmento en particular en una respuesta posterior.
  • standard_address es una cadena que contiene la dirección legible por humanos de este lugar. A menudo, esta dirección es equivalente a la "dirección postal".
  • geometry contiene información de geometría sobre el resultado, que generalmente incluye la ubicación (geocodificación) del lugar y (opcionalmente) el bbox que identifica su área general de cobertura.
  • phone contiene el número de teléfono del lugar en formato internacional. El formato internacional incluye el código del país y tiene como prefijo el signo más (+).
  • hours: contiene la información de los períodos de apertura.
  • place_id un identificador textual que identifica un lugar de forma única. Para recuperar información sobre el lugar, transfiera este identificador en el campo place_id de una solicitud de la API de Places. Para obtener más información sobre los ID de Places, consulte la descripción general de los ID de Places.
  • type[] contiene una matriz de tipos de características que describen el resultado dado. Consulte la lista de tipos admitidos. Las respuestas XML incluyen varios elementos de tipo si se asigna más de un tipo al resultado.
Ultima actualizacion: 18/09/2023, 10:30:49 p. m.

← Place Autocomplete →