Langkau ke kandungan
MS
Dapatkan kunci API
Semak dokumentasi

Mula di sini

TypeScript & JavaScript SDK

Anstal SDK dan jalankan pencarian di Node.js. Pilih TypeScript atau JavaScript; tetap kunci API pada server.

  1. Pasang SDK

    Contoh-contoh ini menggunakan Node.js 22.18+ untuk menjalankan TypeScript secara langsung. Mulai pada folder kosong, atau pilih Projek Exexist jika Anda memiliki package.json.

    Pasang
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Autentifikasi

    Aaux membuat kunci dengan izin Google Search atau menggunakan kembali kunci yang berwenang. Andikario Set FLASHDATA_API_KEY di terminal ini menggunakan prompt tersembunyi di bawah; lewati ini jika lingkungan Anda sudah memasoknya.

    Contoh ini melewati kunci secara eksplisit. Sebuah berkas .env tidak dimuat oleh skrip ini. ¡Keep the key dalam konfigurasi sisi-server ketika mengintegrasikan ke dalam aplikasi web.

    Prompt kunci tersembunyi · 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. Jalankan carian

    Simpan berkas yang dipilih dan jalankan perintahnya dalam projek ini. Setiap larian menyerahkan satu pencarian hingga lima hasil. Kedua berkas tersebut dijalankan secara langsung dengan Node.js; tidak ada langkah build yang diperlukan untuk contoh ini.

    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);
    Jalankan · Node.js 22.18+
    node quickstart.mts
  4. Semak hasil

    Status pemeriksaan skrip dilakukan dan mencetak judul sumber, URLs dan kredit yang digunakan. Hasil organik yang kosong adalah valid. Contoh gambar di bawah ini menggambarkan bentuk; sumber hidup akan bervariasi.

    Contoh output
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search Gelar, link dan snippet. Sumber-sumber lain memiliki muatan yang diketik sendiri.
    usage.credits
    Kredit yang dikenakan untuk permintaan ini; lima hit yang dikembalikan adalah satu permintaan pencarian.

Coba sumber data lain

Setiap tab bekerja di kedua TypeScript dan JavaScript. Menggantikan berkas dari langkah 3, menjaga sambungan .mts atau .mjs dan jalankan perintah yang sama. Setiap run adalah permintaan baru dan perlu izin sumber yang ditunjukkan.

Perlu google_news. Baca entri artikel di 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);

Type-check sebuah proyek TypeScript

Wadi Node menjalankan contoh ini dengan mengelupas jenis. Untuk memeriksa tipe tanpa mengirim permintaan, pasang TypeScript dan jalankan kompiler dengan --noEmit:

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

Apa yang didukung SDK

google / youtube
Cari dan ambil data terstruktur dengan bantuan sumber yang diketik. Kau bisa gunakan satu klien untuk melayanimu.
youtube.download
Kirimkan audio atau video ke penyimpanan awan Anda melalui pekerjaan latar belakang. Kemudia memerlukan izin youtube_download dan konfigurasi penyimpanan.
jobs / bulk
Simpan pekerjaan yang diserahkan IDs dan dapatkan kembali hasil yang selesai. tunggu menunggu di JavaScript; mode: 'async' menyerahkan pekerjaan latar belakang sisi server.
account
KISAH, keseimbangan, harga, batas, dan penggunaan yang mudah dibaca sebelum pekerjaan yang berulang.
respondWith / accept
{ respondWith: 'markdown' } sebagai argumen kedua metode untuk Markdown dalam response.content, atau { accept: 'text/plain' } untuk sebuah string. Objek JSON adalah default.

Langkah - langkah selanjutnya

Jika langkah gagal

Paket atau runtime hilang
Periksa node --version dan pasang @flashdata-dev/sdk dalam proyek ini. Jaga sambungan .mts atau .mjs di atas.
401 / FLASHDATA_API_KEY
Tetapkan kunci valid di terminal di mana Anda menjalankan contoh.
403
Hidupkan Google Search untuk kunci API ini.
402
Cek Billing untuk kredit yang tersedia, atau klaim pengadilan agen yang kelelahan.
429
Wait untuk Retry-After, kemudian mengurangi permintaan Anda.
Kehabisan atau server error
Periksa History sebelum resending; permintaan pertama mungkin sudah berjalan.