Obtenha e proteja sua chave de API

Sua chave de API autentica as requisições ao Scrapeless. Trate-a como um segredo: qualquer pessoa que a obtenha pode conseguir usar os serviços disponíveis para essa chave.

Obtenha sua chave

1. Faça login no painel do Scrapeless.
2. Abra as configurações da chave de API e copie a chave que você usará em sua aplicação. Alguns guias de produto se referem a esse valor como um token de API.
3. Armazene-a em seu ambiente local ou no armazenamento de segredos da sua plataforma de implantação.

Se você não conseguir localizar as configurações da chave, entre em contato com o administrador da sua conta ou com o suporte do Scrapeless. Não envie sua senha nem uma chave existente em uma mensagem de suporte.

Armazene-a para o desenvolvimento local

Para Bash ou Zsh, cole a chave em um prompt oculto:

printf 'Scrapeless API key: '
read -rs SCRAPELESS_API_KEY
printf '\n'
export SCRAPELESS_API_KEY

Isso evita incluir a chave literal no comando que você digita. A variável dura pela sessão atual do shell e é herdada pelos processos iniciados a partir dela.

Verifique se ela está definida sem imprimir seu valor:

if [ -n "${SCRAPELESS_API_KEY:-}" ]; then
  printf 'SCRAPELESS_API_KEY is set\n'
else
  printf 'SCRAPELESS_API_KEY is not set\n'
fi

Se seu projeto carrega segredos de um arquivo .env, exclua esse arquivo do controle de versão antes de adicionar uma chave. Mantenha apenas variáveis vazias ou marcadores de posição em um .env.example compartilhado. Um arquivo .env requer um carregador apropriado; criá-lo sozinho não popula o ambiente do seu processo.

Para aplicações implantadas, configure a chave no armazenamento de segredos da sua plataforma de hospedagem ou de CI/CD e injete-a em tempo de execução. Limite o acesso às pessoas e processos que dela precisam.

Use o método de autenticação do seu produto

Os SDKs Python e Go estão em desenvolvimento. Suas instruções de configuração e autenticação estarão disponíveis no guia do SDK Python e no guia do SDK Go. Até lá, use o método de autenticação documentado para o endpoint REST que você chama.

Para endpoints que usam x-api-token, envie a chave sem adicionar Bearer:

x-api-token: YOUR_API_KEY

Uma chave incorporada em uma URL de conexão de navegador ainda é um segredo. Oculte o valor de token antes de registrar, copiar ou compartilhar a URL. Para clientes MCP, siga a configuração do transporte e do cliente que você usa; os nomes das variáveis de ambiente não são necessariamente os mesmos do SDK.

Autenticação via CLI — Em breve

A documentação da CLI incluirá Autenticação e Configuração. Use esse guia quando a CLI estiver disponível para configurar credenciais para o seu fluxo de trabalho no terminal. Mantenha as credenciais fora de exemplos de comandos compartilhados, do histórico do shell e dos logs.

Verifique a chave

Use o endpoint Get User Info documentado para verificar a autenticação sem enviar um trabalho de scraping:

curl --silent --show-error \
  --request GET 'https://api.scrapeless.com/api/v1/me' \
  --header "x-api-token: ${SCRAPELESS_API_KEY:?Set SCRAPELESS_API_KEY first}" \
  --output scrapeless-account.json \
  --write-out 'HTTP status: %{http_code}\n'

Inspecione o status e o corpo da resposta localmente. A resposta pode incluir informações de conta e saldo, portanto não publique o arquivo nem o comite em seu repositório.

Uma autenticação bem-sucedida confirma que esta requisição pode usar a chave. O acesso ao produto, o saldo e a validade da requisição ainda precisam ser verificados quando você chama um endpoint de produto. Continue com o Guia rápido para fazer uma requisição ao Web Unlocker.

Mantenha a chave fora de superfícies expostas

• Faça chamadas autenticadas a partir de código confiável do lado do servidor. Não incorpore a chave em JavaScript de frontend, em pacotes de aplicações móveis ou em configurações públicas.
• Oculte cabeçalhos de autenticação, URLs de conexão de navegador e variáveis de ambiente secretas dos logs da aplicação e dos eventos de monitoramento.
• Evite rastreamentos HTTP verbosos ou o rastreamento do shell ao usar credenciais reais. Variáveis de ambiente ainda podem ser expostas por meio de ferramentas de depuração e da inspeção de processos.
• Remova chaves de capturas de tela, gravações, notebooks compartilhados, tickets de suporte e prompts de chat de IA.
• Use o método de compartilhamento de segredos aprovado pela sua equipe quando o acesso for necessário.

Substitua uma chave com segurança

Para uma substituição planejada, obtenha uma chave substituta por meio dos controles do painel disponíveis para a sua conta ou pelo suporte do Scrapeless. Atualize seu armazenamento de segredos e todas as aplicações dependentes, reinicie os processos que carregam segredos na inicialização e verifique se a substituição funciona. Em seguida, invalide a chave antiga e confirme que ela não é mais aceita.

Se uma chave puder ter vazado, priorize invalidar imediatamente a credencial exposta, mesmo que isso interrompa aplicações em execução. Use os controles do painel disponíveis ou entre em contato com o suporte para obter ajuda e, em seguida, distribua uma substituição por meio do seu armazenamento de segredos.

Remover uma chave de um arquivo ou excluir uma publicação pública não a invalida. Revise o uso recente e limpe as cópias expostas, incluindo logs e o histórico do repositório, após conter a exposição.

Solucione problemas de autenticação

Se a autenticação falhar, confirme que a aplicação carregou a variável pretendida, que a chave não tem espaços em branco ao redor e que a credencial está sendo enviada usando o método exigido por esse endpoint. Reinicie processos de longa duração após alterar a configuração de seus segredos.

Se a chave funcionar no endpoint de verificação, mas uma requisição de produto falhar, inspecione a resposta de erro do produto e o acesso no painel. Compartilhe apenas diagnósticos ocultados ao solicitar suporte.

A seguir: Faça sua primeira requisição ou escolha um produto.