Introdução aos links
O que é um link?
A Rapid API é composta por vários recursos de API que permitem criar uma experiência de reserva completa para os seus viajantes. Isso significa que você vai usar esses recursos em sequência para criar transações completas, como busca, verificação de preços, reserva e gerenciamento de reservas.
Para simplificar essas transações com vários passos, a Rapid API emprega uma ferramenta avançada chamada Link.
Um Link é uma referência a um recurso relacionado, que funciona como um guia e direciona desenvolvedores ao próximo recurso relevante da API necessário para avançar na transação com facilidade.
Ao utilizar os links de operações anteriores no SDK da Rapid, desenvolvedores podem criar e executar novas operações com rapidez, evitando o processo típico de configuração e aumentando a eficiência de maneira significativa.
Observação
Esse recurso está disponível no rapid-sdk v4.3.0 e versões posteriores.
Por que usar um link?
Um Link é uma maneira prática de navegar pelas operações da Rapid API, sem precisar fazer a criação manual da próxima operação. Você pode extrair um Link da resposta da operação anterior e usar para criar a próxima operação.
Os benefícios de usar um link são:
Economia de tempo: você não precisa configurar os parâmetros de solicitação e a operação para criar a próxima operação de maneira manual.
Processo simplificado: você pode navegar com facilidade pelas operações da Rapid API usando o
Linkda operação anterior, sem precisar fazer a extração manual das informações necessárias.Menos erros: ao usar o
Link, você evita erros que podem ocorrer durante a criação manual da próxima operação.
Como usar um link?
Para obter um Link, ele precisa ser extraído da resposta da Operation anterior. Depois, você pode criar a próxima Operation a partir do Link e executar essa operação com o RapidClient.
Por exemplo, você pode criar um Link a partir da resposta de uma GetAvailabilityOperation e usar esse link na criação de uma PriceCheckOperation:
// 1. Create and execute the GetAvailabilityOperation (The first operation)
GetAvailabilityOperation getAvailabilityOperation = new GetAvailabilityOperation(getAvailabilityOperationParams);
Response<List<Property>> propertiesResponse = rapidClient.execute(getAvailabilityOperation);
// 2a. Select the needed property from the response (Here, we select the first property)
Property property = propertiesResponse.getData().get(0);
// 2b. Make sure the property is an instance of PropertyAvailability
if (!(property instanceof PropertyAvailability)) {
return;
}
PropertyAvailability propertyAvailability = (PropertyAvailability) property;
// 3a. Extract the priceCheck link from PropertyAvailability operation (Here, we select the first rate for the first room, then get the priceCheck link)
Link priceCheckLink = propertyAvailability.getRooms().get(0).getRates().get(0).getBedGroups().entrySet().stream().findFirst().get().getValue().getLinks().getPriceCheck();
// 3b. Create the needed context for the PriceCheckOperation
PriceCheckOperationContext priceCheckOperationContext = PriceCheckOperationContext.builder().customerIp("1.2.3.4").build(); // fill the context as needed
// 4. Create and execute the PriceCheckOperation using the Link
PriceCheckOperation priceCheckOperation = new PriceCheckOperation(priceCheckLink, priceCheckOperationContext);
Response<RoomPriceCheck> roomPriceCheckResponse = rapidClient.execute(priceCheckOperation);
// ...Outro exemplo seria criar um Link a partir da resposta de uma PriceCheckOperation e usar na criação de uma reserva.
// 1. Get the RoomPriceCheck from the previous step
RoomPriceCheck roomPriceCheck = roomPriceCheckResponse.getData(); // from the previous step
// 2a. Extract the Link from the RoomPriceCheck
Link postItineraryLink = roomPriceCheck.getLinks().getBook();
// 2b. Create the needed context for the PostItineraryOperation
PostItineraryOperationContext postItineraryOperationContext = PostItineraryOperationContext.builder().customerIp("1.2.3.4").build(); // fill the context as needed
// 2c. Create the CreateItineraryRequest
CreateItineraryRequest createItineraryRequest = CreateItineraryRequest.builder().build(); // fill the request as needed
// 3. Create and execute the PostItineraryOperation using the Link
PostItineraryOperation postItineraryOperation = new PostItineraryOperation(postItineraryLink, postItineraryOperationContext, createItineraryRequest);
// 4. Execute the PostItineraryOperation
Response<ItineraryCreation> itineraryCreationResponse = rapidClient.execute(postItineraryOperation);
ItineraryCreation itineraryCreation = itineraryCreationResponse.getData();Para mais exemplos sobre como usar um Link, consulte a seção Exemplos de uso.