Saltar al contenido
ES
Obtener clave API
Explorar documentación

Primeros pasos

SDK para TypeScript y JavaScript

Instala el SDK y haz una búsqueda en Node.js con TypeScript o JavaScript. Mantén la clave API en tu servidor.

  1. Instala el SDK

    Usa Node.js 22.18+ para ejecutar estos archivos directamente. Abre una terminal en una carpeta vacía y elige Nuevo proyecto. Si ya tienes un package.json, ejecuta la opción Proyecto existente desde ese directorio.

    Instalar
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Configura la autenticación

    Crea una clave API con permiso para Google Search o reutiliza una clave autorizada. Ejecuta el bloque y pega la clave cuando se solicite; no se mostrará en pantalla. Omite este paso si FLASHDATA_API_KEY ya está definida en tu entorno.

    Los scripts leen FLASHDATA_API_KEY y la pasan al cliente; no cargan archivos .env. Usa la misma terminal para el paso 3. En una aplicación web, ejecuta este código en el servidor para mantener la clave fuera del navegador.

    Clave API · Bash
    # Bash: paste the key into a hidden prompt, not into this command.
    read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
    printf '\n'
    export FLASHDATA_API_KEY
  3. Haz una búsqueda

    Elige TypeScript o JavaScript y guarda el código como quickstart.mts o quickstart.mjs, respectivamente, junto a package.json. Después ejecuta el comando que aparece debajo del script. Cada ejecución envía una búsqueda de hasta cinco resultados. Con Node.js 22.18+ no necesitas compilar estos ejemplos antes de ejecutarlos.

    quickstart.mts
    import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';
    
    const apiKey = process.env.FLASHDATA_API_KEY;
    if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
    const client = new FlashData({ apiKey });
    const params: GoogleSearchParams = { num: 5 };
    const response = await client.google.search({ query: 'battery recycling research', ...params });
    if (response.status !== 'done') throw new Error(JSON.stringify(response));
    
    for (const page of response.results) {
      for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
    }
    console.log('Credits used:', response.usage.credits);
    Ejecutar
    node quickstart.mts
  4. Comprueba el resultado

    El script comprueba que status sea done y termina sin errores. Verás los títulos y las URLs, seguidos de Credits used. Una lista organic vacía también es válida. La salida siguiente es ilustrativa; tu respuesta contiene los resultados y el consumo reales.

    Ejemplo de respuesta
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Resultados de Google Search con campos como title, link y snippet. Cada fuente tiene su propia estructura de datos tipada.
    usage.credits
    Créditos consumidos por esta solicitud. Una búsqueda que devuelve cinco resultados se cuenta como una sola solicitud.

Prueba otra fuente de datos

Cada pestaña contiene un script completo que funciona en TypeScript y JavaScript. Sustituye el contenido del archivo del paso 3, conserva su extensión .mts o .mjs y usa el mismo comando para ejecutarlo. Cada ejecución envía una nueva solicitud; la clave debe tener el permiso indicado.

Requiere el permiso google_news. La respuesta contiene las noticias en results[].news[].

quickstart.mts / quickstart.mjs
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.google.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);

Comprueba los tipos en TypeScript

Node.js elimina las anotaciones de tipos para ejecutar quickstart.mts, pero no comprueba los tipos. Para comprobarlos sin ejecutar el script ni enviar una solicitud, instala TypeScript y ejecuta el compilador con --noEmit desde el directorio del proyecto:

Comprobar tipos
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

Funciones del SDK

google / youtube
Busca y recupera datos estructurados con métodos tipados para cada fuente. Reutiliza un cliente en tu servicio.
youtube.download
Envía un trabajo para entregar audio o vídeo en tu almacenamiento en la nube. Requiere el permiso youtube_download y la configuración del almacenamiento.
jobs / bulk
Guarda el ID del trabajo aceptado y recupera sus resultados cuando termine. await espera una promesa en JavaScript; mode: 'async' envía un trabajo en segundo plano al servidor.
account
Consulta el acceso, el saldo, los precios, los límites y el uso antes de ejecutar tareas recurrentes.
respondWith / accept
Pasa { respondWith: 'markdown' } como segundo argumento del método para obtener Markdown en response.content, o { accept: 'text/plain' } para obtener una cadena de texto. Por defecto, la respuesta JSON se devuelve como un objeto.

Siguientes pasos

Si un paso falla

Falta el paquete o la herramienta para ejecutarlo
Comprueba node --version y usa Node.js 22.18+ para estos ejemplos. Instala @flashdata-dev/sdk en el directorio que contiene package.json y conserva la extensión .mts o .mjs del archivo.
401 / FLASHDATA_API_KEY
Define una clave válida en la terminal donde ejecutas el ejemplo.
403
Pide al titular que conceda el permiso de Google Search a esta clave API.
402
Consulta los créditos disponibles en Billing. Si la prueba del agente se ha agotado, vincúlala a una cuenta para obtener acceso del titular.
429
Espera el tiempo indicado por Retry-After y reduce la frecuencia de tus solicitudes.
Tiempo de espera agotado o error del servidor
Revisa History antes de volver a enviar la solicitud; la primera puede haberse ejecutado ya.