Pular para o conteúdo principal

Helpers

Helpers são comandos prefixados com + que entregam fluxos de vários passos que os comandos dinâmicos sozinhos não dão: interfaces simplificadas, operações em lote ou chamadas compostas por vários endpoints. Eles não embrulham uma única chamada de API já disponível pelos comandos dinâmicos — cada flag de helper controla lógica de orquestração, não uma versão remodelada de --params/--json.

Os helpers de hoje são do Gateway Bancário, e valem para qualquer produto no mesmo binário:

HelperDescrição
+emitirEmissão simplificada de boleto, com flags nomeadas
+cancelar-loteCancelamento em lote de vários boletos por id
+cobrarCriação simplificada de cobrança Pix, com flags nomeadas
# Emitir um boleto
kobana +emitir --valor 150.50 --vencimento 2026-05-01 \
--nome "Maria Silva" --cpf-cnpj "012.345.678-90" --carteira 1

# Criar uma cobrança Pix
kobana +cobrar --valor 99.90 --conta-pix "UID" \
--nome "João" --cpf-cnpj "012.345.678-90"

# Cancelar boletos em lote
kobana +cancelar-lote --ids "123,456,789"

Próximos passos​

  • Uso — os comandos dinâmicos ao lado dos quais estes helpers vivem.
  • Introspecção de schema — inspecione os endpoints que um helper chama por baixo.