Ambiente de teste
Como testar a integração inteira sem gastar saldo nem tocar em dado real.
Existe um só endereço de API. O que separa teste de produção é o token.
Ao criar um token no painel você escolhe o ambiente. Um token de teste responde com dado simulado, no mesmo formato da resposta real, e não gasta saldo.
Como reconhecer
Toda resposta de sucesso diz em que modo rodou, em meta.sandbox:
{
"data": { "cpfStatus": "REGULAR" },
"meta": {
"consulta_id": "0199c8f2-6b1e-7c3a-9d4f-2a5b8e7c1d90",
"saldo": 48750,
"preco": 0,
"sandbox": true
}
}
Use isso para evitar o acidente clássico de subir com o token errado:
const { data, meta } = await resposta.json()
if (process.env.NODE_ENV === 'production' && meta.sandbox) {
throw new Error('Token de teste em produção: este dado é simulado.')
}
O que o modo de teste garante
- O formato da resposta é o mesmo da produção, campo a campo.
- O preço da consulta é zero e o saldo não muda.
- A chamada fica registrada, então dá para exercitar o fluxo inteiro, do pedido à conferência no painel.
O que ele não garante
- Tempo de resposta. As origens reais variam de cerca de um segundo a mais de dez. Dimensione seu timeout pela consulta real, não pelo teste.
- Falhas de origem. Indisponibilidade e timeout só acontecem em produção.
Consultas em breve
Algumas consultas do catálogo aparecem como em breve. Elas respondem com
dado simulado mesmo com token de produção, e não são cobradas. O meta.sandbox
vem true nelas também.
Por isso, antes de abrir para o seu cliente final, faça uma passada com token
de produção em volume pequeno e confira o meta.sandbox de cada consulta que
você usa.