APIs de consulta

Um método GET que permite consultar os POIs mais próximos do chamador.

Solicitação

GET https://query.places.adobe.com/placesedgequery

Com a seguinte entrada, o serviço retorna uma lista dos POIs mais próximos do chamador:

  • A posição do chamador (latitude, longitude).

  • As IDs das bibliotecas POI a serem incluídas na pesquisa.

  • O número máximo de POIs a serem retornados. O valor padrão é 100.

    A distância entre o chamador e o POI é definida como a distância do chamador até a borda da geofence do POI. Na resposta, os POIs que contêm o chamador serão marcados como tendo ele.

Os argumentos são fornecidos como os seguintes parâmetros de consulta:

  • (Obrigatório) latitude

    A latitude do chamador, que deve ser entre -85 e 85.

  • (Obrigatório) longitude

    A longitude do chamador, que deve estar entre -180 e 180.

  • (Opcional) limit

    O número máximo de POIs a serem retornados.

  • (Obrigatório) library

    A ID da biblioteca para consulta. Para consultar várias bibliotecas, inclua várias cópias do parâmetro de biblioteca na consulta.

Este é um exemplo do formato JSON retornado com êxito:

{
    "places": {
        "userWithin": [
            {
                "p": [
                    "poi id",
                    "poi name",
                    "poi center's latitude",
                    "poi center's longitude",
                    poiRadius,
                    rank
                ],
                "x": {
                    "country": "US",
                    "city": "Fremont",
                    "street": "Vineyard Heights",
                    "Color": "Blue",
                    "state": "CA",
                    <other POI metadata>
                }
            }
        ],
        "pois": [
            {
                "p": [
                    "poi id",
                    "poi name",
                    "poi center's latitude",
                    "poi center's longitude",
                    poiRadius,
                    rank
                ],
                "x": {
                    "country": "US",
                    "city": "Milpitas",
                    "street": null,
                    "state": "CA"
                }
            },
            {
                "p": [
                    "poi id",
                    "poi name",
                    "poi center's latitude",
                    "poi center's longitude",
                    poiRadius,
                    rank
                ],
                "x": {
                    "country": "US",
                    "city": "Fremont",
                    "street": null,
                    "state": "CA"
                }
            }
        ]
    }
}

POIs em places.pois são classificados por distância do chamador até a borda dos POIs. POIs em places.userWithin contém o chamador e esses POIs são ordenados por classificação e, em seguida, por raio crescente.

Exemplo de chamada

Veja um exemplo da chamada:

GET https://query.places.adobe.com/placesedgequery?latitude=<userLatitude>&longitude=<userLongitude>&library=<libID1>&library=<libID2>&limit=20

Nesta página