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

# Autenticação

> Como autenticar e obter acesso aos serviços da Pierre Finance

# Autenticação

Todos os serviços da Pierre Finance (REST API e MCP Server) requerem autenticação via API key.

## Obter API Key

<Steps>
  <Step title="Acessar o Dashboard">
    Vá para [https://pierre.finance/api-key](https://pierre.finance/api-key)
  </Step>

  <Step title="Fazer Login">
    Entre com sua conta Pierre Finance ou crie uma nova conta
  </Step>

  <Step title="Gerar API Key">
    Clique em "Generate API Key" para criar uma nova chave
  </Step>

  <Step title="Copiar a Chave">
    Copie a chave gerada (começa com "sk-") e guarde-a em local seguro
  </Step>
</Steps>

## Formato da API Key

Todas as API keys da Pierre Finance seguem o formato:

```bash theme={null}
sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```

<Warning>
  Nunca compartilhe sua API key publicamente. A chave dá acesso completo aos seus dados financeiros.
</Warning>

## Usando a API Key

### REST API

Inclua a API key no header de autorização:

```bash theme={null}
Authorization: Bearer sk-your-api-key-here
```

Exemplo com cURL:

```bash theme={null}
curl -X GET 'https://pierre.finance/tools/api/get-accounts' \
  -H 'Authorization: Bearer sk-your-api-key-here'
```

### MCP Server

Para o servidor MCP, autentique-se de uma das formas abaixo:

1. Header Authorization

```bash theme={null}
Authorization: Bearer sk-your-api-key-here
```

2. Parâmetro de URL `apiKey`

```bash theme={null}
https://pierre.finance/mcp?apiKey=sk-your-api-key-here
```

<Note>
  Evite inserir esse endereço em navegadores/logs públicos.
</Note>

## Verificação de Assinatura

Além da API key, você precisa ter uma assinatura ativa para acessar os dados financeiros.

### Status da Assinatura

* **Ativa**: Acesso completo a todos os serviços
* **Cancelada**: Acesso até o final do período atual
* **Expirada**: Sem acesso aos dados financeiros

Se sua assinatura estiver inativa, você receberá um erro 401 com detalhes sobre o status.

## Códigos de Erro

### 401 - Erro de Autenticação

```json theme={null}
{
  "error": "Invalid or inactive API key",
  "message": "Please check your API key and try again",
  "type": "invalid_api_key"
}
```

### 401 - Sem Assinatura Ativa

```json theme={null}
{
  "error": "No active subscription found",
  "message": "Please activate your subscription to access financial data",
  "type": "no_subscription",
  "nextSteps": [
    "Visit https://pierre.finance to activate your subscription",
    "Contact support if you need assistance"
  ]
}
```

### 401 - Assinatura Cancelada

```json theme={null}
{
  "error": "Subscription is canceled and will expire at the end of the current period",
  "type": "subscription_canceled",
  "subscriptionStatus": "canceled",
  "currentPeriodEnd": "2024-02-15T23:59:59Z"
}
```

## Segurança

### Boas Práticas

* **Nunca** compartilhe sua API key publicamente
* **Nunca** commite API keys no controle de versão
* **Use** variáveis de ambiente para armazenar a chave
* **Rotacione** suas chaves regularmente
* **Monitore** o uso das suas chaves

### Variáveis de Ambiente

```bash theme={null}
# .env
PIERRE_API_KEY=sk-your-api-key-here
```

```javascript theme={null}
// JavaScript
const API_KEY = process.env.PIERRE_API_KEY;
```

```python theme={null}
# Python
import os
API_KEY = os.getenv('PIERRE_API_KEY')
```

## Revogar API Key

Se você suspeitar que sua API key foi comprometida:

1. Acesse [https://pierre.finance/api-key](https://pierre.finance/api-key)
2. Encontre a chave comprometida
3. Clique em "Revoke"
4. Gere uma nova chave

<Note>
  Revogar uma chave é irreversível. Todas as aplicações usando essa chave perderão acesso imediatamente.
</Note>

## Suporte

Se você tiver problemas com autenticação:

* [Discord](https://https://discord.gg/QurJK5p7GJ)
