Search - Post Search Address Batch

Use para enviar um lote de consultas para a API de Endereço Pesquisa em uma única solicitação assíncrona.
A Post Search Address Batch API é uma solicitação HTTP POST que envia lotes de consultas para Pesquisa API de Endereço em uma única chamada à API síncrona. Você pode chamar Pesquisa API do Lote de Endereços para ser executada de forma assíncrona (assíncrona) ou síncrona (sincronização). A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API até 100 consultas.

Enviar solicitação de lote síncrona

A API síncrona é recomendada para solicitações em lotes leves. Quando o serviço receber uma solicitação, ele responderá assim que os itens do lote forem calculados e não haverá possibilidade de recuperar os resultados posteriormente. A API síncrona retornará um erro de tempo limite (uma resposta 408) se a solicitação levar mais de 60 segundos. O número de itens de lote é limitado a 100 para essa API.

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Enviar Solicitação de Lote Assíncrona

A API assíncrona é apropriada para processar grandes volumes de solicitações de pesquisa relativamente complexas

• Ele permite a recuperação de resultados em uma chamada separada (vários downloads são possíveis).
• A API assíncrona é otimizada para confiabilidade e não se espera que haja um tempo limite.
• O número de itens de lote é limitado a 10.000 para essa API.

Quando você faz uma solicitação usando a solicitação assíncrona, por padrão, o serviço retorna um código de resposta 202 ao longo de uma URL de redirecionamento no campo Local do cabeçalho de resposta. Essa URL deve ser verificada periodicamente até que os dados de resposta ou as informações de erro estejam disponíveis. As respostas assíncronas são armazenadas por 14 dias. A URL de redirecionamento retorna uma resposta 404 se usada após o período de expiração.

Observe que a solicitação de lote assíncrona é uma operação de execução prolongada. Aqui está uma sequência típica de operações:

1. O cliente envia uma solicitação do Lote POST de Endereços Pesquisa para Azure Mapas.

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0&subscription-key={subscription-key}

2. O servidor responderá com um dos seguintes:

   HTTP 202 Accepted – A solicitação do Lote foi aceita.

   HTTP Error - Ocorreu um erro ao processar sua solicitação do Lote. Isso pode ser um 400 Bad Request ou qualquer outro Error código status.

3. Se a solicitação em lote foi aceita com êxito, o Location cabeçalho na resposta contém a URL para baixar os resultados da solicitação em lote. Este URI status é semelhante ao seguinte:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

4. O cliente emite uma GET solicitação na URL de download obtida na Etapa 3 para baixar os resultados do lote.

Corpo POST para solicitação de lote

