Obtenga y proteja su clave de API

Su clave de API autentica las solicitudes a Scrapeless. Trátela como un secreto: cualquier persona que la obtenga podría poder usar los servicios disponibles para esa clave.

Obtenga su clave

1. Inicie sesión en el panel de control de Scrapeless.
2. Abra la configuración de la clave de API y copie la clave que usará para su aplicación. Algunas guías de productos se refieren a este valor como un token de API.
3. Guárdela en su entorno local o en el almacén de secretos de su plataforma de despliegue.

Si no puede encontrar la configuración de la clave, póngase en contacto con su administrador de cuenta o con el soporte técnico de Scrapeless. No envíe su contraseña ni una clave existente en un mensaje de soporte.

Guárdela para desarrollo local

Para Bash o Zsh, pegue la clave en un símbolo de sistema oculto:

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

Esto evita incluir la clave literal en el comando que escribe. La variable dura durante la sesión actual del shell y es heredada por los procesos lanzados desde él.

Verifique que esté establecida sin imprimir su valor:

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

Si su proyecto carga secretos desde un .env archivo, excluya ese archivo del control de versiones antes de agregar una clave. Mantenga solo variables vacías o marcadores en un compartido .env.example. Un .env archivo requiere un cargador adecuado; crearlo por sí solo no rellena su entorno de proceso.

Para aplicaciones desplegadas, configure la clave en su plataforma de alojamiento o en el almacén de secretos de CI/CD e inyéctela en tiempo de ejecución. Limite el acceso a las personas y procesos que lo necesiten.

Use el método de autenticación para su producto

Los SDK de Python y Go están en desarrollo. Sus instrucciones de configuración y autenticación estarán disponibles en la guía del SDK de Python y guía del SDK de Go. Hasta entonces, utilice el método de autenticación documentado para el endpoint REST que llame.

Para endpoints que usan x-api-token, envíe la clave sin agregar Bearer:

x-api-token: YOUR_API_KEY

Una clave incrustada en una URL de conexión del navegador sigue siendo un secreto. Oculte el token valor antes de registrar, copiar o compartir la URL. Para clientes MCP, siga la configuración del transporte y cliente que utilice; los nombres de variables de entorno no necesariamente coinciden con los del SDK.

Autenticación CLI — Próximamente

La documentación de la CLI incluirá Autenticación y Configuración. Utilice esa guía cuando la CLI esté disponible para configurar credenciales en su flujo de trabajo de terminal. Mantenga las credenciales fuera de ejemplos compartidos, historial de shell y registros.

Verifique la clave

Utilice el endpoint documentado Obtener información del usuario para comprobar la autenticación sin enviar un trabajo de extracción de datos:

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'

Inspeccione localmente el estado y el cuerpo de la respuesta. La respuesta puede incluir información de la cuenta y saldo, por lo que no debe publicar el archivo ni incluirlo en su repositorio.

La autenticación exitosa confirma que esta solicitud puede usar la clave. El acceso al producto, el saldo y la validez de la solicitud aún deben verificarse al llamar a un endpoint del producto. Continúe con el Inicio rápido para realizar una solicitud con Web Unlocker.

Mantenga la clave fuera de superficies expuestas

• Realice llamadas autenticadas desde código confiable del lado servidor. No incruste la clave en JavaScript del frontend, paquetes de aplicaciones móviles o configuraciones públicas.
• Oculte los encabezados de autenticación, las URLs de conexión del navegador y las variables de entorno secretas de los registros de aplicaciones y eventos de monitoreo.
• Evite rastros HTTP detallados o rastreo de shell mientras utiliza credenciales reales. Las variables de entorno aún pueden exponerse a través de herramientas de depuración y la inspección de procesos.
• Elimine las claves de capturas de pantalla, grabaciones, cuadernos compartidos, tickets de soporte y solicitudes de chat de IA.
• Utilice el método de intercambio de secretos aprobado por su equipo cuando sea necesario compartir el acceso.

Reemplace una clave de forma segura

Para una sustitución planificada, obtenga una clave de reemplazo mediante los controles del panel de control disponibles para su cuenta o a través del soporte de Scrapeless. Actualice su almacén de secretos y todas las aplicaciones dependientes, reinicie los procesos que cargan secretos al inicio y verifique que el reemplazo funcione. Luego invalide la clave antigua y confirme que ya no sea aceptada.

Si la clave podría haberse filtrado, priorice invalidar inmediatamente la credencial expuesta, incluso si esto interrumpe aplicaciones en ejecución. Utilice los controles del panel de control disponibles o contacte al soporte para obtener ayuda, luego distribuya un reemplazo a través de su almacén de secretos.

Eliminar una clave de un archivo o borrar una publicación pública no la invalida. Revise el uso reciente y limpie copias expuestas, incluidos registros e historial del repositorio, después de contener la exposición.

Solucione problemas de autenticación

Si la autenticación falla, confirme que la aplicación haya cargado la variable correcta, que la clave no tenga espacios en blanco alrededor y que la credencial se esté enviando mediante el método requerido por ese endpoint. Reinicie procesos de larga duración después de cambiar su configuración de secretos.

Si la clave funciona en el endpoint de verificación pero falla una solicitud del producto, inspeccione la respuesta de error del producto y el acceso al panel de control. Comparta solo diagnósticos ocultados al solicitar soporte.

Siguiente: Realice su primera solicitud o elija un producto.