Saltar al contenido principal

Manual

El manual lista todos los comandos de kobana: qué hace cada uno, el método y la ruta HTTP, los parámetros, el cuerpo de la solicitud y las respuestas. Se genera desde el propio binario — --help, kobana schema y las especificaciones OpenAPI incluidas —, así que acompaña cada versión y cada idioma.

kobana <producto> <recurso> <método> [flags]

Comandos del CLI​

ComandoPara qué
Opciones globalesLas flags que acepta todo comando: --params, --json, --fields, --dry-run…
kobana schemaParámetros, cuerpo y respuestas de un endpoint
kobana completionsAutocompletado para bash, zsh, fish, PowerShell y elvish
kobana updateBusca una versión nueva y actualiza el CLI

Productos​

ProductoComando
Gateway Bancariokobana banking
Financiero Inteligentekobana finance
Facturación Automáticakobana billing
Inbox Autónomokobana inbox
Cobranzakobana dunning
Dashboard Mágicokobana dashboards
Agente Kadukobana kadu

Cada producto tiene una página por recurso, con una sección por comando.

Cómo leer una página​

  • El bloque text es la línea de uso, tal como la imprime --help. [ID] son los identificadores de la ruta, en el orden de la ruta; [OPCIONES], las opciones globales.
  • GET /v1/… es la llamada que hace el comando. La versión de la API aparece solo ahí, nunca en el comando.
  • Los parámetros de consulta, encabezados y cuerpo van en --params y --json. La columna Obligatorio indica lo que exige la API.
  • Cuerpo de la solicitud muestra los campos del primer nivel. Para objetos anidados, ejecuta el kobana schema indicado en la página.

Errores comunes a todos los comandos​

Todos los endpoints pueden responder con estos códigos, que el manual no repite en cada comando:

HTTPSignificado
401Token ausente, inválido o vencido — consulta Autenticación
403Token válido, pero sin permiso (o sin el nivel de acceso necesario) para la operación
429Límite de solicitudes excedido
500Error inesperado en el servidor

En el CLI, una respuesta 4xx o 5xx termina con el código de salida 1.