Referência da API

Cobertura e health

UFs atendidas na consulta e o health check público.

Use a cobertura para esconder a consulta em estados que a operação ainda não atende. O health serve para monitoração, sem chave.

GET/api/v1/coverage

Exige API key. Não exige X-Account-Id.

{
"source": "banco_do_brasil",
"count": 27,
"ufs": ["AC", "AL", "AP", "AM", "BA", "CE", "DF", "ES", "GO", "MA", "MT", "MS", "MG", "PA", "PB", "PR", "PE", "PI", "RJ", "RN", "RS", "RO", "RR", "SC", "SP", "SE", "TO"]
}

GET/health

Público. Mostra o modo de consulta e de pagamento que o servidor está usando agora.

{
"status": "ok",
"environment": "production",
"bb": { "mode": "live", "environment": "production" },
"payments": { "mode": "live", "environment": "production", "simulation": false }
}

bb.environment e payments.environment dizem se o servidor aponta para homologação/sandbox ou produção do provedor. Isso não muda a URL que você chama: o cliente continua em https://api.zera.mobi.