Guias por tarefa
Passo a passo para as tarefas mais comuns, cada um com a chamada, a resposta e como confirmar que funcionou.
- Importar clientesPasse o cadastro de clientes para a API como clientes, imóveis e contas de serviço, pela ordem que a API exige, com chaves de idempotência que tornam segura uma segunda execução.
- Registar leituras de contadoresEnvie leituras pela API sem duplicados em caso de nova tentativa, interprete o resultado da verificação de plausibilidade e aceite ou rejeite a leitura antes da facturação.
- Emitir facturas e notas de créditoEmita uma factura manual numa conta de serviço fora de um ciclo de facturação, corrija o valor com uma nota de crédito ou de débito e acompanhe os eventos invoice.issued e invoice.adjusted.
- Receber pagamentosRegiste pagamentos confirmados fora da plataforma contra uma factura e saiba de todos os pagamentos, venham de onde vierem, pelos eventos payment.received e invoice.paid.
- Vender crédito pré-pagoActive um contador como pré-pago, calcule quantos litros um valor compra e venda crédito ao balcão, com o token STS e o recibo na mesma resposta.
- Ouvir eventos com webhooksReceba eventos assinados no seu servidor, valide os cabeçalhos Standard Webhooks, teste em local com a CLI e registe o endpoint definitivo pela API.
- Construir uma app para moradoresInicie sessão de moradores com OAuth 2.0 e PKCE, mostre as contas e facturas a que cada um tem acesso pela Consumer API e abra um pagamento por M-Pesa.
- Ligar um conector de pagamentoConstrua um conector de pagamento sobre a Connector API, desde o código de registo até ao registo, à reserva de cobranças, aos sinais de vida, ao resultado e aos pagamentos vistos fora de uma tarefa.
- Automatizar com a CLIEscreva um processo nocturno que envia leituras de contadores a partir de um ficheiro CSV e exporta as facturas em aberto, com a chave pela entrada padrão, saída em JSON e decisões tomadas pelos códigos de saída da CLI.