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

# Api keys

# API Keys

> Entenda como funcionam as chaves de API para autenticação segura

As **API Keys** são credenciais que autenticam e autorizam acesso à API ConnectVets Notes.

<Info>
  **Importante**: O acesso à API ConnectVets Notes é **exclusivo do plano Enterprise**. Entre em contato conosco via [Discord](https://discord.gg/uN4NxUGk) para verificar sua elegibilidade e configurar seu acesso.
</Info>

## Como Funcionam

<Steps>
  <Step title="Verificação de Elegibilidade">
    Confirme que você é cliente do plano Enterprise - apenas clientes Enterprise têm acesso à API
  </Step>

  <Step title="Solicitação">
    Contate nossa equipe via [Discord](https://discord.gg/uN4NxUGk) para solicitar acesso
  </Step>

  <Step title="Configuração Personalizada">
    Nossa equipe criará suas credenciais com limites de rate limiting personalizados para seu uso
  </Step>

  <Step title="Entrega Segura">
    Você receberá sua API Key, informações sobre seus limites específicos e instruções de uso
  </Step>

  <Step title="Integração">
    Use a chave no header `X-API-KEY` em todas as requisições
  </Step>
</Steps>

## Tipos de API Keys

### Produção (Enterprise)

* **Ambiente**: `https://api-sandbox.connectvets.com.br/notes/v1`
* **Uso**: Aplicações em produção (clientes Enterprise)
* **Rate Limiting**: Limites personalizados conforme necessidade do cliente
* **Suporte**: Prioritário e dedicado

### Homologação (Enterprise)

* **Ambiente**: `https://api-sandbox.connectvets.com.br/notes/v1`
* **Uso**: Testes e homologação (clientes Enterprise)
* **Rate Limiting**: Limitado para ambiente de testes
* **Suporte**: Via Discord

## Configuração

### Headers Obrigatórios

```http theme={null} theme={null}
X-API-KEY: sua_api_key_aqui
Content-Type: application/json
```

### Exemplo de Uso

```javascript theme={null} theme={null}
const apiKey = process.env.CONNECTVETS_API_KEY;

const response = await fetch('https://api-sandbox.connectvets.com.br/notes/v1/notes', {
  method: 'GET',
  headers: {
    'X-API-KEY': apiKey,
    'Content-Type': 'application/json'
  }
});
```

## Limites e Cotas

<Warning>
  **Plano Enterprise Obrigatório**: O consumo da API ConnectVets Notes é exclusivo para clientes do plano Enterprise.
</Warning>

Os limites de rate limiting são configurados individualmente para cada cliente Enterprise baseado em:

* Volume de uso esperado
* Tipo de integração
* Criticidade da aplicação
* Horários de pico

**Para conhecer seus limites específicos**, entre em contato com nossa equipe via [Discord](https://discord.gg/uN4NxUGk).

## Monitoramento

### Headers de Resposta

A API retorna informações sobre uso nos headers:

```http theme={null} theme={null}
X-RateLimit-Limit-Minute: 100
X-RateLimit-Remaining-Minute: 87
X-RateLimit-Reset-Minute: 1642694400
X-RateLimit-Limit-Hour: 1000
X-RateLimit-Remaining-Hour: 756
```

### Dashboard (Em Breve)

Estamos desenvolvendo um dashboard para acompanhamento em tempo real:

* Uso de cotas em tempo real
* Histórico de requisições
* Alertas de limite
* Estatísticas de performance

## Segurança

<Warning>
  **Nunca exponha sua API Key** em código público, logs ou URLs. Use variáveis de ambiente.
</Warning>

### Boas Práticas

1. **Variáveis de Ambiente**
   ```bash theme={null} theme={null}
   export CONNECTVETS_API_KEY="sua_api_key_aqui"
   ```

2. **Rotação Regular**
   * Contate nossa equipe via [Discord](https://discord.gg/uN4NxUGk) para rotacionar chaves periodicamente
   * Especialmente importante após vazamentos ou mudanças de equipe

3. **Monitoramento**
   * Acompanhe logs de acesso e uso
   * Configure alertas para uso anômalo

4. **Segregação**
   * Use chaves diferentes para desenvolvimento e produção
   * Limite permissões por ambiente

## Troubleshooting

### Erro 401: Unauthorized

```json theme={null} theme={null}
{
  "error": "unauthorized",
  "message": "Invalid or missing API key"
}
```

**Soluções:**

* Verifique se o header `X-API-KEY` está presente
* Confirme que a chave está correta
* Verifique se a chave não expirou

### Erro 403: Forbidden

```json theme={null} theme={null}
{
  "error": "forbidden", 
  "message": "Insufficient permissions for this endpoint"
}
```

**Soluções:**

* Verifique se sua chave tem permissões para o endpoint
* Contate nossa equipe via [Discord](https://discord.gg/uN4NxUGk) para upgrade de plano

### Erro 429: Rate Limit

```json theme={null} theme={null}
{
  "error": "too_many_requests",
  "message": "Rate limit exceeded",
  "retry_after": 60
}
```

**Soluções:**

* Implemente retry com backoff exponencial
* Considere upgrade para plano com limite maior
* Otimize frequência de requisições

## Gerenciamento

<Info>
  **Importante**: API Keys não são gerenciadas via API. Todas as operações são feitas através de contato direto com nossa equipe via [Discord](https://discord.gg/uN4NxUGk).
</Info>

### Para Solicitar Nova Chave

<Note>
  **Pré-requisito**: Você deve ser cliente do plano Enterprise para ter acesso à API.
</Note>

1. **Contate via Discord**: [https://discord.gg/uN4NxUGk](https://discord.gg/uN4NxUGk)
2. **Informe**:
   * Nome da empresa/projeto (cliente Enterprise)
   * Casos de uso esperados
   * Volume estimado de requisições
   * Ambiente (produção/desenvolvimento)
   * Necessidades específicas de rate limiting

### Para Modificar Limites

Como cliente Enterprise, você pode solicitar ajustes nos seus limites de rate limiting. Entre em contato via [Discord](https://discord.gg/uN4NxUGk) informando:

* Justificativa técnica para o ajuste
* Métricas de uso atual da API
* Projeções de crescimento de tráfego
* Impacto nos negócios dos limites atuais

### Para Renovar ou Revogar

Nossa equipe pode ajudar com:

* Renovação de chaves expiradas
* Revogação por segurança
* Migração entre ambientes

***

<Info>
  **Próximo passo**: Explore os [endpoints de Notes](/notes/api-reference/notes/create) ou veja [exemplos de autenticação](/notes/examples/basic-integration).
</Info>