​
Autenticação

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

​
Obter API Key

1

Acessar o Dashboard

Vá para https://pierre.finance/api-key
2

Fazer Login

Entre com sua conta Pierre Finance ou crie uma nova conta
3

Gerar API Key

Clique em “Generate API Key” para criar uma nova chave
4

Copiar a Chave

Copie a chave gerada (começa com “sk-”) e guarde-a em local seguro

​
Formato da API Key

Todas as API keys da Pierre Finance seguem o formato: 
sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Nunca compartilhe sua API key publicamente. A chave dá acesso completo aos seus dados financeiros.

​
Usando a API Key

​
REST API

Inclua a API key no header de autorização: 
Authorization: Bearer sk-your-api-key-here
Exemplo com cURL: 
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
Authorization: Bearer sk-your-api-key-here
  1. Parâmetro de URL apiKey
https://pierre.finance/mcp?apiKey=sk-your-api-key-here
Evite inserir esse endereço em navegadores/logs públicos.

​
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

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

​
401 - Sem Assinatura Ativa

{
  "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

{
  "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

# .env
PIERRE_API_KEY=sk-your-api-key-here

// JavaScript
const API_KEY = process.env.PIERRE_API_KEY;

# 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
  2. Encontre a chave comprometida
  3. Clique em “Revoke”
  4. Gere uma nova chave
Revogar uma chave é irreversível. Todas as aplicações usando essa chave perderão acesso imediatamente.

​
Suporte

Se você tiver problemas com autenticação: