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

# Introduccion

> Guia base de la API publica de Lumos CRM

## Alcance

La API publica de Lumos CRM permite integrar sistemas externos para consultar, crear y sincronizar informacion comercial.

## Especificacion OpenAPI

<Card title="Lumos CRM OpenAPI" icon="terminal" href="/api-reference/openapi.json">
  Consulta el contrato base para autenticacion, endpoints y payloads.
</Card>

## Acceso a endpoints de integracion

Para consumir endpoints bajo `/integrations/v1` debes enviar:

1. `x-api-key`: API key de integraciones del tenant.
2. `tenantId`: en query/body segun el endpoint. Opcionalmente puedes usar `x-tenant-id`.

## Como gestionar la API key (solo perfil admin)

1. Ingresa a la consola de administracion de Lumos con un usuario admin del tenant.
2. Consulta el estado de la API key del tenant desde el modulo de integraciones.
3. Genera o rota la API key desde la misma consola y guardala en tu gestor de secretos.

Los endpoints `/integrations/api-key` y `/integrations/api-key/generate` son administrativos y su uso operativo se gestiona via consola de administracion.

## Ejemplo rapido

```bash theme={null}
curl --request GET \
  --url "https://lumos-am-prd.azure-api.net/api/external/integrations/v1/accounts?tenantId=<tu_tenant_id>" \
  --header "x-api-key: <tu_api_key_de_integraciones>"
```

## Esquemas de seguridad

```json theme={null}
"securitySchemes": {
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "x-api-key"
  },
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT"
  }
}
```

<Tip>
  Mantén rotación periódica de API keys por tenant y evita exponerlas en logs o repositorios.
</Tip>