Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Початок роботи

TypeScript & JavaScript SDK

Встановіть SDK і запустіть пошук у Node.js. Виберіть TypeScript або JavaScript; зберігайте ключі API на сервері.

  1. Встановити SDK

    Ці приклади використовують Node.js 22.18+ для запуску TypeScript безпосередньо. Починайте в порожній папці або оберіть Existing проект, якщо у вас є package.json.

    Встановити
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Ауттентицид

    Створіть ключ з дозволом Google Search або повторно використовуйте уповноважений ключ. Встановіть FLASHDATA_API_KEY в цьому терміналі за допомогою прихованої підказки нижче; пропустіть це, якщо ваше оточення вже подає його.

    Приклад передає ключ прямо. Файл .env не завантажується цими скриптами. Зберігати ключ в конфігурації серверу при інтеграції в веб-додаток.

    Прихована ключова підказка · 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. Виконайте пошук

    Заощаджуйте вибраний файл і запустіть команду в цьому проекті. Кожна робота подає один пошук до п'яти результатів. Обидва файли працюють безпосередньо з Node.js; не потрібно будувати крок для цього прикладу.

    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);
    Запуск · Node.js 22.18+
    node quickstart.mts
  4. Перевірте результат

    Статус на сервери - URLs Ефективні органічні результати. Приклад виводу нижче ілюструє форму; джерела живих ресурсів буде різним.

    Приклад виходу
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search заголовки, посилання та фрагменти. Інші джерела мають свої власні навантаження.
    usage.credits
    Кредит, що стягується за цей запит; п'ять поданих записів є одним запитом про пошук.

Спробуйте ще одне джерело даних

Кожна вкладка працює як TypeScript, так і JavaScript. Замініть файл з step 3, зберігайте його .mts або .mjs розширення і запустіть однакову команду. Кожен курс є новим запитом і потребує дозволу на джерело.

Вимагає google_news. Читати записи статті в 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);

Тип-перегляд проекту TypeScript

Node працює цей приклад за типом демонтажу. Для перевірки типів без відправки запиту встановіть TypeScript і запустіть компілятор з --noEmit:

Перевірка опціонального типу
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

Що підтримує SDK

google / youtube
Пошук і отримання структурованих даних з ідентифікаторами джерела. Здійсніть свій клієнт у Вашій службі.
youtube.download
Поставити аудіо або відео на хмарне сховище за допомогою фонової роботи. Вимоги до конфігурацій youtube_download.
jobs / bulk
Заощаджуйте подані роботи IDs та отримайте завершені результати. чекає на вас у JavaScript; mode: 'async' подає серверну роботу.
account
Читання доступу, баланс, ціноутворення, ліміти та використання перед рецидивною роботою.
respondWith / accept
Пройдіть { respondWith: 'markdown' } як другий аргумент методу для Markdown в response.content, або { accept: 'text/plain' } для рядка. JSON об'єкти за замовчуванням.

Наступний крок

Якщо крок не зникає

Пакети або дата відсутні
Перевірити вузол --version і встановити @flashdata-dev/sdk в цьому проекті. Зберігайте розширення .mts або .mjs, показано вище.
401 / FLASHDATA_API_KEY
Встановіть ключ в терміналі, де ви запустіть приклад.
403
Увімкнути Google Search для цього ключа API.
402
Перевірте Billing для доступних кредитів, або вимагати вичерпне випробування агента.
429
Зачекайте Retry-After, потім знижуйте курс запиту.
Терміни або помилка сервера
Перевірити History перед перезапуском; перший запит вже може запуститися.