Skip to main content
GET
/
tools
/
api
/
get-api-key-info
cURL
curl --request GET \
  --url https://www.pierre.finance/tools/api/get-api-key-info
{
  "message": "To use Pierre Finance API tools, you need to generate an API key.",
  "steps": [
    "1. Visit https://www.pierre.finance/api-key",
    "2. Sign in to your account",
    "3. Create a new API key or use the default one",
    "4. Copy the API key (starts with \"sk-\")",
    "5. Use this API key in your requests to other tools"
  ],
  "example": {
    "tool": "get-accounts",
    "endpoint": "GET /tools/api/get-accounts",
    "headers": {
      "Authorization": "Bearer sk-your-api-key-here",
      "Content-Type": "application/json"
    }
  },
  "note": "API keys são necessárias para todo acesso a dados financeiros. Mantenha sua API key segura e nunca a compartilhe publicamente.",
  "availableTools": [
    {
      "name": "get-accounts",
      "endpoint": "/tools/api/get-accounts",
      "method": "GET",
      "description": "Obtém todas as contas financeiras do usuário",
      "requiresAuth": true,
      "category": "Accounts"
    },
    {
      "name": "get-balance",
      "endpoint": "/tools/api/get-balance",
      "method": "GET",
      "description": "Obtém o saldo consolidado de todas as contas bancárias",
      "requiresAuth": true,
      "category": "Balance"
    },
    {
      "name": "get-balance-by-account",
      "endpoint": "/tools/api/get-balance-by-account",
      "method": "GET",
      "description": "Obtém o saldo e detalhes de uma conta bancária específica",
      "requiresAuth": true,
      "category": "Balance"
    },
    {
      "name": "get-transactions",
      "endpoint": "/tools/api/get-transactions",
      "method": "GET",
      "description": "Obtém o histórico de transações financeiras com opções de filtro",
      "requiresAuth": true,
      "category": "Transactions"
    },
    {
      "name": "get-installments",
      "endpoint": "/tools/api/get-installments",
      "method": "GET",
      "description": "Obtém transações parceladas de cartão de crédito e estatísticas",
      "requiresAuth": true,
      "category": "Installments"
    },
    {
      "name": "get-bills",
      "endpoint": "/tools/api/get-bills",
      "method": "GET",
      "description": "Obtém faturas de cartão de crédito vencidas",
      "requiresAuth": true,
      "category": "Bills"
    },
    {
      "name": "get-bill-summary",
      "endpoint": "/tools/api/get-bill-summary",
      "method": "GET",
      "description": "Obtém resumo da fatura atual do cartão de crédito (ainda não fechada)",
      "requiresAuth": true,
      "category": "Bills"
    },
    {
      "name": "manage-closing-date",
      "endpoint": "/tools/api/manage-closing-date",
      "method": "POST",
      "description": "Gerencia datas de fechamento de cartão de crédito (operações CRUD)",
      "requiresAuth": true,
      "category": "Closing Dates"
    },
    {
      "name": "manual-update",
      "endpoint": "/tools/api/manual-update",
      "method": "POST",
      "description": "Sincroniza manualmente todas as contas financeiras conectadas e transações",
      "requiresAuth": true,
      "category": "Sync"
    }
  ]
}
Este endpoint retorna informações sobre como gerar e usar API keys.

​
Descrição

O endpoint GET /tools/api/get-api-key-info retorna informações detalhadas sobre como gerar e usar API keys para acessar os serviços da Pierre Finance.

​
Autenticação

Este endpoint não requer autenticação.

​
Resposta

​
Sucesso (200)

