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

# UniFi Controller

> Conecte o Ubiquiti UniFi ao Myrmex com uma API key do UniFi Site Manager — crie a key e adicione a integração.

import { Note, Steps, Step, CardGroup, Card, Tip } from '@mintlify/components';

Conecte seu parque **Ubiquiti UniFi** para que o Myrmex possa ler seus sites, consoles, dispositivos e clientes em tempo real para inventário e análise. O Myrmex conecta-se pela **API do UniFi Site Manager** (`api.ui.com`) usando uma API key.

## O Que o Myrmex Pode Fazer

<CardGroup cols={2}>
  <Card title="Ler o inventário" icon="boxes-stacked">
    Liste sites, consoles, dispositivos UniFi e clientes conectados em todo o seu parque, sob demanda.
  </Card>

  <Card title="Saúde e status" icon="chart-line">
    Verifique o status dos dispositivos, a adoção e o uptime dos sites que você gerencia.
  </Card>

  <Card title="Auditoria de hardening" icon="shield-halved">
    Traga o inventário do UniFi para uma revisão de [Security Posture](/pt/documentation/security-posture/overview).
  </Card>

  <Card title="Perguntar no Workspace" icon="magnifying-glass">
    Consulte seu ambiente UniFi em linguagem natural durante investigações.
  </Card>
</CardGroup>

## Antes de Começar

* Uma **conta do UniFi Site Manager** (`unifi.ui.com`) com acesso aos consoles e sites que você quer conectar.
* Permissão para criar uma **API key** no Site Manager.
* O **Console ID** e o **Site ID** do console/site que você quer que o Myrmex leia.

## Passo 1 — Crie a API Key no UniFi Site Manager

<Steps>
  <Step title="Abra o UniFi Site Manager">
    Faça login no UniFi Site Manager em `unifi.ui.com`.
  </Step>

  <Step title="Crie uma API key">
    Abra **Settings → API** (Control Plane) e crie uma nova **API Key**. Dê a ela um nome descritivo.
  </Step>

  <Step title="Copie a key">
    Copie a key gerada imediatamente e armazene-a com segurança — ela é exibida apenas uma vez. Você a colará no Myrmex.
  </Step>

  <Step title="Anote os Console e Site IDs">
    Registre o **Console ID** e o **Site ID** do ambiente que você quer que o Myrmex leia.
  </Step>
</Steps>

## Passo 2 — Adicione a Integração no Myrmex

No **Directory**, escolha **Add Integration → UniFi Controller** e preencha:

| Field           | Descrição                                                                                                    |
| --------------- | ------------------------------------------------------------------------------------------------------------ |
| **Name**        | Um nome único para este ambiente UniFi.                                                                      |
| **Description** | Nota opcional para identificá-lo.                                                                            |
| **API Key**     | A API key do UniFi Site Manager do Passo 1, enviada como o header `X-API-Key`.                               |
| **Host**        | O host da API (padrão `api.ui.com`).                                                                         |
| **Port**        | A porta HTTPS (padrão `443`).                                                                                |
| **Console ID**  | O identificador do console UniFi a ser lido.                                                                 |
| **Site ID**     | O identificador do site dentro desse console.                                                                |
| **Collector**   | [Collector](/pt/documentation/agent-endpoint-security/collector-mode) opcional para rotear a conexão da API. |

## Conectar

Clique em **Connect** para validar a API key e concluir. O UniFi então aparece em **Environment → Integrations**, pronto para ser consultado no Workspace.

<Note>
  O Myrmex lê do UniFi em tempo real pela API cada vez que você pergunta — nada do seu ambiente UniFi é armazenado no lado do Myrmex.
</Note>