Orientação ao cliente sobre virtualização de sandbox de API
O que é virtualização de sandbox?
A virtualização de sandbox de API é um serviço que simula o comportamento de uma instância de sandbox em tempo real. Nosso serviço virtualizado proporciona uma experiência consistente onde a resposta que você recebe é predefinida e nem sempre varia conforme os valores de entrada específicos inseridos por você.
Veja abaixo um exemplo. Digamos que você faz várias chamadas com a mesma solicitação de tarifa e altera as localizações do remetente e do destinatário a cada teste. A API retornará a mesma resposta de tarifa predefinida, seja qual for a alteração de endereço. Os valores podem não ser correspondentes, mas a estrutura da resposta simula o seu cenário no ambiente em tempo real.
Como o serviço virtualizado não acessa os componentes do sistema de backend em tempo real, seu teste de integração está protegido contra dependências de backend, e você ainda recebe a resposta adequada.
Por que o FedEx Sandbox é virtualizado?
Em um sistema complexo e interdependente como a FedEx, infelizmente há alguns poucos casos em que um recurso dependente se torna indisponível e a disponibilidade do sistema sofre. Quando esses incidentes ocorrem, mesmo sendo remotos, pode haver um impacto negativo em seus testes de integração da API. Existem outras restrições em instâncias em tempo real que também podem restringir a extensão dos seus testes de integração. Alguns exemplos são:
- Conta de remessa não tendo acesso necessário para testar determinados cenários específicos.
- Disponibilidade de dados de teste limitada.
- Tempo de inatividade do sistema planejado ou não planejado.
Como posso usar a instância de sandbox virtualizada?
- Conheça a documentação, os endpoints e o método de autenticação da API. Isso ajudará a criar testes eficientes.
- Baixe e familiarize-se com a coleção JSON API fornecida sob a documentação da API.
- Escolha e teste transações de amostra que sejam apropriadas aos seus cenários de uso. Para obter uma experiência consistente, evite alterar a estrutura do payload da solicitação para que você receba a resposta virtualizada.
- Nem todos os valores de entrada afetam a resposta. Dedique-se a entender como o seu aplicativo processa as respostas consistentes.
- Teste todas as APIs para verificar se o comportamento está correto de acordo com a documentação. Inclua casos de teste positivos e negativos.
- Use os casos de teste negativos fornecidos para saber como as mensagens de erro e os códigos de status são retornados. Isso ajudará a determinar como seu aplicativo deve lidar com os erros. Consulte a coleção JSON API e os casos de teste com o prefixo adicionado como “Negativo”.
Benefícios da virtualização
- Menor probabilidade da indisponibilidade do recurso.
- Menos dependência de dados de teste.
- Resposta mais rápida em comparação com a instância de sandbox em tempo real.
- Não é necessário o acesso explícito em nível de conta para os serviços especiais.
- Experiência contínua de integração que facilita o processo de teste e certificação.
Perguntas frequentes
- Como fazer o payload de solicitação chegar à resposta virtualizada?
Cada documentação da API tem a coleção JSON API sendo fornecida. Consulte o Catálogo de API e abra a documentação da API. Procure a seção “Coleção JSON API” na documentação da API. Essa coleção JSON API tem todos os payloads de solicitações que foram salvos e que podem recuperar a resposta virtualizada. - Preciso obter o token para acessar a instância de sandbox virtualizada?
Sim, a geração e autorização do token funcionarão como de costume e você deve inserir o token para cada transação que interage com o serviço de sandbox virtualizado. - Como sei se a resposta é retornada de um serviço virtualizado?
A resposta virtualizada apresenta o alerta abaixo como parte do payload.
- Por que meu endereço no payload da solicitação não é validado na API de tarifa e tempos de trânsito?
A validação de endereço não faz parte da lógica que deriva uma resposta de tarifa virtualizada. Somente o país é validado para que você possa especificar qualquer valor nos demais campos de endereço. - Todas as APIs são virtualizadas?
Somente as APIs a seguir foram virtualizadas até o momento. Ainda estamos trabalhando para virtualizar o restante dos recursos de API.
API de tarifa e tempos de trânsito | Virtualizada |
API de rastreamento | Virtualizada |
API de carga parcial (LTL) – Recurso de tarifa e coleta | Virtualizada |
API de validação de endereço | Virtualizada |
API de validação de código postal | Virtualizada |
API de solicitação de coleta | Virtualizada |
API de disponibilidade de serviços | Virtualizada |
API de comércio global | Virtualizada |
API de fechamento do dia no Ground | Virtualizada |
API de remessa aberta | Virtualizada |
API de envio | Virtualizada |
API de pesquisa de localidade FedEx | Virtualizada |