# TypeScript & JavaScript SDK

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

Канонічне посилання: https://flashdata.dev/uk/docs/guides/flashdata-typescript
Переглянуто: 2026-11-04 від FlashData

- [GitHub](https://github.com/flashdatadev/flashdata-typescript) — Джерело та посилання SDK
- [Отримайте API-ключ](https://flashdata.dev/app/api-keys) — Створення ключа в консолі

<a id="application"></a>

## Зробіть свій перший запит Node.js

Встановіть пакет, встановіть ключ API і виберіть TypeScript або JavaScript нижче. Запустіть цей код на сервері або в локальному скрипті.

- [SDK метод посилання](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)
- [npm](https://www.npmjs.com/package/@flashdata-dev/sdk/v/1.1.0)

<a id="install"></a>

### Встановити SDK

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

#### Новий проект

##### Встановити

```bash
npm init -y
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


#### Розробка проекту

##### Встановити

```bash
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


- [Встановити Node.js](https://nodejs.org/en/download)

<a id="key"></a>

### Ауттентицид

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

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

#### Bash

##### Прихована ключова підказка · Bash

```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
```


#### PowerShell 7

##### Прихована ключова підказка · PowerShell

```powershell
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey
```


- [Реєстрація](https://flashdata.dev/signup)
- [Відкрити API Keys](https://flashdata.dev/app/api-keys)
- [Відкрити Billing](https://flashdata.dev/app/billing)
- [Налаштування тестових випробувань агента](https://flashdata.dev/uk/docs/guides/agent-onboarding/reference.md)

<a id="query"></a>

### Виконайте пошук

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

#### TypeScript

##### quickstart.mts

```typescript
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+

```bash
node quickstart.mts
```


#### JavaScript

##### quickstart.mjs

```javascript
import { FlashData } 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 response = await client.google.search({ query: 'battery recycling research', num: 5 });
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);
```

##### Запустити

```bash
node quickstart.mjs
```



<a id="result"></a>

### Перевірте результат

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

| Поле | Зареєструватися |
| --- | --- |
| results[].organic[] | Google Search заголовки, посилання та фрагменти. Інші джерела мають свої власні навантаження. |
| usage.credits | Кредит, що стягується за цей запит; п'ять поданих записів є одним запитом про пошук. |

#### Приклад виходу

```text
Battery recycling research https://example.org/recycling
Credits used: 0.02
```


<a id="common-tasks"></a>

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

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

### Google Новини

Вимагає google_news. Читати записи статті в results[].news[].

#### quickstart.mts / quickstart.mjs

```typescript
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);
```


### YouTube метаданих

Вимагає youtube_metadata. Повертає назви, канали, тривалість та інші деталі відео.

#### quickstart.mts / quickstart.mjs

```typescript
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.youtube.metadata({
  video_id: 'dQw4w9WgXcQ', include_formats: false,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


### YouTube трафарет

Вимагає youtube_transcript. Запитує існуючу англійську автоматичну трасу. Текст в results[].fullText при наявності треку.

#### quickstart.mts / quickstart.mjs

```typescript
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.youtube.transcript({
  video_id: 'dQw4w9WgXcQ', language: 'en', auto: true,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


- [Всі параметри джерела](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/sources/index.md)

<a id="typecheck"></a>

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

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

### Перевірка опціонального типу

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

- [Node.js TypeScript підтримка](https://nodejs.org/api/typescript.html)

<a id="features"></a>

## Що підтримує 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 об'єкти за замовчуванням. |

- [Завантажити приклад](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/examples/youtube_download.mjs)
- [Налаштування сховища](https://flashdata.dev/uk/docs/guides/youtube-download-guide/reference.md)
- [Формати відповідей](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/response-formats.md)

<a id="next"></a>

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

- [Заощаджуйте результати та помилки у роботі](https://flashdata.dev/uk/docs/guides/sdk-operations/reference.md)
- [Робота та партія](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/jobs.md)
- [Конфігурація клієнтів](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/client.md)
- [SDK метод посилання](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)

<a id="errors"></a>

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

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

- [Історія запиту](https://flashdata.dev/app/jobs)
- [Billing](https://flashdata.dev/app/billing)
- [SDK помилки і відновлення](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/errors.md)
