Pular para o conteúdo principal

Autenticação e chaves de API

Por padrão, as conexões do Sheet Best não exigem autenticação: qualquer pessoa com a URL pode chamá-las. Você pode proteger uma conexão com uma única chave de API. Quando habilitada, cada requisição precisa incluir essa chave no cabeçalho X-Api-Key.

Habilitar uma chave de API

  1. Abra a conexão no painel do Sheet Best.
  2. Clique em Edit na página de detalhes para editá-la.
  3. Abra as configurações avançadas (Advanced Settings).
  4. Ative API Key. O Sheet Best gera uma chave para a conexão.

Você pode desabilitar ou gerar uma nova chave na mesma tela a qualquer momento.

Enviar a chave

Inclua a chave no cabeçalho X-Api-Key de cada requisição:

curl -H 'X-Api-Key: <your-api-key>' \
'https://api.sheetbest.com/sheets/<api-id>'

O mesmo cabeçalho se aplica às requisições POST, PATCH, PUT e DELETE.

Autenticação do MCP

A autenticação por chave de API protege requisições REST diretas a uma conexão. Para conectar um assistente de IA pelo endpoint de conta do Sheet Best, gere um token bearer separado em Assistentes de IA · MCP. Veja Segurança e tokens do MCP.

Erros

Requisições a uma conexão protegida sem uma chave válida retornam:

StatusCódigo de erroCausa
401not_authenticatedO cabeçalho X-Api-Key está ausente.
401authentication_failedA chave está incorreta.

Proteger as chaves

Trate a chave de API como qualquer outro segredo:

  • Não a salve no controle de versão.
  • Não a inclua em código do lado do cliente executado em navegadores que você não controla: qualquer pessoa pode lê-la na aba de rede. Para aplicativos web, encaminhe as requisições pelo seu próprio backend.
  • Faça a rotação da chave em Advanced Settings se suspeitar de vazamento.