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

# Instalação da Evolution API

> Escolha o método de instalação ideal para seu cenário

Este guia irá ajudá-lo a instalar e configurar a **Evolution API**, nossa API REST principal para integração com WhatsApp.

## Pré-requisitos

Antes de iniciar, configure os serviços de infraestrutura necessários:

<CardGroup cols={2}>
  <Card title="Banco de Dados" icon="database" href="/evolution-api/requirements/database">
    PostgreSQL ou MySQL com Prisma ORM
  </Card>

  <Card title="Redis" icon="bolt" href="/evolution-api/requirements/redis">
    Cache distribuído para alta performance
  </Card>
</CardGroup>

***

## Métodos de instalação

Escolha o método mais adequado para o seu cenário:

<CardGroup cols={3}>
  <Card title="Docker" icon="docker" href="/evolution-api/install/docker">
    **Recomendado** para produção. Inclui Docker Compose standalone e Docker Swarm com Traefik para alta disponibilidade.
  </Card>

  <Card title="NVM" icon="node-js" href="/evolution-api/install/nvm">
    Instalação local com Node Version Manager. Ideal para desenvolvimento ou quando você precisa de controle total sobre o ambiente.
  </Card>

  <Card title="Nginx e SSL" icon="shield-halved" href="/evolution-api/install/nginx">
    Configuração de proxy reverso com Nginx e certificado SSL via Let's Encrypt.
  </Card>

  <Card title="SetupOrion" icon="wand-magic-sparkles" href="/evolution-api/install/setup-orion">
    Instalador automatizado com Traefik, Portainer e Docker Swarm. Ideal para VPS limpa.
  </Card>

  <Card title="Easypanel" icon="server" href="/evolution-api/install/easypanel">
    Painel de controle baseado em Docker com template 1-clique e SSL automático. Ideal para quem quer simplicidade sem abrir mão do self-hosted.
  </Card>
</CardGroup>

***

## Verificação rápida

Após instalar por qualquer método, verifique se a API está funcionando:

### Teste de saúde

```bash theme={null}
curl http://localhost:8080/
```

### Crie sua primeira instância WhatsApp

```bash theme={null}
curl -X POST http://localhost:8080/instance/create \
  -H "Content-Type: application/json" \
  -H "apikey: sua-chave-segura-aqui" \
  -d '{
    "instanceName": "minha-instancia",
    "integration": "WHATSAPP-BAILEYS",
    "qrcode": true
  }'
```

### Obtenha o QR Code para conectar

```bash theme={null}
curl http://localhost:8080/instance/connect/minha-instancia \
  -H "apikey: sua-chave-segura-aqui"
```

Escaneie o QR Code com o WhatsApp do seu celular para conectar a instância.

### Verifique o status da conexão

```bash theme={null}
curl http://localhost:8080/instance/connectionState/minha-instancia \
  -H "apikey: sua-chave-segura-aqui"
```

***

## Próximos passos

<CardGroup cols={2}>
  <Card title="Variáveis de Ambiente" icon="gear" href="/evolution-api/configuration/env">
    Referência completa de todas as variáveis de configuração
  </Card>

  <Card title="Webhooks" icon="webhook" href="/evolution-api/configuration/webhooks">
    Configure webhooks para receber eventos em tempo real
  </Card>

  <Card title="Integrações" icon="puzzle-piece" href="/evolution-api/integrations/chatwoot">
    Conecte com Chatwoot, Typebot, OpenAI, Dify e mais
  </Card>

  <Card title="Atualização" icon="arrows-rotate" href="/evolution-api/updates">
    Mantenha sua instância sempre atualizada
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.