Manual
O manual lista todos os comandos do kobana: o que cada um faz, o método e o caminho HTTP, os parâmetros, o corpo da requisição e as respostas. Ele é gerado do próprio binário — --help, kobana schema e as especificações OpenAPI embutidas —, então acompanha cada versão e cada idioma.
kobana <produto> <recurso> <método> [flags]
Comandos do CLI
| Comando | Para quê |
|---|---|
| Opções globais | As flags que todo comando aceita: --params, --json, --fields, --dry-run… |
kobana schema | Parâmetros, corpo e respostas de um endpoint |
kobana completions | Autocompletar para bash, zsh, fish, PowerShell e elvish |
kobana update | Procura uma versão nova e atualiza o CLI |
Produtos
| Produto | Comando |
|---|---|
| Gateway Bancário | kobana banking |
| Financeiro Inteligente | kobana finance |
| Faturamento Automático | kobana billing |
| Inbox Autônomo | kobana inbox |
| Régua de Cobrança | kobana dunning |
| Dashboard Mágico | kobana dashboards |
| Agente Kadu | kobana kadu |
Cada produto tem uma página por recurso, com uma seção por comando.
Como ler uma página
- O bloco
texté a linha de uso, como o--helpa imprime.[ID]são os identificadores do caminho, na ordem da rota;[OPÇÕES], as opções globais. GET /v1/…é a chamada que o comando faz. A versão da API aparece só aí — nunca no comando.- Parâmetros de consulta, cabeçalhos e corpo vão em
--paramse--json. A coluna Obrigatório diz o que a API exige. - Corpo da requisição mostra os campos do primeiro nível. Para objetos aninhados, rode o
kobana schemaindicado na página.
Erros comuns a todos os comandos
Todos os endpoints podem responder com estes códigos, que o manual não repete em cada comando:
| HTTP | Significado |
|---|---|
401 | Token ausente, inválido ou vencido — veja Autenticação |
403 | Token válido, mas sem permissão (ou sem o nível de acesso necessário) para a operação |
429 | Limite de requisições excedido |
500 | Erro inesperado no servidor |
No CLI, uma resposta 4xx ou 5xx termina com o código de saída 1.