> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtener una clave de API e iniciar sesión

> Autentica Octoparse CLI con OAuth o una clave de API. Usa una variable de entorno o stdin en CI y entornos automatizados.

## Requisitos de autenticación

La mayoría de comandos de Octoparse CLI requieren autenticación. Una clave de API o sesión OAuth identifica tu cuenta y autoriza el acceso a tus tareas y datos.

<Warning>
  Todos los comandos funcionales requieren credenciales válidas, incluidas las ejecuciones locales con `--task-file` y `.otd` y los comandos de descubrimiento de plantillas. Autentícate antes de enumerar, buscar plantillas, ejecutar o exportar tareas.
</Warning>

<Note>
  Desde CLI v0.1.33, `template search`, `template view` y `template version` requieren credenciales. CLI v0.1.32 permitía consultar el mismo catálogo sin iniciar sesión.
</Note>

Solo los comandos de configuración y diagnóstico funcionan sin credenciales:

```bash theme={null}
octoparse --help
octoparse --version
octoparse capabilities
octoparse doctor
octoparse browser status
octoparse auth
octoparse auth info
```

## Métodos de inicio de sesión

Octoparse CLI admite OAuth y clave de API.

### OAuth (mediante navegador)

Abre el flujo en un navegador y guarda localmente los tokens de acceso y actualización:

```bash theme={null}
octoparse auth login --oauth
```

Usa OAuth si prefieres no gestionar claves manualmente o tu equipo utiliza SSO.

### Clave de API

Crea claves en la consola de Octoparse:

<Card title="Abrir la página de claves de API" icon="key" href="https://www.octoparse.es/console/account-center/api-keys">
  Crea, copia y gestiona claves de API de Octoparse desde el centro de tu cuenta.
</Card>

**Inicio interactivo**: abre la página y solicita que pegues una clave:

```bash theme={null}
octoparse auth login
```

**Pasar la clave directamente**: verifica y guarda una clave copiada:

```bash theme={null}
octoparse auth login <apiKey>
```

**No abrir el navegador:**

```bash theme={null}
octoparse auth login --no-open
```

**Leer desde stdin** para gestores de secretos y CI:

```bash theme={null}
echo "<apiKey>" | octoparse auth login --stdin
```

Por ejemplo, con 1Password CLI:

```bash theme={null}
op read "op://vault/octoparse/credential" | octoparse auth login --stdin
```

<Note>La CLI verifica la clave antes de guardarla. Las claves no válidas no se almacenan.</Note>

## Usar una variable de entorno

En CI o sesiones temporales, proporciona credenciales mediante variables:

```bash theme={null}
OCTO_ENGINE_API_KEY=xxx octoparse task list --json
```

Para un bearer token en trabajos de CI breves:

```bash theme={null}
OCTO_ENGINE_ACCESS_TOKEN=xxx octoparse task list --json
```

También puedes sustituir la URL base de la API:

```bash theme={null}
OCTO_ENGINE_API_BASE_URL=https://example.com OCTO_ENGINE_API_KEY=xxx octoparse task list
```

## Prioridad de credenciales

Octoparse CLI las comprueba en este orden:

```text theme={null}
1. OCTO_ENGINE_ACCESS_TOKEN  (bearer token, highest priority)
2. OCTO_ENGINE_API_KEY       (API key override)
3. ~/.octoparse/credentials.json  (stored by auth login)
```

`octoparse auth login` crea automáticamente el archivo de credenciales.

En macOS y Linux:

```text theme={null}
~/.octoparse/credentials.json
```

En Windows:

```text theme={null}
%USERPROFILE%\.octoparse\credentials.json
```

<Warning>No publiques claves ni tokens en Git, scripts, documentación, capturas, registros compartidos o salidas de CI.</Warning>

## Comprobar y gestionar la autenticación

```bash theme={null}
octoparse auth status
```

Muestra información detallada:

```bash theme={null}
octoparse auth info
```

Elimina las credenciales guardadas:

```bash theme={null}
octoparse auth logout
```

## Siguientes pasos

<CardGroup cols={2}>
  <Card title="Ejecutar tu primera tarea" href="/docs/es/cli/quick-start/run-your-first-task">Enumera tareas, inspecciona una, ejecútala localmente y exporta datos.</Card>
  <Card title="Consultar todos los comandos" href="../reference/command-cheatsheet">Revisa comandos de autenticación, tareas, ejecución local, nube y exportación.</Card>
</CardGroup>