API Pública / Autoatendimento

Recursos de autoatendimento

Leve ao chatbot, à URA ou ao aplicativo próprio as mesmas regras de consumo, vencimento, desbloqueio e indicações do WebCliente.

Consultar desbloqueio de confiança

GET/contratos/{id}/desbloqueio-confiancacontratos:desbloqueio

Consulte antes de oferecer a ação. A resposta informa se o recurso está habilitado, se o contrato pode solicitar agora, usos anteriores, bloqueio manual e eventual fatura anterior ainda pendente.

curl "$API/contratos/10/desbloqueio-confianca" -H "Authorization: Bearer $CHAVE"
{
  "sucesso": true,
  "dados": {
    "contrato_id": 10, "habilitado": true, "dias": 3,
    "situacao_contrato": "bloqueado", "usos_anteriores": 0,
    "ativo_ate": null, "pode_solicitar": true,
    "bloqueio_manual": false, "fatura_pendente_vencimento": null
  }
}

Para aplicar, continue usando POST /contratos/{id}/desbloqueio-confianca.

Consultar e alterar vencimento

GET/contratos/{id}/vencimentocontratos:vencimento

Retorna o dia atual, os dias liberados pelo provedor e a situação da trava de alterações.

curl "$API/contratos/10/vencimento" -H "Authorization: Bearer $CHAVE"
PATCH/contratos/{id}/vencimentocontratos:vencimento

Altera o vencimento com as mesmas regras da Central do Cliente. A ação entra no histórico do contrato e na auditoria da API.

curl -X PATCH "$API/contratos/10/vencimento" \
  -H "Authorization: Bearer $CHAVE" -H "Content-Type: application/json" \
  -d '{"dia": 15}'

Pode responder 403 alteracao_desabilitada, 422 dia_indisponivel ou 409 limite_vencimento.

Consumo do contrato

GET/contratos/{id}/consumoconsumo:leitura

Retorna download, upload e total em bytes, sempre isolados por contrato. Use periodo=semestral (padrão) ou periodo=anual.

curl "$API/contratos/10/consumo?periodo=anual" -H "Authorization: Bearer $CHAVE"
{
  "sucesso": true,
  "dados": {
    "contrato_id": 10, "periodo": "anual",
    "meses": [{ "mes": "2026-11", "rotulo": "Nov/26", "download_bytes": "2000", "upload_bytes": "1000", "total_bytes": "3000" }],
    "mes_atual_download_bytes": "2000", "mes_atual_upload_bytes": "1000"
  }
}

Indique e Ganhe

GET/clientes/{id}/indicacoesindicacoes:leitura

Retorna o código e o link para compartilhar, os clientes indicados, quantos contam no mês e a regra de desconto configurada pelo provedor.

curl "$API/clientes/5/indicacoes" -H "Authorization: Bearer $CHAVE"

Use apenas as permissões necessárias. Uma integração de consumo não precisa receber acesso financeiro ou permissão para alterar vencimento.