{
  "message": "To use Pierre Finance API tools, you need to generate an API key.",
  "steps": [
    "1. Visit https://www.pierre.finance/api-key",
    "2. Sign in to your account",
    "3. Create a new API key or use the default one",
    "4. Copy the API key (starts with \"sk-\")",
    "5. Use this API key in your requests to other tools"
  ],
  "example": {
    "tool": "get-accounts",
    "endpoint": "GET /tools/api/get-accounts",
    "headers": {
      "Authorization": "Bearer sk-your-api-key-here",
      "Content-Type": "application/json"
    }
  },
  "note": "API keys são necessárias para todo acesso a dados financeiros. Mantenha sua API key segura e nunca a compartilhe publicamente.",
  "availableTools": [
    {
      "name": "get-accounts",
      "endpoint": "/tools/api/get-accounts",
      "method": "GET",
      "description": "Obtém todas as contas financeiras do usuário",
      "requiresAuth": true,
      "category": "Accounts"
    },
    {
      "name": "get-balance",
      "endpoint": "/tools/api/get-balance",
      "method": "GET",
      "description": "Obtém o saldo consolidado de todas as contas bancárias",
      "requiresAuth": true,
      "category": "Balance"
    },
    {
      "name": "get-balance-by-account",
      "endpoint": "/tools/api/get-balance-by-account",
      "method": "GET",
      "description": "Obtém o saldo e detalhes de uma conta bancária específica",
      "requiresAuth": true,
      "category": "Balance"
    },
    {
      "name": "get-transactions",
      "endpoint": "/tools/api/get-transactions",
      "method": "GET",
      "description": "Obtém o histórico de transações financeiras com opções de filtro",
      "requiresAuth": true,
      "category": "Transactions"
    },
    {
      "name": "get-installments",
      "endpoint": "/tools/api/get-installments",
      "method": "GET",
      "description": "Obtém transações parceladas de cartão de crédito e estatísticas",
      "requiresAuth": true,
      "category": "Installments"
    },
    {
      "name": "get-bills",
      "endpoint": "/tools/api/get-bills",
      "method": "GET",
      "description": "Obtém faturas de cartão de crédito vencidas",
      "requiresAuth": true,
      "category": "Bills"
    },
    {
      "name": "get-bill-summary",
      "endpoint": "/tools/api/get-bill-summary",
      "method": "GET",
      "description": "Obtém resumo da fatura atual do cartão de crédito (ainda não fechada)",
      "requiresAuth": true,
      "category": "Bills"
    },
    {
      "name": "manage-closing-date",
      "endpoint": "/tools/api/manage-closing-date",
      "method": "POST",
      "description": "Gerencia datas de fechamento de cartão de crédito (operações CRUD)",
      "requiresAuth": true,
      "category": "Closing Dates"
    },
    {
      "name": "manual-update",
      "endpoint": "/tools/api/manual-update",
      "method": "POST",
      "description": "Sincroniza manualmente todas as contas financeiras conectadas e transações",
      "requiresAuth": true,
      "category": "Sync"
    }
  ]
}

​
Erro Interno (500)

{
  "error": "Internal server error",
  "message": "Error details"
}

​
Campos da Resposta

​
message
string
required
Mensagem explicativa sobre o uso de API keys
​
steps
array
required
Array com os passos para gerar e usar uma API key
​
example
object
required
Exemplo de como usar a API key
​
note
string
required
Nota importante sobre segurança da API key
​
availableTools
array
required
Lista de ferramentas disponíveis na API

​
Exemplos de Uso

​
cURL

# Obter informações sobre API keys
curl -X GET 'https://www.pierre.finance/tools/api/get-api-key-info'

​
JavaScript

const BASE_URL = 'https://www.pierre.finance/tools/api';

async function getApiKeyInfo() {
  const response = await fetch(`${BASE_URL}/get-api-key-info`);
  return await response.json();
}

// Uso
getApiKeyInfo().then(info => {
  console.log('Passos para gerar API key:', info.steps);
  console.log('Ferramentas disponíveis:', info.availableTools);
});

​
Python

import requests

BASE_URL = 'https://www.pierre.finance/tools/api'

def get_api_key_info():
    response = requests.get(f'{BASE_URL}/get-api-key-info')
    return response.json()

# Uso
info = get_api_key_info()
print('Passos para gerar API key:', info['steps'])
print('Ferramentas disponíveis:', info['availableTools'])

​
Códigos de Status

  • 200: Sucesso - Informações sobre API keys retornadas
  • 500: Erro interno do servidor

​
Uso Recomendado

Este endpoint é útil para:
  • Desenvolvedores que estão começando a usar a API
  • Documentação que precisa explicar como obter API keys
  • Ferramentas que precisam mostrar informações sobre autenticação
  • Testes que verificam se o serviço está funcionando
Este é o único endpoint que não requer autenticação, sendo útil para verificar se o serviço está online e obter informações sobre como começar a usar a API.

Response

API key information and available tools

​
message
string
Example:

"To use Pierre Finance API tools, you need to generate an API key."

​
steps
string[]
Example:
[
  "1. Visit https://pierre.finance/api-key",
  "2. Sign in to your account",
  "3. Create a new API key or use the default one",
  "4. Copy the API key (starts with \"sk-\")",
  "5. Use this API key in your requests to other tools"
]
​
example
object
​
note
string
Example:

"API keys are required for all financial data access. Keep your API key secure and never share it publicly."

​
availableTools
object[]