Para enviar as consultas de endereço de pesquisa , você usará uma POST solicitação em que o corpo da solicitação conterá a batchItems matriz no json formato e o Content-Type cabeçalho será definido como application/json. Aqui está um corpo de solicitação de exemplo contendo 5 consultas de endereço de pesquisa :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Uma consulta de endereço de pesquisa em um lote é apenas uma URL parcial sem o protocolo, a URL base, o caminho, a api-version e a subscription-key. Ele pode aceitar qualquer um dos parâmetros de URI de endereço de pesquisa com suporte. Os valores de cadeia de caracteres na consulta de endereço de pesquisa devem ser escapados corretamente (por exemplo, " caractere deve ser escapado com \ ) e também deve ser codificado corretamente em URL.

A API assíncrona permite que o chamador lote até 10.000 consultas e sincronize a API até 100 consultas, e o lote deve conter pelo menos 1 consulta.

Baixar Resultados do Lote Assíncrono

Para baixar os resultados do lote assíncrono, você emitirá uma GET solicitação para o ponto de extremidade de download em lote. Essa URL de download pode ser obtida do Location cabeçalho de uma solicitação em lote bem-sucedida POST e se parece com o seguinte:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Esta é a sequência típica de operações para baixar os resultados do lote:

1. O cliente envia uma solicitação GET usando a URL de download.

2. O servidor responderá com um dos seguintes:

   HTTP 202 Accepted – A solicitação do Lote foi aceita, mas ainda está sendo processada. Tente novamente em algum tempo.

   HTTP 200 OK – Solicitação do Lote processada com êxito. O corpo da resposta contém todos os resultados do lote.

Modelo de resposta em lote

O conteúdo de dados retornado é semelhante para solicitações assíncronas e de sincronização. Ao baixar os resultados de uma solicitação em lote assíncrona, se o lote tiver concluído o processamento, o corpo da resposta conterá a resposta em lote. Essa resposta em lote contém um summary componente que indica o totalRequests que fazia parte da solicitação de lote original e, por successfulRequestsexemplo, consultas que foram executadas com êxito. A resposta em lote também inclui uma batchItems matriz que contém uma resposta para cada consulta na solicitação em lote. O batchItems conterá os resultados exatamente na mesma ordem em que as consultas originais foram enviadas na solicitação de lote. Cada item em batchItems contém statusCode campos e response . Cada response um em batchItems é de um dos seguintes tipos:

• SearchAddressResult - Se a consulta for concluída com êxito.

• Error - Se a consulta falhou. A resposta conterá um code e um message nesse caso.

Aqui está um exemplo de Resposta do Lote com 2 resultados bem-sucedidos e 1 com falha :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

AADToken

Esses são os fluxos Microsoft Entra OAuth 2.0. Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

subscription-key

Essa é uma chave compartilhada provisionada quando você cria uma conta Azure Mapas no portal do Azure ou usando o PowerShell, a CLI, os SDKs do Azure ou a API REST.

Com essa chave, qualquer aplicativo pode acessar toda a API REST. Em outras palavras, essa chave pode ser usada como uma chave master na conta em que elas são emitidas.

Para aplicativos expostos publicamente, nossa recomendação é usar a abordagem de aplicativos cliente confidenciais para acessar Azure Mapas APIs REST para que sua chave possa ser armazenada com segurança.

Tipo: apiKey
Em: query

SAS Token

Esse é um token de assinatura de acesso compartilhado criado a partir da operação Listar SAS no recurso Azure Mapas por meio do plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.

Com esse token, qualquer aplicativo está autorizado a acessar com controles de acesso baseados em função do Azure e controle refinado à expiração, taxa e regiões de uso para o token específico. Em outras palavras, o Token SAS pode ser usado para permitir que os aplicativos controlem o acesso de maneira mais segura do que a chave compartilhada.

Para aplicativos expostos publicamente, nossa recomendação é configurar uma lista específica de origens permitidas no recurso de conta do Mapa para limitar o abuso de renderização e renovar regularmente o Token SAS.

Tipo: apiKey
Em: header

Exemplos

An Address Geocoding Batch API call containing 5 Address Geocoding API queries

POST https://atlas.microsoft.com/search/address/batch/json?api-version=1.0

{
  "batchItems": [
    {
      "query": "?query=400 Broad St, Seattle, WA 98109&limit=3"
    },
    {
      "query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"
    },
    {
      "query": "?query=350 5th Ave, New York, NY 10118&limit=1"
    }
  ]
}

{
  "summary": {
    "successfulRequests": 3,
    "totalRequests": 3
  },
  "batchItems": [
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "400 broad st seattle wa 98109",
          "queryType": "NON_NEAR",
          "queryTime": 127,
          "numResults": 3,
          "offset": 0,
          "totalResults": 9,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/20843845",
            "score": 11.966,
            "address": {
              "streetNumber": "400",
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union, Lower Queen Anne",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "400 Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62039,
              "lon": -122.34928
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.62129,
                "lon": -122.35061
              },
              "btmRightPoint": {
                "lat": 47.61949,
                "lon": -122.34795
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 47.61982,
                  "lon": -122.34886
                }
              }
            ]
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388442",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, South Lake Union",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109",
              "extendedPostalCode": "981094612",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA 98109",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.62001,
              "lon": -122.34843
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61965,
                "lon": -122.34761
              },
              "btmRightPoint": {
                "lat": 47.62066,
                "lon": -122.349
              }
            }
          },
          {
            "type": "Street",
            "id": "US/STR/p0/388680",
            "score": 10.225,
            "address": {
              "streetName": "Broad Street",
              "municipalitySubdivision": "Seattle, Belltown",
              "municipality": "Seattle",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle",
              "countrySubdivisionCode": "WA",
              "postalCode": "98109,98121",
              "extendedPostalCode": "981094991,981211117,981211237,981213206",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Broad Street, Seattle, WA",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.61691,
              "lon": -122.35251
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.61502,
                "lon": -122.35041
              },
              "btmRightPoint": {
                "lat": 47.61857,
                "lon": -122.35484
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "one microsoft way redmond wa 98052",
          "queryType": "NON_NEAR",
          "queryTime": 169,
          "numResults": 2,
          "offset": 0,
          "totalResults": 3292,
          "fuzzyLevel": 2
        },
        "results": [
          {
            "type": "Street",
            "id": "US/STR/p0/1692663",
            "score": 10.225,
            "address": {
              "streetName": "Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "extendedPostalCode": "980526399,980528300",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63989,
              "lon": -122.12509
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.63748,
                "lon": -122.12309
              },
              "btmRightPoint": {
                "lat": 47.64223,
                "lon": -122.13061
              }
            }
          },
          {
            "type": "Cross Street",
            "id": "US/XSTR/p1/4779971",
            "score": 8.506,
            "address": {
              "streetName": "Microsoft Way & 157th Avenue Northeast, Microsoft Way",
              "municipality": "Redmond",
              "countrySecondarySubdivision": "King",
              "countryTertiarySubdivision": "Seattle East",
              "countrySubdivisionCode": "WA",
              "postalCode": "98052",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "Microsoft Way & 157th Avenue Northeast, Redmond, WA 98052",
              "countrySubdivisionName": "Washington"
            },
            "position": {
              "lat": 47.63962,
              "lon": -122.13061
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 47.64052,
                "lon": -122.13194
              },
              "btmRightPoint": {
                "lat": 47.63872,
                "lon": -122.12928
              }
            }
          }
        ]
      }
    },
    {
      "statusCode": 200,
      "response": {
        "summary": {
          "query": "350 5th ave new york ny 10118",
          "queryType": "NON_NEAR",
          "queryTime": 233,
          "numResults": 1,
          "offset": 0,
          "totalResults": 8032,
          "fuzzyLevel": 1
        },
        "results": [
          {
            "type": "Point Address",
            "id": "US/PAD/p0/48052000",
            "score": 14.334,
            "address": {
              "streetNumber": "350",
              "streetName": "5th Avenue",
              "municipalitySubdivision": "New York, Midtown South",
              "municipality": "New York, Manhattan",
              "countrySecondarySubdivision": "New York",
              "countryTertiarySubdivision": "Manhattan",
              "countrySubdivisionCode": "NY",
              "postalCode": "10118",
              "extendedPostalCode": "1011800",
              "countryCode": "US",
              "country": "United States Of America",
              "countryCodeISO3": "USA",
              "freeformAddress": "350 5th Avenue, NYC, NY 10118",
              "countrySubdivisionName": "New York"
            },
            "position": {
              "lat": 40.74817,
              "lon": -73.985
            },
            "viewport": {
              "topLeftPoint": {
                "lat": 40.74907,
                "lon": -73.98619
              },
              "btmRightPoint": {
                "lat": 40.74727,
                "lon": -73.98381
              }
            },
            "entryPoints": [
              {
                "type": "main",
                "position": {
                  "lat": 40.74808,
                  "lon": -73.98482
                }
              }
            ]
          }
        ]
      }
    }
  ]
}

