Autenticação

Todos os pedidos à API requerem uma API key válida no cabeçalho Authorization.

Obter a sua API key

Aceda a Settings > API no dashboard da Finseo
Clique em Create API Key
Escolha um nome, scopes e, opcionalmente, restrinja a projetos específicos
Copie a key imediatamente — ela só será mostrada uma vez

Usar a sua key

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.finseo.ai/v1/projects

import requests

headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get(
    "https://api.finseo.ai/v1/projects",
    headers=headers
)

const response = await fetch("https://api.finseo.ai/v1/projects", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

Verificar uma chave

GET /v1/me devolve a conta à qual uma chave pertence. Use-o para confirmar que uma chave é válida, mostrar aos utilizadores que conta ligaram e ler os scopes da chave — responde independentemente de a conta já ter projetos, o que o torna o endpoint adequado para integrações e testes de ligação.

curl -H "Authorization: Bearer YOUR_API_KEY" https://api.finseo.ai/v1/me

{
  "data": {
    "id": "6a81e088f8ef06e062c40633",
    "email": "you@example.com",
    "accountName": "Your Company",
    "tier": "Business",
    "projectCount": 1,
    "scopes": ["read", "write"],
    "environment": "live"
  }
}

Uma chave inválida ou revogada devolve 401 com o código de erro UNAUTHORIZED.

Scopes

As API keys podem ter um ou mais scopes:

Scope	Descrição
`read`	Ler dados (projetos, prompts, métricas, concorrentes, fontes)
`write`	Modificar dados (criar prompts, atualizar tags, gerir projetos)
`export`	Exportar dados de rastreamento em bloco

Restrições de projeto

Opcionalmente, pode restringir uma key a projetos específicos. Uma key sem restrições de projeto tem acesso a todos os projetos da sua conta.

Segurança da key

Nunca exponha API keys em código do lado do cliente ou em repositórios públicos.

As keys são cifradas com SHA-256 antes de serem armazenadas — nunca guardamos texto simples
Rode as keys regularmente e revogue imediatamente keys comprometidas
Use keys de teste no desenvolvimento e keys live em produção

Visão geral

Primeiros passos

Analytics

Autenticação da API e chaves de API

Autenticação

Obter a sua API key

Usar a sua key

Verificar uma chave

Scopes

Restrições de projeto

Segurança da key

​Autenticação

​Obter a sua API key

​Usar a sua key

​Verificar uma chave

​Scopes

​Restrições de projeto

​Segurança da key

Autenticação

Obter a sua API key

Usar a sua key

Verificar uma chave

Scopes

Restrições de projeto

Segurança da key