Pular para o conteúdo principal

Ambiente de Sandbox do SAC

Introdução

O ambiente de sandbox do SAC permite testar a integração com as APIs de atendimento ao cliente sem impactar dados reais. Este guia explica como utilizar este ambiente para simular os diversos cenários de atendimento, incluindo a criação de protocolos, mensagens, eventos e reversas.

Características do Ambiente de Sandbox

Independência de Outros Sistemas

O ambiente de sandbox do SAC é completamente isolado dos demais ambientes, incluindo o sandbox de pedidos. Isso significa:

  • Pedidos informados nos protocolos não precisam existir em outros sistemas
  • Validações que dependem de outros sistemas são simuladas
  • Dados criados no sandbox SAC não afetam outros ambientes

Fluxo Completo de Atendimento

No sandbox, você pode testar o ciclo completo de atendimento:

  1. Protocolos: Crie protocolos de atendimento (cancelamento ou entrega)
  2. Mensagens: Adicione comunicações ao protocolo
  3. Eventos: Registre etapas do processo (para protocolos de cancelamento)
  4. Reversas: Crie solicitações de reversa (para protocolos de cancelamento)

Simulação de Cenários de Erro

O ambiente de sandbox permite simular diversos cenários de erro que podem ocorrer em produção, usando:

  • Combinação específica de dados para acionar validações
  • Campo code para forçar erros específicos que não poderiam ser testados de outra forma

O Campo code no Sandbox

O campo code tem funções diferentes em produção e sandbox:

  • Em produção: Identificador customizado opcional para uso do parceiro
  • No sandbox: Além da função original, permite forçar erros específicos

Cada endpoint da API no sandbox possui valores específicos para o campo code que simulam diferentes erros:

RecursoValores de codeDescrição
Protocolosinvalid_orderSimula pedido não encontrado
Eventoserro1Simula falha na criação do evento
Reversaserro1, erro2Simula erros específicos de reversa
atenção

Erros forçados pelo campo code são processados após as validações regulares. Portanto, se sua requisição contiver erros de validação comuns, esses serão sinalizados primeiro, independente do valor de code.

Processamento Assíncrono

Todos os endpoints POST do SAC funcionam de forma assíncrona:

  1. A requisição retorna um transaction_id imediatamente
  2. O processamento ocorre em segundo plano
  3. Use o endpoint de consulta de transações para verificar o resultado

Erros podem ocorrer em dois momentos:

  • Imediatos: Retornados na própria requisição (ex: falhas de autenticação, payload inválido)
  • Processamento: Detectados durante o ciclo de vida da transação (devem ser consultados posteriormente)

Guia de Testes por Recurso

Para testar cada recurso do SAC, consulte os guias específicos:

  • Protocolos - Como criar e consultar protocolos
  • Mensagens - Como adicionar e consultar mensagens em protocolos
  • Eventos - Como registrar e consultar eventos de protocolos de cancelamento
  • Reversas - Como criar e consultar solicitações de devolução

Fluxo Recomendado para Testes

Para um teste completo do ciclo de atendimento, recomendamos seguir esta sequência:

  1. Crie um protocolo de cancelamento
  2. Adicione mensagens ao protocolo
  3. Registre eventos conforme o andamento do processo.
  4. Crie uma reversa para o protocolo (simulando devolução)

Esse fluxo simula um cenário completo de cancelamento com devolução de produto.