Przejdź do treści
PL
Uzyskaj klucz API
Przeglądaj dokumentację

Pierwsze kroki

TypeScript & JavaScript SDK

Zainstaluj SDK i przeszukaj Node.js. Wybierz TypeScript lub JavaScript; trzymaj klucze API na serwerze.

  1. Zainstaluj SDK

    Przykłady te wykorzystują Node.js 22.18 + do bezpośredniego uruchamiania TypeScript. Zacznij w pustym folderze lub wybierz istniejący projekt, jeśli masz package.json.

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

    Utwórz klucz za zgodą Google Search lub ponownie użyj autoryzowanego klucza. Ustaw FLASHDATA_API_KEY w tym terminalu za pomocą ukrytego sygnału poniżej; pomiń to, jeśli środowisko już go dostarcza.

    Przykład ten wyraźnie podaje klucz. Plik .env nie jest wczytywany przez te skrypty. Keep the key in server- side configuration podczas integracji z aplikacją internetową.

    Ukryty sygnał klawiszowy · 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. Wykonaj wyszukiwanie

    Zapisz zaznaczony plik i uruchom jego polecenie w tym projekcie. Każda runda przedstawia jedno wyszukiwanie do pięciu wyników. Oba pliki są uruchamiane bezpośrednio za pomocą Node.js; nie jest potrzebny żaden krok budowy.

    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);
    Uruchom · Node.js 22.18 +
    node quickstart.mts
  4. Sprawdź wynik

    Status sprawdzania skryptu jest gotowy i drukuje tytuły źródłowe, URLs i kredyty używane. Pusty wynik organiczny jest ważny. Poniższy przykład przedstawia kształt; źródła na żywo będą się różnić.

    Przykład wyjścia
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Tytuł Google Search, linki i wyszczerbienia. Inne źródła mają własne ładunki na maszynie.
    usage.credits
    Kredyty naliczane za to żądanie; pięć zwróconych trafień to jedno żądanie wyszukiwania.

Spróbuj innego źródła danych

Każda karta działa zarówno w TypeScript, jak i JavaScript. Zamień plik z kroku 3, zachowaj jego rozszerzenie .mts lub .mjs i uruchom to samo polecenie. Każda operacja jest nowym wnioskiem i potrzebuje pokazanego pozwolenia źródłowego.

Wymaga google_news. Przeczytaj wpisy artykułu w 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);

Sprawdź typ projektu TypeScript

Węzeł uruchamia ten przykład poprzez rozbieranie typów. Aby sprawdzić typy bez wysyłania wniosku, zainstalować TypeScript i uruchomić kompilator z --noEmit:

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

Co obsługuje SDK

google / youtube
Wyszukiwarka i pobieranie uporządkowanych danych za pomocą wpisywanych pomocników źródłowych. Wykorzystaj jednego klienta do swoich usług.
youtube.download
Dostarcz audio lub wideo do pamięci masowej w chmurze poprzez zadanie w tle. Wymaga zezwolenia youtube_download i konfiguracji zapisu.
jobs / bulk
Zapisz złożone zadanie IDs i pobrać zakończone wyniki. Oczekuj oczekujących w JavaScript; mode: 'async' przedstawia zadanie serwera w tle.
account
Odczyt dostępu, równowagi, cen, ograniczeń i wykorzystania przed powtarzającą się pracą.
respondWith / accept
Podaj { respondWith: 'markdown' } jako drugi argument metody dla Markdown w response.content lub { accept: 'text/plain' } dla łańcucha. Obiekty JSON są domyślne.

Kolejne kroki

Jeśli krok zawiedzie

Brak opakowania lub czasu startowego
Sprawdź węzeł --version i zainstaluj @ flashdata-dev/sdk w tym projekcie. Należy zachować powyższe rozszerzenie .mts lub .mjs.
401 / FLASHDATA_API_KEY
Ustaw poprawny klucz w terminalu, w którym uruchomisz przykład.
403
Włącz Google Search dla tego klawisza API.
402
Sprawdź Billing dostępne kredyty, lub zażądać wyczerpanego procesu agenta.
429
Poczekaj na Retry-After, a następnie zmniejsz stawkę zapotrzebowania.
Błąd timeout lub serwera
Zaznacz History przed zwrotem; pierwsze żądanie może być już uruchomione.