Introdução ao Sandbox

Acesse e configure o modo sandbox para testar a sua API com segurança

Acessar o recurso Sandbox

Faça login no console do Expedia Group e selecione uma conta. Na primeira vez em que você acessar o recurso Sandbox, vamos criar uma conta que espelha a conta de parceiro que você usou para fazer o acesso.

Existem duas maneiras de entrar no modo sandbox.

1. Usar o botão de alternância global

Acesse o menu da conta de parceiro clicando no nome da sua conta no canto inferior esquerdo.

No submenu da conta, clique no botão de alternância do modo Sandbox para ativá-lo.

Acesse o catálogo de produtos para adicionar o produto que deseja experimentar. Observação: no modo sandbox, somente produtos ativados para sandbox aparecem no catálogo de produtos.

Depois de adicionar o produto, você pode criar um cliente de API específico para sandbox e usar essas credenciais em nosso API Explorer, no Postman ou em outras ferramentas para verificar se os resultados são os esperados. No modo sandbox, as credenciais da API que você cria não afetam o seu aplicativo de produção. Dessa forma, você pode ajustar a configuração antes de ativá-la.

Quando quiser voltar para o modo on-line, alterne o botão no submenu da conta para a posição desativado.

2. Experimentar um produto a partir da página de informações

Acesse o catálogo de produtos e encontre um produto do seu interesse. Os produtos ativados para sandbox estão marcados com um selo.

Clique no cartão de um produto ativado para sandbox, e você será direcionado para a página de informações dele. Clique no botão Try product, na parte superior da página, para alternar para o modo sandbox. Você deve então configurar a conta de sandbox para alinhar à sua conta do Expedia Group.

Crie um cliente de API específico para sandbox para o produto que deseja experimentar e use as credenciais em nosso API Explorer, no Postman ou em outras ferramentas para verificar se os resultados são os esperados. No modo sandbox, as credenciais da API que você cria não afetam o seu aplicativo de produção. Dessa forma, você pode ajustar a configuração antes de ativá-la. Observação: no modo sandbox, somente produtos ativados para sandbox aparecem no catálogo de produtos.

Quando quiser voltar para o modo on-line, clique no link Go to live mode ou volte para o menu flutuante da conta para usar o botão de alternância global.

Configurar produtos no sandbox

Configuração inicial

Clique em Try product na página de detalhes de um produto ativado para sandbox para iniciar a configuração no modo sandbox.

Atualizações

Use o botão de alternância global para abrir a sua conta de sandbox.
Acesse a página de detalhes do produto que deseja atualizar.
Abra o menu de contexto (os três pontos verticais no canto superior direito) e selecione Update configuration para iniciar o fluxo de configuração.

Observação: esse menu de contexto também está disponível para a sua conta. Por isso, verifique se mudou para a sua conta de sandbox para evitar erros. Você vai precisar atualizar de modo manual a configuração ativa com as suas opções de sandbox.

Criação do cliente de API

Para usar as APIs da plataforma de viagens do Expedia Group, seja em modo sandbox ou on-line, você deve criar um ou mais clientes de API, que são como contas de usuário protegidas por senha. Em resumo, um cliente de API estabelece que o software que faz uma solicitação da API pertence a você (autenticação) e permite limitar os tipos de solicitações de API que cada cliente pode fazer (autorização). Existem duas maneiras de criar um cliente de API:

Clique no menu de contexto na página de informações do produto e selecione Create API client.
Clique em Create API client no menu de navegação à esquerda.

Na página de criação de um cliente de API, insira um nome e uma descrição que ajudem você e outras pessoas na sua organização a lembrar quais produtos ele inclui. Na lista de produtos disponíveis, selecione os escopos, ou seja: os tipos de solicitação de API que deseja incluir. Observação: marcar a caixa no nível superior seleciona todos os elementos secundários.

Clique em Create.

Depois de criar o cliente de API, você vai ver uma tela de confirmação que inclui o ID e segredo da sua credencial. Eles só aparecem uma vez. Copie as credenciais e o segredo e guarde-os em um local seguro. Não armazene o seu ID de cliente nem o segredo em áreas de acesso público, como GitHub, códigos do lado do cliente etc.

Produtos e escopos

Todos os clientes de API funcionam em uma mesma conta de parceiro. Os produtos adicionados à conta ficam disponíveis para serem incluídos em um cliente de API. É possível criar um único cliente de API com acesso a um ou mais produtos.

Cada produto inclui um conjunto de escopos que concedem acesso a determinados tipos de solicitação. Os escopos que você atribui definem o que o cliente tem autorização para fazer. Se você tem vários serviços de software fazendo solicitações de API, é recomendável criar um cliente de API separado para cada serviço e selecionar apenas os escopos necessários para cada cliente.

Visualização e ajuste de um cliente de API para sandbox

Depois de criar um cliente de API para o seu produto com sandbox, acesse a página do API Explorer do produto que deseja testar no Developer Hub. Altere o URL do servidor de API para apontar para o seu sandbox e insira as suas credenciais seguras.

Com o nosso API Explorer, o Postman ou outras ferramentas de API, você pode ver os resultados que as configurações do cliente de API vão retornar. Use esse recurso desde o início para descobrir se as nossas APIs são adequadas para você e testar quaisquer alterações nas suas configurações antes de enviar um dos nossos produtos para um aplicativo de produção.

Ativação da API

Depois de concluir os testes no modo sandbox, você pode criar uma versão ativa do cliente de API para usar no seu aplicativo de produção.

Faça login no console.
No catálogo de produtos, acesse a página de informações do produto que deseja adicionar.
Clique em Add product (ou, se o produto exigir aprovação, clique em Request add).
Configure o produto. Muitas vezes, as configurações ativas imitam muitas ou a maioria das configurações que você usou nos testes de sandbox.
Clique em Submit.
Crie o seu cliente de API ativo: clique em Create API client no menu de navegação à esquerda.
De modo geral, você deve usar os mesmos escopos do sandbox.
Clique na opção para conseguir credenciais.

Observação: quando você adiciona um produto, a equipe da Expedia pode entrar em contato com você para obter informações adicionais.

Você também pode solicitar a ativação diretamente de um sandbox: procure os links Go to live mode.

Para saber como incorporar um cliente de API no seu software, consulte Autenticação e autorização de APIs.