Começar
Ambientes
Produção, develop e o que muda entre mock e live.
O cliente HTTP não escolhe o modo mock. Quem opera a API configura se a consulta e o pagamento falam com os provedores reais.
URLs
| Uso | URL |
|---|---|
| Produção | https://api.zera.mobi |
| Develop | https://dev-api.zera.mobi |
| Health | GET /health |
| API | /api/v1/... |
GET /health devolve o modo atual de consulta (bb.mode) e de pagamento (payments.mode), cada um mock ou live, e se o pagamento está em sandbox.
Mock e live
| Variável no servidor | Efeito |
|---|---|
BB_MODE=mock |
Consulta e liquidação simuladas |
BB_MODE=live |
Consulta no Banco do Brasil |
LYTEX_MODE=mock |
Cobrança simulada |
LYTEX_MODE=live |
Cobrança no adquirente |
No mock dá para cadastrar, consultar e pagar sem credencial de órgão ou de adquirente. Os valores e os identificadores simulados não liquidam um débito real.
POST /api/v1/orders/{order_id}/simulate-pix só existe para mock ou sandbox. Em live de produção a rota responde conflito. Não use essa rota no fluxo do seu cliente.
Sandbox desta documentação
O sandbox chama a base que você escolher.
- Produção envia o browser para
https://api.zera.mobi. A API precisa autorizar a origem da página; se o browser bloquear, a mensagem de CORS aparece no painel. - Develop envia o browser para
https://dev-api.zera.mobi. Vale a mesma regra de origem da página.