API digitação antecipada para Rapid

Ofereça sugestões aos viajantes enquanto eles pesquisam.

Typehead (GET /suggestions) é um novo endpoint de API que permite oferecer aos viajantes uma experiência de busca sugestiva com base em regiões geográficas, locais relevantes e propriedades disponíveis. Este endpoint retorna uma lista de sugestões com base em strings de pesquisa parciais e quaisquer parâmetros de solicitação inseridos. Por favor, entre em contato com seu gerente de conta para adicionar digitação antecipada à sua conta.

Como funciona

A API digitação antecipada é uma ferramenta de previsão de idioma — às vezes chamada de autocompletar ou sugestão automática. Retorna uma lista de regiões, locais ou propriedades com base em informações parciais digitadas em uma caixa de pesquisa. Quando o usuário digitar em uma caixa de pesquisa, a API digitação antecipada começará a retornar até 10 resultados usando informações de cidade, região, propriedade ou código postal. O viajante pode então selecionar uma opção dessa lista para iniciar a busca ou continuar digitando para refinar os resultados sugeridos automaticamente.

Por exemplo, uma pesquisa que começa com "Memp" mostraria várias opções geográficas, incluindo bairros, estações de trem, aeroportos, etc., relacionados a Memphis, Tennessee, EUA, seguidos por Memphis, Missouri, EUA.

Guia de lançamento

Você precisará entrar em contato com seu gerente de contas ou representante do Partner Connect para obter informações sobre a API. Eles solicitarão aprovação de acesso e, se aprovado, alterarão seu contrato para incluir digitação antecipada. Assim que o recurso digitação antecipada for ativado para sua organização, o representante do Partner Connect lhe dará suporte em qualquer desenvolvimento necessário.

Requisitos de lançamento:

Você deve adotar e usar o processo de token de acesso opaco para autenticação.
Os tokens de acesso só podem ser usados pelo mesmo ID de circuito ou chave de API que os solicitou.
Os tokens de acesso só podem ser usados por 25 minutos.
As solicitações de novos tokens de acesso devem ser configuradas para serem atualizadas de forma consistente, seguindo esse cronograma, e não com muita frequência.
O idioma e o texto da solicitação são parâmetros obrigatórios. Consulte a lista de idiomas suportados pelo Rapid .

Autorização e acesso

A API Rapid digitação antecipada está disponível para solicitação nos endpoints da API por parceiros que estejam atualmente na versão 3 do Rapid. Após a aprovação, seu perfil existente terá as permissões necessárias para usar a API com sucesso. Para obter mais informações sobre como autorizar sua API digitação antecipada, consulte a página de autorização OAuth 2.0.

Solicitações de preenchimento automático

Você precisará incluir algumas informações obrigatórias nos cabeçalhos da solicitação e nos parâmetros da consulta. Para tornar a resposta mais robusta, você também pode incluir parâmetros de consulta opcionais.

Cabeçalhos de solicitação

Obrigatório

Accept: especifica o formato de resposta que o cliente deseja receber. Esse valor deve ser application/json.
Accept-Encoding: especifica a codificação de resposta que o cliente gostaria de receber. Esse valor deve ser gzip.
User-Agent: uma string de cabeçalho da solicitação do cliente, conforme capturada pela sua integração. Se você estiver criando um aplicativo, o valor de User-Agentdeve ser {app name}/{app version}. Por exemplo,TravelNow/3.30.112.

Parâmetros de consulta

Obrigatório

language: especifica o idioma desejado para a resposta como um subconjunto do formato BCP47 que usa apenas pares hifenizados de código de idioma e país two-digit. Use apenas códigos de idioma ISO639-1 alpha 2 e códigos de país ISO3166-1 alpha 2 conforme descrito por w3.org (por exemplo, language=en-US). Consulte a lista de idiomas suportados pelo Rapid .
text: a string de entrada para consulta, com um limite de 150 caracteres (por exemplo, text=Springfie).

Opcional