Operation-Location: URL to download the results of the long-running batch request.

Definições

Address

O endereço do resultado

AddressRanges

Descreve o intervalo de endereços em ambos os lados da rua para obter um resultado de pesquisa. As coordenadas para os locais de início e término do intervalo de endereços estão incluídas.

BatchRequest

Esse tipo representa o corpo da solicitação do serviço do Lote.

BatchRequestItem

Objeto de solicitação em lote

BoundingBox

O visor que aborda o resultado representado pelas coordenadas superior esquerda e inferior direita do visor.

BoundingBoxCompassNotation

A caixa delimitadora do local.

Brand

A marca associada à POI

Classification

A classificação para a POI que está sendo retornada

ClassificationName

Nome da classificação

DataSources

Seção opcional. IDs de referência para uso com a API Obter Pesquisa Polígono.

Entity

Origem do tipo de entidade da caixa delimitadora. Para geocodificação reversa, isso é sempre igual à posição.

EntryPoint

O ponto de entrada para o POI que está sendo retornado.

EntryPointType

O tipo de ponto de entrada. O valor pode ser main ou secundário.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

GeographicEntityType

Tipo de entidade geography. Presente somente quando entityType foi solicitado e está disponível.

Geometry

Informações sobre a forma geométrica do resultado. Presente somente se o tipo == Geography.

JsonFormat

Formato desejado da resposta. Há suporte apenas para o formato json.

LatLongPairAbbreviated

Um local representado como latitude e longitude usando nomes curtos 'lat' & 'lon'.

MatchType

Tipos de correspondência para uma operação de pesquisa de endereço reverso.

OperatingHours

Horário de funcionamento de uma POI (Pontos de Interesse).

OperatingHoursTime

Representa uma data e hora

OperatingHoursTimeRange

Intervalo de tempo aberto por um dia

PointOfInterest

Detalhes da POI retornada, incluindo informações como nome, telefone, endereço de URL e classificações.

PointOfInterestCategorySet

Categoria POI

QueryType

O tipo de consulta que está sendo retornado: NEARBY ou NON_NEAR.

Response

O resultado da consulta. SearchAddressResult se a consulta tiver sido concluída com êxito, ErrorResponse caso contrário.

SearchAddressBatchItem

Um item retornado de Pesquisa chamada de serviço do Lote de Endereços.

SearchAddressBatchProcessResult

Esse objeto é retornado de uma chamada de serviço do Lote de Endereço Pesquisa bem-sucedida.

SearchAddressResultItem

Objeto de resultado para uma resposta da API de Pesquisa.

SearchAddressResultType

Um destes:

• POI
• Street
• Geografia
• Endereço de ponto
• Intervalo de Endereços
• Cruzamento

SearchSummary

Objeto summary para uma resposta da API Pesquisa.

Summary

Resumo dos resultados da solicitação em lote