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

# Credenciais API

> Como obter e gerenciar suas credenciais de API

Para começar a usar a API Avantti Finance, você precisa obter suas credenciais de autenticação. Este guia mostra como conseguir e gerenciar suas chaves API.

## 📋 Passo 1: Obter Credenciais

Após criar sua conta e empresa na plataforma Avantti Finance, você receberá duas credenciais importantes:

### Tipos de Credenciais

<CardGroup cols={2}>
  <Card title="🔑 API Key (Chave Pública)" icon="eye">
    **Formato**: `pk_live_abc123def456ghi789` ou `pk_test_abc123def456ghi789`

    Pode ser exposta no client-side quando necessário
  </Card>

  <Card title="🔒 API Secret (Chave Secreta)" icon="eye-slash">
    **Formato**: `sk_live_xyz789uvw012mno345` ou `sk_test_xyz789uvw012mno345`

    **NUNCA** exponha esta chave publicamente
  </Card>
</CardGroup>

### Ambientes Disponíveis

| Prefixo                 | Ambiente     | Uso             | API Base URL                     |
| ----------------------- | ------------ | --------------- | -------------------------------- |
| `pk_live_` / `sk_live_` | **Produção** | Operações reais | `https://api.avanttifinance.com` |

## 🔐 Passo 2: Configurar Autenticação

### Autenticação Basic

Para gerar tokens de acesso, use autenticação Basic Auth com suas credenciais:

```bash theme={null}
# Encode suas credenciais em Base64
echo -n "pk_test_abc123:sk_test_xyz789" | base64
# Resultado: cGtfdGVzdF9hYmMxMjM6c2tfdGVzdF94eXo3ODk=
```

### Exemplo de Requisição

```bash theme={null}
curl -X POST 'https://api.avanttifinance.com/auth' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic cGtfdGVzdF9hYmMxMjM6c2tfdGVzdF94eXo3ODk='
```

## 🛡️ Segurança das Credenciais

<Warning>
  **Importante**: Mantenha sua API Secret segura e nunca a exponha em código client-side, repositórios públicos ou logs.
</Warning>

### ✅ Boas Práticas

* **Use variáveis de ambiente** para armazenar credenciais
* **Separe ambientes** - nunca misture chaves de teste com produção
* **Rotacione chaves** periodicamente
* **Limite acesso** apenas aos desenvolvedores necessários
* **Monitore uso** através do dashboard

### ❌ Práticas a Evitar

* Nunca commite chaves no código fonte
* Não inclua em arquivos de configuração versionados
* Evite logs que possam conter as chaves
* Não compartilhe via chat ou email

### Exemplo de Configuração Segura

```bash theme={null}
# .env
AVANTTI_FINANCE_API_KEY=pk_test_abc123def456ghi789
AVANTTI_FINANCE_API_SECRET=sk_test_xyz789uvw012mno345
AVANTTI_FINANCE_BASE_URL=https://dev-api.avanttifinance.com
```

```javascript theme={null}
// config.js
const config = {
  apiKey: process.env.AVANTTI_FINANCE_API_KEY,
  apiSecret: process.env.AVANTTI_FINANCE_API_SECRET,
  baseUrl: process.env.AVANTTI_FINANCE_BASE_URL
}

export default config
```

## 🔄 Gerenciamento de Chaves

### Rotação de Chaves

Para manter a segurança, recomendamos rotacionar suas chaves:

1. **Gere novas chaves** no dashboard
2. **Teste** com as novas credenciais
3. **Atualize** sua aplicação
4. **Revogue** as chaves antigas

### Múltiplas Chaves

Você pode ter múltiplas chaves API para diferentes propósitos:

* Desenvolvimento
* Staging
* Produção
* Diferentes aplicações

## 📊 Monitoramento

No dashboard você pode monitorar:

* **Uso das chaves** - requisições por chave
* **Rate limits** - limites de uso
* **Logs de acesso** - histórico de uso
* **Alertas** - notificações de uso anormal

## 🚨 Em Caso de Comprometimento

Se suspeitar que suas credenciais foram comprometidas:

1. **Revogue imediatamente** as chaves no dashboard
2. **Gere novas credenciais**
3. **Entre em contato** com nosso suporte
4. **Monitore** atividades suspeitas

<CardGroup cols={2}>
  <Card title="🆘 Emergência" icon="shield-exclamation" color="#ff7e00" href="mailto:security@clickpagamentos.com">
    Para incidentes de segurança críticos
  </Card>

  <Card title="📞 Suporte" icon="headset" color="#ff7e00" href="mailto:dev@clickpagamentos.com">
    Para dúvidas gerais sobre API
  </Card>
</CardGroup>

***

## 🎯 Próximos Passos

<CardGroup cols={2}>
  <Card title="🎟️ Gerar Token" icon="ticket" color="#ff7e00" href="/pages/auth/generate-token">
    Aprenda a gerar tokens Bearer para usar na API
  </Card>

  <Card title="💰 PIX IN" icon="qrcode" color="#ff7e00" href="/pages/pix-in/overview">
    Comece a receber pagamentos PIX
  </Card>
</CardGroup>