Guardar API key (CI) | Plazbot Docs

Guardar una API key manualmente

Para trabajar en tu computador usa plazbot login: inicias sesión desde el navegador sin copiar credenciales. plazbot init es para CI, servidores o cuando necesitas fijar una API key concreta.

Guarda una API key, el workspace y la zona en ~/.plazbot/config.json (con permisos 0600) para que las use el resto de comandos.

bash

01plazbot init -k <apiKey> -w <workspaceId> -z <LA|EU> [opciones]

Parámetros

Parámetro	Flag	Requerido	Descripción
API key	`-k, --api-key <apiKey>`	Sí	API key creada en Configuración → Developer
Workspace	`-w, --workspace <workspaceId>`	Sí	ID del workspace (`wok_...`)
Zona	`-z, --zone <zone>`	Sí	`LA` (América) o `EU` (Europa), en mayúsculas o minúsculas
Email	`-e, --email <email>`	No	Tu correo; solo se muestra en `plazbot whoami`
User ID	`-u, --user-id <userId>`	No	Tu ID de usuario. Lo necesitan `plazbot workspace` y Studio
JSON	`--json`	No	Imprime `{"workspace","zone"}` en JSON

La API key y el Workspace ID están en la plataforma, en Configuración → Developer.

Ejemplos

bash

01# Workspace en América
02plazbot init -k <apiKey> -w wok_AbcDef123 -z LA
03 
04# Workspace en Europa, con email
05plazbot init -k <apiKey> -w wok_AbcDef123 -z EU -e tu@empresa.com
06 
07# Con el ID de usuario (para Studio y workspace list)
08plazbot init -k <apiKey> -w wok_AbcDef123 -z LA -u usr_AbcDef123

Resultado

text

01  Credentials saved to ~/.plazbot/config.json
02  Workspace: wok_AbcDef123
03  Zone: Europe (EU)
04  Email: tu@empresa.com
05 
06  The key is not verified yet. Check it with:
07    plazbot agent list     List your agents (fails if the key or zone is wrong)
08    plazbot whoami         Show the active session

Salida JSON

json

01{
02  "workspace": "wok_AbcDef123",
03  "zone": "EU"
04}

La zona siempre se guarda en mayúsculas (LA o EU).

Errores comunes

Mensaje	Causa	Solución
`Invalid zone "..."`	`-z` distinto de `LA` o `EU`	Usa `-z LA` (América) o `-z EU` (Europa)
`API key cannot be empty.`	`-k ""`	Pasa la API key
`Workspace ID cannot be empty.`	`-w ""`	Pasa el ID del workspace

init no comprueba la API key contra Plazbot: si está mal (o la zona no corresponde), lo verás al ejecutar el siguiente comando. Confirma con plazbot agent list.

Alternativa sin archivo: variables de entorno

En CI es más seguro no escribir la key en disco. Si defines estas variables, el CLI las usa y tienen prioridad sobre ~/.plazbot/config.json:

bash

01export PLAZBOT_API_KEY=tu_api_key
02export PLAZBOT_WORKSPACE_ID=wok_AbcDef123
03export PLAZBOT_ZONE=LA   # opcional, por defecto LA

Cerrar sesión

Para borrar las credenciales guardadas usa plazbot logout.