type: descreve o local que o usuário está procurando. Este parâmetro pode ser fornecido várias vezes com valores diferentes (por exemplo, type=AIRPORT&type=CITY). Caso não seja fornecido, o padrão incluirá todos os tipos. Consulte a tabela de valores permitidos abaixo para ver as opções disponíveis.
line_of_businessEste parâmetro fornece heurísticas de pesquisa, e um valor válido garante que a resposta será mais relevante. Embora este parâmetro seja opcional, omiti-lo pode afetar os resultados da pesquisa, por isso definimos o padrão como properties. Consulte a tabela de valores permitidos abaixo para ver as opções disponíveis.
package_type: filtra pelos tipos de pacote especificados pelo usuário. Consulte a tabela de valores permitidos abaixo para ver as opções disponíveis.
feature: altera o cálculo dos resultados da sugestão. Os valores incluem hierarchy, nearby_airporte postal_code.
region_id: filtra os resultados para propriedades com a região especificada.
origin: especifica se o texto da consulta é uma origem em vez de um destino. A pesquisa padrão encontrará apenas destinos.
limit: especifica o número máximo de sugestões retornadas pela resposta. Esse valor deve estar entre 1 e 10 (por exemplo, limit=5). Caso esse parâmetro não seja fornecido, o valor padrão é 10.

Valores permitidos

type	line_of_business	package_type
`airport`	`properties` (padrão)	`flight_property`
`city`	`flights`	`flight_property_car`
`multi_city_vicinity`	`packages`	`flight_car`
`neighborhood`	`cars`	`property_car`
`point_of_interest`	`activities`
`airport_metro_code`
`multi_region`
`train_station`
`metro_station`
`address`
`property`
`bus_station`

Nota: Quaisquer valores não incluídos na tabela acima resultarão em um erro.

Solicitações de dados

Depois de obter o access_token, você configurará a solicitação GET.

Exemplo de solicitação

GET - https://api.ean.com/v3/suggestions?language=en-US&line_of_business=properties&limit=3&text=chicago&type=city&type=neighborhood 

Header : 
Authorization: Bearer {{access_token}}

Exemplo de resposta

[
  {
    "related_id": "4477519",
    "type": "airport",
    "name": "Chicago, IL (ORD-O'Hare Intl.)",
    "name_full": "Chicago, IL, United States of America (ORD-O'Hare Intl.)",
    "name_display": "<B>Chicago</B>, IL, United States of America (ORD-O'Hare Intl.)",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "ORD",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.976977,
      "longitude": -87.90481
    }
  },
  {
    "related_id": "829",
    "type": "city",
    "name": "Chicago",
    "name_full": "Chicago, Illinois, United States of America",
    "name_display": "<B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.878113,
      "longitude": -87.629799
    }
  },
  {
    "related_id": "6350699",
    "type": "neighborhood",
    "name": "Downtown Chicago",
    "name_full": "Downtown Chicago, Chicago, Illinois, United States of America",
    "name_display": "Downtown <B>Chicago</B>, <B>Chicago</B>, Illinois, United States of America",
    "country_code": "US",
    "country_code_3": "USA",
    "iata_airport_code": "CHI",
    "iata_airport_metro_code": "CHI",
    "coordinates": {
      "latitude": 41.885969845574834,
      "longitude": -87.62933540465228
    }
  }
]

Códigos de erro

A API digitação antecipada compartilha códigos de erro comuns com as outras APIs Rapid. Todos esses códigos estão detalhados em nossa página de Respostas de erros comuns .

Interagindo com outras APIs do Rapid

Quando o usuário digita um texto na barra de pesquisa, a API digitação antecipada extrai as informações da região (ID da região, nome, coordenadas, etc.) ou da API propriedade, dependendo da pesquisa designada.type. A API exibe então essas informações como resultados na lista de preenchimento automático.

Quando o usuário seleciona uma região na lista de autocompletar, a API de Região é chamada para obter uma lista propriedade em torno dessa região. Utilize os IDs propriedade retornados por essa pesquisa para chamar a API da Loja, obter a disponibilidade e exibir as propriedades na lista.

Se o usuário selecionar propriedade na lista de preenchimento automático, a API de Compras gerará uma página de detalhes com informações sobre a disponibilidade e o conteúdo de propriedade.

Detalhes da API

Explore as definições dos pontos de extremidade relacionados nesta página e use o API Explorer ou outro software de teste para comparar os exemplos e as definições de esquemas com o resultado real.

Recursos adicionais

Se você deseja experimentar todos os endpoints do Rapid API, baixar suas especificações OpenAPI ou nossa coleção Postman, temos o que você precisa.