Pular para o conteúdo
PT
Obter chave API
Explorar documentação

Primeiros passos

TypeScript & JavaScript SDK

Instale o SDK e execute uma busca no Node.js. Escolha TypeScript ou JavaScript; mantenha API no servidor.

  1. Instale o SDK

    Estes exemplos usam Node.js 22.18+ para executar TypeScript diretamente. Comece em uma pasta vazia, ou selecione o projeto existente se você tiver package.json.

    Instalar
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Autenticação

    Crie uma chave com permissão Google Search ou reutilize uma chave autorizada. Coloque FLASHDATA_API_KEY neste terminal usando o alerta escondido abaixo, pule isso se seu ambiente já o fornecer.

    O exemplo passa a chave explicitamente. Um arquivo Env não é carregado por esses scripts. Mantenha a chave na configuração do servidor ao integrar-se em uma aplicação web.

    Chave escondida pronta. 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. Faça uma pesquisa

    Salve o arquivo selecionado e execute seu comando neste projeto. Cada corrida envia uma busca por até cinco resultados. Ambos os arquivos são executados diretamente com Node.js; nenhum passo de construção é necessário para este exemplo.

    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);
    Corra! Node.js 22.18!
    node quickstart.mts
  4. Confira o resultado

    O script verifica o status e imprime títulos de origem, URLs e créditos usados. Os resultados orgânicos vazios são válidos. O exemplo abaixo ilustra a forma, fontes vivas variam.

    Exemplo de saída
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Títulos Google Search, links e trechos. Outras fontes têm suas próprias cargas.
    usage.credits
    Créditos cobrados por este pedido, cinco retornos são um pedido de busca.

Tente outra fonte de dados

Cada guia funciona em TypeScript e JavaScript. Substitua o arquivo do passo 3, mantenha sua extensão MTS ou MJs e execute o mesmo comando. Cada corrida é um novo pedido e precisa da permissão da fonte mostrada.

Requer google_news. Leia entradas de artigos em 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);

Verifique um projeto TypeScript

Node corre este exemplo despindo tipos. Para verificar os tipos sem enviar uma solicitação, instale TypeScript e execute o compilador com --noEmit:

Verificação opcional do tipo
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

O que o SDK suporta

google / youtube
Procure e recupere dados estruturados com ajudantes de origem digitados. Reutilize um cliente ao seu serviço.
youtube.download
Entregue áudio ou vídeo ao seu armazenamento na nuvem através de um trabalho de fundo. Requer permissão youtube_download e configuração de armazenamento.
jobs / bulk
Salve o trabalho submetido IDs e recupere resultados completos. aguarde esperas no JavaScript; mode: 'async' envia uma tarefa de background do lado do servidor.
account
Leia acesso, equilíbrio, preços, limites e uso antes do trabalho recorrente.
respondWith / accept
Passe { respondWith: 'markdown' } como segundo argumento do método para Markdown em response.content, ou { accept: 'text/plain' } para uma cadeia. Os objetos JSON são o padrão.

Próximos passos

Se um passo falhar

Pacote ou tempo de execução faltando
Verifique o nó --version e instale @flashdata-dev/sdk neste projeto. Mantenha a extensão MTs ou MJs mostrada acima.
401 / FLASHDATA_API_KEY
Coloque uma chave válida no terminal onde você executa o exemplo.
403
Active a busca Google por esta chave API.
402
verificação Billing para os créditos disponíveis, ou reivindique um teste de agente exausto.
429
Espere pelo Retry-After, então reduza a taxa de solicitação.
Tempo limite ou erro do servidor
Verifique History antes de reenviar, o primeiro pedido pode já ter sido executado.